此時我們的返回結構如下：

{ 'code': 200, 'msg': 'ok', 'data': { 'id': 1, 'username': 'steve', 'secretKey': 'xxx', 'expiredAt': null, 'createdAt': '2020-07-07T06:09:15' }}

但上面有幾個問題：

我希望字段是以下劃線命名方式，也就是 createdAt 改成 created_at 這樣 我希望某些字段值的輸出格式可以自定義，比如日期類型我希望輸出是 yyyy-MM-dd HH:mm:ss 我不希望 secretKey 這類具有安全性質的字段返回給調用方 我不希望有 null 這樣的輸出，避免給調用方不必要的麻煩

定制字段名

我們有兩種選擇，第一種是在每一個字段上通過添加 @JsonProperty 注解來實現，如下：

@JsonProperty('secret_key')private String secretKey;

這種方式靈活度高，缺點就是繁瑣，變量名是單個單詞的不用轉換，多個單詞的如果要保持統一格式就需要每個都寫上，工作量不小。

第二種方式就是全局配置 Spring 內置的 Jackson 的序列化轉換器，在 config 目錄下新建 JsonConfig.java 文件：

package com.foxescap.wxbox.config;import com.fasterxml.jackson.databind.PropertyNamingStrategy;import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.http.converter.HttpMessageConverter;import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;import org.springframework.web.servlet.config.annotation.EnableWebMvc;import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;import java.time.format.DateTimeFormatter;import java.util.List;/** * @author xfly */@EnableWebMvc@Configurationpublic class WebMvcConfig implements WebMvcConfigurer { @Bean public LocalDateTimeSerializer localDateTimeSerializer() { return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern('yyyy-MM-dd HH:mm:ss')); } @Override public void configureMessageConverters(List<HttpMessageConverter<?>> converters) { converters.add(new MappingJackson2HttpMessageConverter( new Jackson2ObjectMapperBuilder().propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE).build()) ); }}

我們通過重寫 WebMvcConfigurer 接口的 configureMessageConverters 方法，添加自定義的 JSON 轉換器，關鍵是 propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) 這行代碼，設置屬性的命名策略為下劃線命名方式。

定制字段值格式

最常見的就是對時間類型的字段格式化，也有兩種方式，第一種是在每個字段上添加 @JsonFormat 注解，比如格式化日期時間：

@JsonFormat(pattern = 'yyyy-MM-dd HH:mm:ss')private LocalDateTime expiredAt;

也可以全局配置，我們在上面 JsonConfig 代碼的基礎上，加上一個類型串行器：

@Beanpublic LocalDateTimeSerializer localDateTimeSerializer() { return new LocalDateTimeSerializer(DateTimeFormatter.ofPattern('yyyy-MM-dd HH:mm:ss'));}@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) { converters.add( new MappingJackson2HttpMessageConverter( new Jackson2ObjectMapperBuilder() .propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) .serializerByType(LocalDateTime.class, localDateTimeSerializer()) .build() ) );}

這樣就能對全局 LocalDateTime 類型的字段序列化時轉換成我們自定義的格式了。

定制可見性

當我們不需要有字段被序列化，即需要忽略它，那么可以在那個字段上添加 @JsonIgnore 注解即可。

處理 Null

一般地，要么是直接忽略值為 null 的字段，要么是將 null 轉換成空字符串處理，前者可以直接在每個需要的字段上加 @JsonInclude(Include.NON_NULL) 注解，或者也可以在每個需要序列化的類上加，當然也可以全局配置，在 .build() 前加入 .serializationInclusion(JsonInclude.Include.NON_NULL) 即可。

如果我們不希望 null 值直接被忽略，又不需要直接給調用方返回 null，那么可以添加一個 setNullValueSerializer 方法自定義輸出：

@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) { var builder = new Jackson2ObjectMapperBuilder() .propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) //.serializationInclusion(JsonInclude.Include.NON_NULL) .serializerByType(LocalDateTime.class, localDateTimeSerializer()) .build(); builder.getSerializerProvider() .setNullValueSerializer(new JsonSerializer<>() { @Override public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {jsonGenerator.writeString(''); } }); converters.add(new MappingJackson2HttpMessageConverter(builder));}

糾結過是直接不序列化 Null 值還是設為空值，考慮到對于調用方，如果直接將 Null 值忽略了的話，數據的結構完整性就大大破壞了，比如一個數組，有幾個數組元素里的字段有，有幾個沒有，對于調用方就非常不友好了。

如果你想對不同變量類型的 Null 值分別處理的話，那么就需要重寫 changeProperties 方法，比如對于數組集合類型的字段，如果是 Null 值則序列化成 [] ；如果是字符串類型的字段，序列化成 '' ；如果是不二類型的字段，序列化成 false 等等：

@Overridepublic void configureMessageConverters(List<HttpMessageConverter<?>> converters) { var builder = new Jackson2ObjectMapperBuilder() .propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) .serializerByType(LocalDateTime.class, localDateTimeSerializer()) .build(); builder.setSerializerFactory(builder.getSerializerFactory().withSerializerModifier(new BeanSerializerModifier() { @Override public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) { for (var beanPropertyWriter : beanProperties) {var javaType = beanPropertyWriter.getType();if (javaType.isArrayType() || javaType.isCollectionLikeType()) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException { jsonGenerator.writeStartArray(); jsonGenerator.writeEndArray(); } });} else if (javaType.isTypeOrSubTypeOf(String.class)) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException { gen.writeString(''); } });} else if (javaType.isTypeOrSuperTypeOf(Boolean.class)) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException { gen.writeBoolean(false); } });} else if (javaType.isMapLikeType()) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException { gen.writeStartObject(); gen.writeEndObject(); } });} else if (javaType.isTypeOrSuperTypeOf(Integer.class) || javaType.isTypeOrSuperTypeOf(Long.class) || javaType.isTypeOrSuperTypeOf(Double.class) || javaType.isTypeOrSuperTypeOf(Float.class)) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException { gen.writeNumber(0); } });} else if (javaType.isTypeOrSuperTypeOf(LocalDateTime.class) || javaType.isTypeOrSuperTypeOf(LocalDate.class)) { beanPropertyWriter.assignNullSerializer(new JsonSerializer<>() { @Override public void serialize(Object value, JsonGenerator gen, SerializerProvider serializers) throws IOException { gen.writeString(''); } });} } return beanProperties; } })); converters.add(new MappingJackson2HttpMessageConverter(builder));}

到此這篇關于SpringBoot 定制化返回數據的實現示例的文章就介紹到這了,更多相關SpringBoot 定制化返回數據內容請搜索好吧啦網以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持好吧啦網！