SpringBoot解析JSON數(shù)據(jù)的三種方案

更新時(shí)間：2024年03月20日 11:00:01 作者：Archie_java

JSON(JavaScript Object Notation) 是一種輕量級(jí)的數(shù)據(jù)交換格式,易于人閱讀和編寫(xiě),同時(shí)也易于機(jī)器解析和生成,本文給大家介紹了SpringBoot解析JSON數(shù)據(jù)的三種方案,需要的朋友可以參考下

1 JSON簡(jiǎn)介

JSON(JavaScript Object Notation) 是一種輕量級(jí)的數(shù)據(jù)交換格式。易于人閱讀和編寫(xiě)。同時(shí)也易于機(jī)器解析和生成。JSON是一個(gè)標(biāo)記符的序列。這套標(biāo)記符包含六個(gè)構(gòu)造字符、字符串、數(shù)字和三個(gè)字面名。JSON是一個(gè)序列化的對(duì)象或數(shù)組。

2 Spring Boot默認(rèn)的JSON解析

Spring Boot項(xiàng)目中當(dāng)我們添加了spring-boot-starter-web依賴(lài)，就默認(rèn)提供了Jackson用于解析Json

2.1 使用示例

創(chuàng)建一個(gè)實(shí)體類(lèi)

@Component
public class User {
  private long id;
  private String username;
  private Date birthday;

  public long getId() {
    return id;
  }

  public void setId(long id) {
    this.id = id;
  }

  public String getUsername() {
    return username;
  }

  public void setUsername(String username) {
    this.username = username;
  }

  public Date getBirthday() {
    return birthday;
  }

  public void setBirthday(Date birthday) {
    this.birthday = birthday;
  }
}

創(chuàng)建一個(gè)Controller類(lèi)，用于頁(yè)面訪問(wèn)：

@RestController
public class ShowController {
  @GetMapping("/show")
  public List<User> show(){
    List<User> users=new ArrayList<User>();
    for (int i = 0; i < 5; i++) {
      User user=new User();
      user.setId(i);
      user.setUsername("張三"+i);
      user.setBirthday(new Date());
      users.add(user);

    }
    return  users;
  }
}

啟動(dòng)項(xiàng)目，瀏覽器訪問(wèn)，可以看到默認(rèn)返回了JSON格式的數(shù)據(jù)

在這里插入圖片描述

可以看到上面的Date類(lèi)型數(shù)據(jù)需要我們自定義格式，在實(shí)體類(lèi)中date屬性上添加JsonFormat注解可以實(shí)現(xiàn)：

  @JsonFormat(pattern = "YYYY-MM-dd")
  private Date birthday;

修改后重啟項(xiàng)目，瀏覽器訪問(wèn)：

在這里插入圖片描述

但是當(dāng)很多類(lèi)都需要配置自定義格式時(shí)，就需要添加多個(gè)注解，這樣是麻煩且不利于后期維護(hù)的。所以我們需要修改全局JSON格式。

下面以修改Date類(lèi)型數(shù)據(jù)為例：

2.2 修改特定數(shù)據(jù)的全局JSON格式

JSON的解析離不開(kāi)HttpMessageConvert，HttpMessageConvert是一個(gè)消息轉(zhuǎn)換工具，主要有兩方面的功能：

將服務(wù)端返回的對(duì)象序列化成JSON字符串
將前端傳來(lái)的JSON字符串反序列化成Java對(duì)象

SpringMVC中默認(rèn)配置了Jackson和GsonHttpMessageConverter，Spring Boot中對(duì)此做了自動(dòng)化配置，主要由以下兩個(gè)類(lèi)實(shí)現(xiàn):

org.springframework.boot.autoconfigure.http.JacksonHttpMessageConvertersConfiguration
org.springframework.boot.autoconfigure.http.GsonHttpMessageConvertersConfiguration

JacksonHttpMessageConvertersConfiguration的源碼如下：

@Configuration(
  proxyBeanMethods = false
)
class JacksonHttpMessageConvertersConfiguration {
  JacksonHttpMessageConvertersConfiguration() {
  }

