jackson設置返回null為空字符串的操作

更新時間：2020年09月28日 08:44:46 作者：xqnode

這篇文章主要介紹了jackson設置返回null為空字符串的操作，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

1、將接口返回的字段為null的設置為空字符串：

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.io.IOException;
@Configuration
public class CustomConfig {
 @Bean
 public ObjectMapper objectMapper() {
  ObjectMapper objectMapper = new ObjectMapper();
  objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
   @Override
   public void serialize(Object paramT, JsonGenerator paramJsonGenerator,
         SerializerProvider paramSerializerProvider) throws IOException {
    //設置返回null轉為 空字符串""
    paramJsonGenerator.writeString("");
   }
  });
  return objectMapper;
 }
}

2、設置null字段不返回給前端：

//1.實體上
@JsonInclude(Include.NON_NULL) 
//將該標記放在屬性上，如果該屬性為NULL則不參與序列化 
//如果放在類上邊,那對這個類的全部屬性起作用 
//Include.Include.ALWAYS 默認 
//Include.NON_DEFAULT 屬性為默認值不序列化 
//Include.NON_EMPTY 屬性為 空（“”） 或者為 NULL 都不序列化 
//Include.NON_NULL 屬性為NULL 不序列化 
//2.代碼上
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_NULL); 
//通過該方法對mapper對象進行設置，所有序列化的對象都將按改規(guī)則進行系列化 
//Include.Include.ALWAYS 默認 
//Include.NON_DEFAULT 屬性為默認值不序列化 
//Include.NON_EMPTY 屬性為 空（“”） 或者為 NULL 都不序列化 
//Include.NON_NULL 屬性為NULL 不序列化

來驗證下結果，很顯然，我們成功了，age、address、sex三個字段值為null，現(xiàn)在看到是空字符串：

補充知識：SpringBoot Jackson 將null轉字符串"" ，List、Array轉[]，Int轉0

如下所示：

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializationConfig;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
import org.apache.commons.lang3.StringUtils;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 
import java.io.IOException;
import java.util.Collection;
import java.util.List; 
 
/**
 * 使用官方自帶的json格式類庫，fastjson因為content type問題時不時控制臺報錯、無法直接返回二進制等問題
 */
class JacksonHttpMessageConverter extends MappingJackson2HttpMessageConverter {
 
  /**
   * 處理數(shù)組類型的null值
   */
  public class NullArrayJsonSerializer extends JsonSerializer<Object> {
 
    @Override
    public void serialize(Object value, JsonGenerator jgen, SerializerProvider provider) throws IOException, JsonProcessingException {
      if (value == null) {
        jgen.writeStartArray();
        jgen.writeEndArray();
      }
    }
  } 
 
  /**
   * 處理字符串類型的null值
   */
  public class NullStringJsonSerializer extends JsonSerializer<Object> {
 
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
      jsonGenerator.writeString(StringUtils.EMPTY);
    }
  }
 
  /**
   * 處理數(shù)字類型的null值
   */
  public class NullNumberJsonSerializer extends JsonSerializer<Object> {
 
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
      jsonGenerator.writeNumber(0);
    }
  }
 
  /**
   * 處理布爾類型的null值
   */
  public class NullBooleanJsonSerializer extends JsonSerializer<Object> {
 
    @Override
    public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
      jsonGenerator.writeBoolean(false);
    }
  } 
 
  public class MyBeanSerializerModifier extends BeanSerializerModifier { 
 
    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
      //循環(huán)所有的beanPropertyWriter
      for (Object beanProperty : beanProperties) {
        BeanPropertyWriter writer = (BeanPropertyWriter) beanProperty;
        //判斷字段的類型，如果是array，list，set則注冊nullSerializer
        if (isArrayType(writer)) {
          //給writer注冊一個自己的nullSerializer
          writer.assignNullSerializer(new NullArrayJsonSerializer());
        } else if (isNumberType(writer)) {
          writer.assignNullSerializer(new NullNumberJsonSerializer());
        } else if (isBooleanType(writer)) {
          writer.assignNullSerializer(new NullBooleanJsonSerializer());
        } else if (isStringType(writer)) {
          writer.assignNullSerializer(new NullStringJsonSerializer());
        }
      }
      return beanProperties;
    }
 
    /**
     * 是否是數(shù)組
     */
    private boolean isArrayType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return clazz.isArray() || Collection.class.isAssignableFrom(clazz);
    }
 
    /**
     * 是否是string
     */
    private boolean isStringType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return CharSequence.class.isAssignableFrom(clazz) || Character.class.isAssignableFrom(clazz);
    } 
 
    /**
     * 是否是int
     */
    private boolean isNumberType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return Number.class.isAssignableFrom(clazz);
    }
 
    /**
     * 是否是boolean
     */
    private boolean isBooleanType(BeanPropertyWriter writer) {
      Class<?> clazz = writer.getType().getRawClass();
      return clazz.equals(Boolean.class);
    } 
  }
 
  JacksonHttpMessageConverter() {
    getObjectMapper().setSerializerFactory(getObjectMapper().getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
  }
 
}

一定要在下面配置消息轉換器，不然沒效果

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
  @Override
  protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
    super.configureMessageConverters(converters);
    converters.add(new JacksonHttpMessageConverter());
  }
 
}

如果想要更豐富的可以在：MyBeanSerializerModifier中自定義。

以上這篇jackson設置返回null為空字符串的操作就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章:

簡潔實用的Java Base64編碼加密異常處理類代碼
這篇文章主要介紹了簡潔實用的Java Base64編碼加密異常處理類代碼,有一定的實用價值,需要的朋友可以參考下
2014-07-07
三種Java自定義DNS解析器方法與實踐
這篇文章主要分享三種Java自定義DNS解析器方法與實踐，對于高性能的測試機（54C96G * 3）而言，可任意通過自定義Java DNS解析器來實現(xiàn)接口請求，下文內(nèi)容的實現(xiàn)，需要的小伙伴可以參考一下
2022-02-02
Spring框架讀取property屬性文件常用5種方法
這篇文章主要介紹了Spring框架讀取property屬性文件常用5種方法,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2020-09-09
Spring連接Mysql數(shù)據(jù)庫全過程
這篇文章主要介紹了Spring連接Mysql數(shù)據(jù)庫全過程，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2022-11-11
Java畢業(yè)設計之多用戶宿舍管理系統(tǒng)的實現(xiàn)
這篇文章主要介紹了基于Java實現(xiàn)的多用戶宿舍管理系統(tǒng)，本文采用了jsp、servlet、jdbc等技術，文中示例代碼講解詳細，需要的可以參考一下
2022-02-02
SpringBoot微信消息接口配置詳解
這篇文章主要介紹了SpringBoot 微信消息接口配置詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下
2019-06-06
Kotlin this詳解及實例
這篇文章主要介紹了Kotlin this詳解及實例的相關資料,需要的朋友可以參考下
2017-06-06
淺談JavaWeb中的web.xml配置部署描述符文件
下面小編就為大家?guī)硪黄獪\談JavaWeb中的web.xml配置部署描述符文件。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧
2017-05-05
Java網(wǎng)絡編程UDP實現(xiàn)多線程在線聊天
這篇文章主要為大家詳細介紹了Java網(wǎng)絡編程UDP實現(xiàn)多線程在線聊天，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下
2021-07-07
關于SpringCloud的Bus消息總線圖文詳解
這篇文章主要介紹了關于SpringCloud的Bus消息總線圖文詳解,Spring Cloud Bus是用來將分布式系統(tǒng)的節(jié)點與輕量級消息系統(tǒng)鏈接起來的框架，它整合了Java的事件處理機制和消息中間件的功能,需要的朋友可以參考下
2023-05-05