spring boot 去掉JSON返回报文中的值为NULL的字段

灰太狼 2021-02-15 14:32 1088阅读 0赞

在开发过程中，需要统一返回前端json格式的数据，但有些返回值存在 null或者""这种没有意义的字段。通过修改springboot内置的Jackson达到不返回空字段，或者把NULL转成“”的JSON效果。

/**
 * MvcConfigurer
 * 基础配置
 *
 */
 @Configuration
 @EnableWebMvc
 public class MvcConfigurer implements WebMvcConfigurer {
 
 
 @Override
 public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
 converters.add(mappingJackson2HttpMessageConverter());
 }
 
 @Bean
 public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(){
 // 通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化
 // Include.Include.ALWAYS 默认
 // Include.NON_DEFAULT 属性为默认值不序列化
 // Include.NON_EMPTY 属性为 空（""） 或者为 NULL 都不序列化，则返回的json是没有这个字段的。
 // Include.NON_NULL 属性为NULL 不序列化,就是为null的字段不参加序列化
 MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
 ObjectMapper objectMapper = new ObjectMapper();
 objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
 @Override
 public void serialize(Object o, JsonGenerator jsonGenerator,
 SerializerProvider serializerProvider)
 throws IOException {
 jsonGenerator.writeString("");
 }
 });
 converter.setObjectMapper(objectMapper);
 converter.setDefaultCharset(Charset.forName("UTF-8"));
 return converter;
 }
 
 
 }

或者

/**
 * MvcConfigurer
 * 基础配置
 *
 */
 @Configuration
 @EnableWebMvc
 public class MvcConfigurer implements WebMvcConfigurer {
 
 
 @Override
 public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
 converters.add(mappingJackson2HttpMessageConverter());
 }
 
 @Bean
 public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(){
 // 通过该方法对mapper对象进行设置，所有序列化的对象都将按改规则进行系列化
 // Include.Include.ALWAYS 默认
 // Include.NON_DEFAULT 属性为默认值不序列化
 // Include.NON_EMPTY 属性为 空（""） 或者为 NULL 都不序列化，则返回的json是没有这个字段的。
 // Include.NON_NULL 属性为NULL 不序列化,就是为null的字段不参加序列化
 MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
 converter.setObjectMapper(new ObjectMapper().setSerializationInclusion(JsonInclude.Include.NON_NULL));
 converter.setDefaultCharset(Charset.forName("UTF-8"));
 return converter;
 }
 
 
 }