快捷導(dǎo)航

SpringBoot 定制化返回?cái)?shù)據(jù)的實(shí)現(xiàn)示例

更新時(shí)間：2020年07月15日 08:32:18 作者：阿亮叨逼叨

這篇文章主要介紹了SpringBoot 定制化返回?cái)?shù)據(jù)的實(shí)現(xiàn)示例，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

此時(shí)我們的返回結(jié)構(gòu)如下：

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

但上面有幾個(gè)問題：

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

定制字段名

我們有兩種選擇，第一種是在每一個(gè)字段上通過添加 @JsonProperty 注解來實(shí)現(xiàn)，如下：

@JsonProperty("secret_key")
private String secretKey;

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

第二種方式就是全局配置 Spring 內(nèi)置的 Jackson 的序列化轉(zhuǎn)換器，在 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
@Configuration
public 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 轉(zhuǎn)換器，關(guān)鍵是 propertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE) 這行代碼，設(shè)置屬性的命名策略為下劃線命名方式。

定制字段值格式

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

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

也可以全局配置，我們?cè)谏厦?JsonConfig 代碼的基礎(chǔ)上，加上一個(gè)類型串行器：

@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)
      .serializerByType(LocalDateTime.class, localDateTimeSerializer())
      .build()
    )
  );
}

這樣就能對(duì)全局 LocalDateTime 類型的字段序列化時(shí)轉(zhuǎn)換成我們自定義的格式了。

定制可見性

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

處理 Null

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

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

@Override
public 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));
}

糾結(jié)過是直接不序列化 Null 值還是設(shè)為空值，考慮到對(duì)于調(diào)用方，如果直接將 Null 值忽略了的話，數(shù)據(jù)的結(jié)構(gòu)完整性就大大破壞了，比如一個(gè)數(shù)組，有幾個(gè)數(shù)組元素里的字段有，有幾個(gè)沒有，對(duì)于調(diào)用方就非常不友好了。

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

@Override
public 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));
}

到此這篇關(guān)于SpringBoot 定制化返回?cái)?shù)據(jù)的實(shí)現(xiàn)示例的文章就介紹到這了,更多相關(guān)SpringBoot 定制化返回?cái)?shù)據(jù)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: