SpringBoot序列化、反序列化空字符串为null的三种方式

一、需求：接收前端传入的""空字符串参数，有时候我们必要把它转为null

• SpringBoot项目
  
• 方式：①Jackson（推荐）、②切面+反射、③注解+切面+反射
  
• 后两种方式，未做返回值的处理。
  

二、三种方式

1、Jackson正反序列化（推荐）

• StdConverter 和 JsonSerializer的区别
  

1. 两种方式都可以实现将空字符串修改为 null 值的逻辑，但它们之间有一些区别：
3. 1. **继承的类不同**：
4.    - 使用 `StdConverter` 方式时，`StringToNullSerializer` 类继承自 `StdConverter<String, String>`，并实现了 `convert` 方法。
5.    - 使用 `JsonSerializer` 方式时，`StringToNullSerializer` 类直接继承自 `JsonSerializer<String>`，并实现了 `serialize` 方法。
7. 2. **接口和方法不同**：
8.    - `StdConverter` 是 Jackson 库中提供的用于定义转换器的类，其中的 `convert` 方法用于将一个类型转换为另一个类型。
9.    - `JsonSerializer` 是 Jackson 库中用于定制序列化逻辑的接口，其中的 `serialize` 方法用于将 Java 对象序列化为 JSON 数据。
11. 3. **对于序列化过程的处理不同**：
12.    - 在 `StdConverter` 方式中，你需要实现 `convert` 方法来定义如何将空字符串转换为 null 值。
13.    - 在 `JsonSerializer` 方式中，你需要实现 `serialize` 方法来定义如何将字段序列化为 JSON 数据，并在其中进行空字符串转换为 null 值的处理。
15. 综上所述，两种方式都可以实现相同的功能，选择哪一种方式取决于个人偏好以及代码的整体结构和风格。通常来说，如果只需要定制序列化逻辑而不需要转换其他类型，直接实现 `JsonSerializer` 接口可能会更清晰和简洁。

复制代码

• ENTITY
  

1. package com.cc.jxtd.entity;
3. import com.cc.jxtd.serializer.ConverterEmptyStringToNull;
4. import com.cc.jxtd.serializer.EmptyStringToNullDeserializer;
5. import com.cc.jxtd.serializer.ConverterEmptyStringToInteger0;
6. import com.cc.jxtd.serializer.EmptyStringToNullSerializer;
7. import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
8. import com.fasterxml.jackson.databind.annotation.JsonSerialize;
9. import lombok.Data;
11. import javax.naming.Name;
13. /**
14. * <p>请求，返回都用这个</p>
15. *
16. * @author --
17. * @since 2024/4/19
18. */
19. @Data
20. public class UserCs {
22.     private Long id;
24.     //反序列化（前端请求）：空字符串为null
25.     @JsonDeserialize(using = EmptyStringToNullDeserializer.class)
26.     private String name;
28.     //反序列化（前端请求）：转换：为其他类型的值（转换为int的0）
29.     @JsonDeserialize(converter = ConverterEmptyStringToInteger0.class)
30.     private Integer descConverter0;
32.     //序列化（后端返回）：空字符串为null
33.     @JsonSerialize(using = EmptyStringToNullSerializer.class)
34.     private String descSerialize;
36.     //序列化（后端返回）：转换：空字符串转为null
37.     @JsonSerialize(converter = ConverterEmptyStringToNull.class)
38.     private String descConverterNull;
39.    
40. }

复制代码

• 序列化处理类
  

1. package com.cc.jxtd.serializer;
3. import com.fasterxml.jackson.core.JsonGenerator;
4. import com.fasterxml.jackson.databind.JsonSerializer;
5. import com.fasterxml.jackson.databind.SerializerProvider;
7. import java.io.IOException;
9. /** 序列化：String的空转为null
10. * @author --
11. * @since 2024/4/18
12. **/
13. public class EmptyStringToNullSerializer extends JsonSerializer<String> {
15.     /**
16.      * 序列化为null
17.      */
18.     @Override
19.     public void serialize(String value, JsonGenerator gen, SerializerProvider serializerProvider) throws IOException {
20.         if (value == null || value.trim().isEmpty()) {
21.             gen.writeNull();
22.         }else {
23.             gen.writeString(value);
24.         }
25.     }
26. }

复制代码

• 反序列化处理类
  

1. package com.cc.jxtd.serializer;
3. import com.fasterxml.jackson.core.JsonParser;
4. import com.fasterxml.jackson.databind.DeserializationContext;
5. import com.fasterxml.jackson.databind.JsonDeserializer;
7. import java.io.IOException;
9. /** 反序列化：空字符串转换为null
10. * @author --
11. * @since 2024/4/18
12. **/
13. public class EmptyStringToNullDeserializer extends JsonDeserializer<String> {
15.     /**
16.      * 反序列化为null
17.      */
18.     @Override
19.     public String deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
20.         String value = p.getValueAsString();
21.         if (value == null || value.trim().isEmpty()) {
22.             return null;
23.         }
24.         return value;
25.     }
27. }