  @Configuration(
    proxyBeanMethods = false
  )
  @ConditionalOnClass({XmlMapper.class})
  @ConditionalOnBean({Jackson2ObjectMapperBuilder.class})
  protected static class MappingJackson2XmlHttpMessageConverterConfiguration {
    protected MappingJackson2XmlHttpMessageConverterConfiguration() {
    }

    @Bean
    @ConditionalOnMissingBean
    public MappingJackson2XmlHttpMessageConverter mappingJackson2XmlHttpMessageConverter(Jackson2ObjectMapperBuilder builder) {
      return new MappingJackson2XmlHttpMessageConverter(builder.createXmlMapper(true).build());
    }
  }
//配置類(lèi)注解
  @Configuration(
    proxyBeanMethods = false
  )
  /*
  *下面幾個(gè)是條件注解，當(dāng)添加了Jackson依賴(lài)，就有了ObjectMapper.class和屬性，后面的配置就會(huì)生效
  */
  @ConditionalOnClass({ObjectMapper.class})
  @ConditionalOnBean({ObjectMapper.class})
  @ConditionalOnProperty(
    name = {"spring.http.converters.preferred-json-mapper"},
    havingValue = "jackson",
    matchIfMissing = true
  )

  static class MappingJackson2HttpMessageConverterConfiguration {
    MappingJackson2HttpMessageConverterConfiguration() {
    }

/*
*@ConditionalOnMissingBean的意思就是如果我們沒(méi)有配置這個(gè)Bean，就自動(dòng)創(chuàng)建一個(gè)默認(rèn)的，當(dāng)我們配置了就使用我們配置的Bean，不再創(chuàng)建
*/

    @Bean
    @ConditionalOnMissingBean(
      value = {MappingJackson2HttpMessageConverter.class},
      ignoredType = {"org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter", "org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter"}
    )
    /*
    *MappingJackson2HttpMessageConverter就是Jackson的消息轉(zhuǎn)換工具類(lèi)
    */
    MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(ObjectMapper objectMapper) {
    /*
    *JSON中序列化對(duì)象主要用ObjectMapper工具類(lèi)
    */
      return new MappingJackson2HttpMessageConverter(objectMapper);
    }
  }
}

通過(guò)查看上面源碼，可以知道我們修改生成的JSON的全局格式有以下兩種方式：

2.2.1 自定義MappingJackson2HttpMessageConverter

自己創(chuàng)建一個(gè)MappingJackson2HttpMessageConverter，取代JacksonHttpMessageConvertersConfiguration中項(xiàng)目自帶的。

例：
在上面創(chuàng)建的項(xiàng)目中，首先刪除JsonFormat注解，下面新建一個(gè)配置類(lèi)，內(nèi)容如下：

@Configuration
public class WebMVCConfig {
  @Bean
  MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(){
    MappingJackson2HttpMessageConverter converter=new MappingJackson2HttpMessageConverter();
    ObjectMapper om=new ObjectMapper();
    om.setDateFormat(new SimpleDateFormat("YYYY/MM/dd"));
    converter.setObjectMapper(om);
    return converter;
  }
}

2.2.2 自定義ObjectMapper

通過(guò)上面的類(lèi)可以看到類(lèi)中主要起作用的是ObjectMapping，上面的JacksonHttpMessageConvertersConfiguration可以看ObjectMapping是直接注入的。它是在配置類(lèi)JacksonAutoConfiguration 中提供的。

在這里插入圖片描述

修改WebMVCConfig類(lèi)，內(nèi)容如下：

@Configuration
public class WebMVCConfig {
  @Bean
  ObjectMapper objectMapper(){
    ObjectMapper om=new ObjectMapper();
    om.setDateFormat(new SimpleDateFormat("YYYY/MM/DD"));
    return om;
  }

}

兩種方式都是可以的，瀏覽器訪問(wèn)：

在這里插入圖片描述

3 使用Gson處理JSON

3.1 使用示例

基于上面創(chuàng)建的項(xiàng)目進(jìn)行修改，首先去掉spring-boot-starter-json依賴(lài)。然后添加gson依賴(lài)：

在這里插入圖片描述

然后將配置類(lèi)的jackson部分和一些導(dǎo)入的jackson包注釋或刪除，然后啟動(dòng)項(xiàng)目。

