SpringBoot設置Json返回字段為非空問題

更新時間：2024年08月09日 11:21:29 作者：小Y先生。

這篇文章主要介紹了SpringBoot設置Json返回字段為非空問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教

前言

各位同學可能遇到過下述問題，在項目開發(fā)中，后端是以Json格式的數(shù)據(jù)返回給前端，但是對于數(shù)據(jù)為空的字段，可能出現(xiàn)NULL，這讓前端同學很痛苦，于是他們想，針對那些為null的字段，后端能不能把String類型的數(shù)據(jù)返回空字符串，int類型的數(shù)據(jù)返回0，集合和數(shù)組返回[]，這樣多方便呢！

OK，既然這樣的話就滿足他們的要求，本文利用Spring自帶的Json轉(zhuǎn)化器，將返回給前端的數(shù)據(jù)進行處理，見下文所示。

一、編寫Json數(shù)據(jù)轉(zhuǎn)化器

/**
 * @作者 yangs
 * @日期 2022/1/20
 * @描述 json數(shù)據(jù)轉(zhuǎn)化器
 */
public 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);
        }

    }

    public JacksonHttpMessageConverter() {
        getObjectMapper().setSerializerFactory(getObjectMapper().getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
    }

}

二、編寫MVC配置文件

接下來我們要寫一個MVC的配置類，繼承WebMvcConfigurationSupport類，并重寫configureMessageConverters()方法，在這里方法中，我們要把上面定義的Json轉(zhuǎn)換工具加載進來，來實現(xiàn)我們想要的功能。

/**
 * @作者 yangs
 * @日期 2022/1/20
 * @描述 MVC的配置類
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    // 文件映射路徑
    @Value("${fileMappingPath}")
    private String fileMappingPath;

    /**
     * @作者 yangs
     * @日期 2022/1/20
     * @描述 返回給前端的json格式轉(zhuǎn)化器
     */
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        converters.add(new JacksonHttpMessageConverter());
    }
    
}

到目前為止，我們已經(jīng)實現(xiàn)了想要的功能，把String類型的null轉(zhuǎn)成""，把Integer類型的null轉(zhuǎn)成0，把空集合和數(shù)組轉(zhuǎn)成[]。

但是繼承WebMvcConfigurationSupport后，可能會出現(xiàn)一些坑，比如靜態(tài)資源獲取的問題。

繼續(xù)往下看，沒準可以防止埋雷。

三、防雷警告

繼承WebMvcConfigurationSupport類會使application.yml中配置的靜態(tài)資源映射失效，如果你在配置文件中配置了如下代碼

一定要警惕：

spring:
  mvc:
    static-path-pattern: /image/**
  resources:
    static-locations: file:E:/picture/

當我們繼承WebMvcConfigurationSupport類時，會是配置文件的靜態(tài)資源映射失效，所以我們需要另一種解決方法，只需在WebMvcConfigurationSupport的子類中重寫addResourceHandlers()方法即可

如下所示：

/**
 * @作者 yangs
 * @日期 2022/1/20
 * @描述 MVC的配置類
 */
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {

    /**
     * @作者 yangs
     * @日期 2022/1/20
     * @描述 返回給前端的json格式轉(zhuǎn)化器
     */
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        super.configureMessageConverters(converters);
        converters.add(new JacksonHttpMessageConverter());
    }

    // 文件映射路徑
    @Value("${fileMappingPath}")
    private String fileMappingPath;

    /**
     * @作者 yangs
     * @日期 2022/1/20
     * @描述 配置靜態(tài)資源訪問路徑
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //通過image獲取靜態(tài)資源
        registry.addResourceHandler("/image/**").addResourceLocations(fileMappingPath);
    }
}

你也可以查看我的另一篇文章，查閱如何在SpringBoot中訪問本地的靜態(tài)資源，SpringBoot訪問本地靜態(tài)資源。