复制代码

• 序列化-转换1
  

1. package com.cc.jxtd.serializer;
3. import com.fasterxml.jackson.databind.util.StdConverter;
5. /** 序列化-转换：将string的空转为null
6. * @author --
7. * @since 2024/4/18
8. **/
9. public class ConverterEmptyStringToNull extends StdConverter<String, String> {
11.     @Override
12.     public String convert(String value) {
13.         //把空的string转为int的0
14.         if (value == null || value.trim().isEmpty()) {
15.             return null;
16.         }
17.         return value;
18.     }
20. }

复制代码

• 序列化-转换2
  

1. package com.cc.jxtd.serializer;
3. import com.fasterxml.jackson.annotation.JsonPropertyOrder;
4. import com.fasterxml.jackson.databind.util.StdConverter;
6. /** 序列化：1将string转为int。
7. *         2转换String的空或null -》 转为Integer的0
8. * @author --
9. * @since 2024/4/18
10. **/
11. public class ConverterEmptyStringToInteger0 extends StdConverter<String, Integer> {
13.     @Override
14.     public Integer convert(String value) {
15.         //把空的string转为int的0
16.         if (value == null || value.trim().isEmpty()) {
17.             return 0;
18.         }
19.         return Integer.valueOf(value);
20.     }
22. }

复制代码

• Controller
  

1. package com.cc.jxtd.web.controller;
3. import com.cc.jxtd.entity.UserCs;
4. import org.springframework.web.bind.annotation.PostMapping;
5. import org.springframework.web.bind.annotation.RequestBody;
6. import org.springframework.web.bind.annotation.RequestMapping;
7. import org.springframework.web.bind.annotation.RestController;
9. /**
10. * <p></p>
11. *
12. * @author --
13. * @since 2024/4/19
14. */
15. @RestController
16. @RequestMapping("/userCs")
17. public class UserController {
19.     @PostMapping
20.     public UserCs get(@RequestBody UserCs req){
21.         System.out.println("请求参数-id："   + req.getId());
22.         System.out.println("请求参数-name：" + req.getName());
23.         System.out.println("请求参数-desc1：" + req.getDescSerialize());
24.         System.out.println("请求参数-desc2：" + req.getDescConverterNull());
25.         System.out.println("请求参数-desc3：" + req.getDescConverter0());
27.         //返回：序列化
28.         return req;
29.     }
30. }

复制代码

• 测试
  
  
  
  

2、切面+反射/3、注解+切面+反射

• 区别
  

1. 2、切面+反射：所有空字符串的字段都转为null
2. 3、注解+切面+反射：只有打了@EmptyToNull的字段才会转换

复制代码

• 导入包
  

1.                
2.         <dependency>
3.             <groupId>org.springframework.boot</groupId>
4.             <artifactId>spring-boot-starter-aop</artifactId>
5.         </dependency>

复制代码

• 切面
  

1. package com.cc.jxtd.aspect;
3. import com.cc.jxtd.annotation.EmptyToNull;
4. import org.aspectj.lang.ProceedingJoinPoint;
5. import org.aspectj.lang.annotation.Around;
6. import org.aspectj.lang.annotation.Aspect;
7. import org.aspectj.lang.annotation.Pointcut;
8. import org.slf4j.Logger;
9. import org.slf4j.LoggerFactory;
10. import org.springframework.stereotype.Component;
12. import java.lang.reflect.Field;
13. import java.util.Objects;
15. /** 切面
16. * @author --
17. */
18. @Aspect
19. @Component
20. public class UpdateAspect {
22.     private static final Logger logger = LoggerFactory.getLogger(UpdateAspect.class);
24.     //切入点
25.     @Pointcut("@annotation(com.cc.jxtd.annotation.OptConverter)")
26.     public void validPointCut() {
27.     }
29.     /**
30.      * 环绕修改参数
31.      */
32.     @Around("validPointCut()")
33.     public Object around(ProceedingJoinPoint point) throws Throwable {
34.         Object[] args = point.getArgs();
35.         Object arg = args[0];
36.         //2、切面+反射：全部转换
37.         this.allEmptyToNull(arg);
38.         //3、注解+切面+反射：部分转换
39. //        this.assignEmptyToNull(arg);
41.         return point.proceed();
42.     }
44.     /**
45.      * 设置请求参数中 所有字段的空值（如：String的空字符串）为null
46.      * @param arg arg
47.      */
48.     public void allEmptyToNull(Object arg) {
49.         if (Objects.isNull(arg)) {
50.             return;
51.         }
52.         Field[] fields = arg.getClass().getDeclaredFields();
53.         for (Field field : fields) {
54.             // 设置字段可访问
55.             field.setAccessible(true);
56.             // 如果字段是 String 类型且值为空字符串，则设置为 null
57.             if (field.getType() == String.class) {
58.                 try {
59.                     String value = (String) field.get(arg);
60.                     if (value != null && value.isEmpty()) {
61.                         field.set(arg, null);
62.                     }
63.                 } catch (IllegalAccessException e) {
64.                     e.printStackTrace();
65.                 }
66.             }
67.             // 可以扩展其他类型的参数……
69.         }
70.     }
72.     /** 指定空转null
73.      * @param arg arg
74.      * @since 2024/4/18
75.      **/
76.     private void assignEmptyToNull(Object arg) {
77.         if (Objects.isNull(arg)) {
78.             return;
79.         }
80.         Field[] fields = arg.getClass().getDeclaredFields();
81.         for (Field field : fields) {
82.             if (field.isAnnotationPresent(EmptyToNull.class)) {
83.                 // 设置字段可访问
84.                 field.setAccessible(true);
85.                 // 如果字段是 String 类型且值为空字符串，则设置为 null
86.                 if (field.getType() == String.class) {
87.                     try {
88.                         String value = (String) field.get(arg);
89.                         if (value != null && value.isEmpty()) {
90.                             field.set(arg, null);
91.                         }
92.                     } catch (IllegalAccessException e) {
93.                         e.printStackTrace();
94.                     }
95.                 }
96.                 // 可以扩展其他类型的参数……
98.             }
100.         }
101.     }
102. }

复制代码

• 注解
  

1. package com.cc.jxtd.annotation;
3. import java.lang.annotation.ElementType;
4. import java.lang.annotation.Retention;
5. import java.lang.annotation.RetentionPolicy;
6. import java.lang.annotation.Target;
8. /**
9. * 转换
10. * @author --
11. */
12. @Target(ElementType.METHOD)
13. @Retention(RetentionPolicy.RUNTIME)
14. public @interface OptConverter {
15.    
16. }

复制代码

• 注解2
  

1. package com.cc.jxtd.annotation;
3. import java.lang.annotation.ElementType;
4. import java.lang.annotation.Retention;
5. import java.lang.annotation.RetentionPolicy;
6. import java.lang.annotation.Target;
8. /** 转化空为null
9. * @author --
10. * @since 2024/4/18
11. **/
12. @Target(ElementType.FIELD)
13. @Retention(RetentionPolicy.RUNTIME)
14. public @interface EmptyToNull {
16. }

复制代码

• entity
  

1. package com.cc.jxtd.entity;
3. import com.cc.jxtd.serializer.ConverterEmptyStringToInteger0;
4. import com.cc.jxtd.serializer.ConverterEmptyStringToNull;
5. import com.cc.jxtd.serializer.EmptyStringToNullDeserializer;
6. import com.cc.jxtd.serializer.EmptyStringToNullSerializer;
7. import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
8. import com.fasterxml.jackson.databind.annotation.JsonSerialize;
9. import lombok.Data;
11. /**
12. * <p>请求，返回都用这个</p>
13. *
14. * @author --
15. * @since 2024/4/19
16. */
17. @Data
18. public class UserCs2 {
20.     private Long id;
22.     private String name;
24.     private String desc;
26. }

复制代码

• controller
  

1. package com.cc.jxtd.web.controller;
3. import com.cc.jxtd.annotation.OptConverter;
4. import com.cc.jxtd.entity.UserCs;
5. import com.cc.jxtd.entity.UserCs2;
6. import org.springframework.web.bind.annotation.PostMapping;
7. import org.springframework.web.bind.annotation.RequestBody;
8. import org.springframework.web.bind.annotation.RequestMapping;
9. import org.springframework.web.bind.annotation.RestController;
11. /**
12. * <p></p>
13. *
14. * @author --
15. * @since 2024/4/19
16. */
17. @RestController
18. @RequestMapping("/userCs")
19. public class UserController {
21. //    @PostMapping
22. //    public UserCs get(@RequestBody UserCs req){
23. //        System.out.println("请求参数-id："   + req.getId());
24. //        System.out.println("请求参数-name：" + req.getName());
25. //        System.out.println("请求参数-DescSerialize：" + req.getDescSerialize());
26. //        System.out.println("请求参数-DescConverterNull：" + req.getDescConverterNull());
27. //        System.out.println("请求参数-DescConverter0：" + req.getDescConverter0());
28. //
29. //        //返回：序列化
30. //        return req;
31. //    }
33.     @OptConverter
34.     @PostMapping
35.     public UserCs2 get(@RequestBody UserCs2 req){
36.         System.out.println("请求参数-id："   + req.getId());
37.         System.out.println("请求参数-name：" + req.getName());
38.         System.out.println("请求参数-desc：" + req.getDesc());
40.         //返回：序列化
41.         return req;
42.     }
44. }

复制代码

• 测试2
  
  
  
  
• 测试3
  
  
  
  
  
  
  
  
  
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。