在這里插入圖片描述

可以看到日期格式是Gson默認(rèn)的。需要進(jìn)行修改

3.2 修改特定數(shù)據(jù)的全局JSON格式

GsonHttpMessageConvertersConfiguration的部分源碼如下：

  @Configuration(
    proxyBeanMethods = false
  )
  @ConditionalOnBean({Gson.class})
  @Conditional({GsonHttpMessageConvertersConfiguration.PreferGsonOrJacksonAndJsonbUnavailableCondition.class})
  static class GsonHttpMessageConverterConfiguration {
    GsonHttpMessageConverterConfiguration() {
    }

    @Bean
    @ConditionalOnMissingBean
    GsonHttpMessageConverter gsonHttpMessageConverter(Gson gson) {
      GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
      converter.setGson(gson);
      return converter;
    }

可以看到與Jackson差不多，所以可以仿照J(rèn)ackson進(jìn)行修改

3.2.1 自定義GsonHttpMessageConverter

@Configuration
public class WebMVCConfig {
    @Bean
      GsonHttpMessageConverter gsonHttpMessageConverter(){
      GsonHttpMessageConverter converter=new GsonHttpMessageConverter();
      converter.setGson(new GsonBuilder().setDateFormat("YYYY-MM-DD").create());
      return converter;
       }
 }

3.2.2 自定義Gson對(duì)象

上面配置主要用的是Gson對(duì)象，Gson對(duì)象是在GsonAutoConfiguration類(lèi)中，當(dāng)我們沒(méi)有配置時(shí)為我們創(chuàng)建的。然后在GsonHttpMessageConverter中使用。我們也可以自己創(chuàng)建一個(gè)Gson對(duì)象：

@Configuration
public class WebMVCConfig {

       @Bean
  Gson gson(){
   return new GsonBuilder().setDateFormat("YYYY-MM-DD").create();
       }

}

兩種方式都是可以的，瀏覽器訪問(wèn)：

在這里插入圖片描述

4 使用FastJson處理JSON

4.1 使用示例

以上面創(chuàng)建的項(xiàng)目為基礎(chǔ)，去除Jackson依賴(lài)，添加FastJson依賴(lài)：

在這里插入圖片描述

因?yàn)镾pring Boot沒(méi)有提供相關(guān)的自動(dòng)化配置類(lèi)，所以我們需要手動(dòng)創(chuàng)建FastJson的消息轉(zhuǎn)換工具類(lèi)：

@Configuration
public class WebMVCConfig {
  @Bean
  FastJsonHttpMessageConverter fastJsonHttpMessageConverter(){
    FastJsonHttpMessageConverter converter=new FastJsonHttpMessageConverter();
    return converter;
  }
  }

啟動(dòng)項(xiàng)目，瀏覽器訪問(wèn)：

在這里插入圖片描述

可以看到日期格式變成了FastJson的格式了。需要進(jìn)行修改。

4.2 修改特定數(shù)據(jù)的全局JSON格式

FastJson是直接在 FastJsonHttpMessageConverter類(lèi)中進(jìn)行修改，新建一個(gè)FastJsonConfig對(duì)象，此時(shí)需要對(duì)編碼進(jìn)行設(shè)置，否則會(huì)出現(xiàn)亂碼：

@Configuration
public class WebMVCConfig {
  @Bean
  FastJsonHttpMessageConverter fastJsonHttpMessageConverter(){
    FastJsonHttpMessageConverter converter=new FastJsonHttpMessageConverter();
    FastJsonConfig config=new FastJsonConfig();
    // 處理中文亂碼問(wèn)題
    List<MediaType> fastMediaTypes = new ArrayList<>();
    fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
    converter.setSupportedMediaTypes(fastMediaTypes);
    //設(shè)置日期格式
    config.setDateFormat("YYYY-MM-DD");
    converter.setFastJsonConfig(config);
    return converter;
  }
}

以上就是SpringBoot解析JSON數(shù)據(jù)的三種方案的詳細(xì)內(nèi)容，更多關(guān)于SpringBoot解析JSON數(shù)據(jù)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: