Springboot整合Json（Jackson，Gson，FastJson）

我会带着你远行 2023-10-14 23:04 202阅读 0赞

文章目录

  • springboot整合json有三种方式,springboot默认是使用jackson的，如果要使用其他两种，要排除掉jackson
    • 1.springboot整合jackson
      • 1.1 pom.xml
      • 1.2 实体类,jackson注解的使用
      • 1.3 controller
      • 1.4 jackson全局配置
    • 2.springboot整合gson
      • 2.1 pom.xml
      • 2.2 实体类
      • 2.3 controller
      • 2.4 gson的全局配置方式
        • 2.4.1 application.[properties](https://so.csdn.net/so/search?q=properties&spm=1001.2101.3001.7020)
        • 2.4.2 通过配置文件，提供一个GsonBuilder或者转换器的Bean
    • 3.springboot整合fastjson
      • 3.1 pom.xml
      • 3.2 实体类
      • 3.3 controller
      • 3.4 fastjson的配置
    • 3.总结

springboot整合json有三种方式,springboot默认是使用jackson的，如果要使用其他两种，要排除掉jackson

1.springboot整合jackson

1.1 pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.5.4</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.yl</groupId>
  12.     <artifactId>springbootjackson</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>springbootjackson</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.         </dependency>
  25.         <dependency>
  26.             <groupId>org.springframework.boot</groupId>
  27.             <artifactId>spring-boot-starter-test</artifactId>
  28.             <scope>test</scope>
  29.         </dependency>
  30.     </dependencies>
  32.     <build>
  33.         <plugins>
  34.             <plugin>
  35.                 <groupId>org.springframework.boot</groupId>
  36.                 <artifactId>spring-boot-maven-plugin</artifactId>
  37.             </plugin>
  38.         </plugins>
  39.     </build>
  41. </project>

1.2 实体类,jackson注解的使用

  1. package com.yl.springbootjackson.model;
  3. import com.fasterxml.jackson.annotation.*;
  5. import java.util.Date;
  7. //序列化/反序列化时批量忽略属性
  8. @JsonIgnoreProperties({
  9.     "score","message"})
  10. public class User {
  12.     @JsonProperty(index = 92)
  13.     private String name;
  14.     //序列化/反序列化时忽略某一个属性
  15.     @JsonIgnore
  16.     private Integer sex;
  17.     //指定属性序列化/反序列化时的名称，默认就是属性名,value指定新的属性名，index主要用于排序
  18.     @JsonProperty(value = "aage",index = 91)
  19.     //类似于JsonProperty中的index，用于排序
  20.     //@JsonPropertyOrder()
  21.     private int age;
  22.     @JsonProperty(index = 90)
  23.     //日期格式化，注意时区问题
  24.     @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss",timezone = "Asia/Shanghai")
  25.     private Date birth;
  26.     @JsonProperty(index = 89)
  27.     private Integer score;
  28.     @JsonProperty(index = 88)
  29.     private String message;
  32.     public String getName() {
  34.         return name;
  35.     }
  37.     public void setName(String name) {
  39.         this.name = name;
  40.     }
  42.     public int getAge() {
  44.         return age;
  45.     }
  47.     public void setAge(int age) {
  49.         this.age = age;
  50.     }
  52.     public Date getBirth() {
  54.         return birth;
  55.     }
  57.     public void setBirth(Date birth) {
  59.         this.birth = birth;
  60.     }
  62.     @Override
  63.     public String toString() {
  65.         return "User{" +
  66.                 "name='" + name + '\'' +
  67.                 ", age=" + age +
  68.                 ", birth=" + birth +
  69.                 '}';
  70.     }
  71. }

1.3 controller

  1. package com.yl.springbootjackson.controller;
  3. import com.yl.springbootjackson.model.User;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.PostMapping;
  6. import org.springframework.web.bind.annotation.RequestBody;
  7. import org.springframework.web.bind.annotation.RestController;
  9. import java.util.Date;
  11. @RestController
  12. public class UserController {
  15.     @GetMapping("/getUser")
  16.     public User getUser() {
  18.         User user = new User();
  19.         user.setName("小兰");
  20.         user.setAge(19);
  21.         user.setBirth(new Date());
  22.         return user;
  23.     }
  25.     @PostMapping("/save")
  26.     public void save(@RequestBody User user) {
  28.         System.out.println(user);
  29.     }
  31.  }

1.4 jackson全局配置

  1. package com.yl.springbootjackson.config;
  3. import com.fasterxml.jackson.databind.ObjectMapper;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  7. import java.text.SimpleDateFormat;
  9. /**
  10.  * jackson全局配置方式,注入ObjectMapper即可
  11.  */
  12. @Configuration
  13. public class WebMVCConfig {
  15.     @Bean
  16.     ObjectMapper objectMapper() {
  18.         ObjectMapper objectMapper = new ObjectMapper();
  19.         objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
  20.         return objectMapper;
  21.     }
  22. }

2.springboot整合gson

2.1 pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.5.4</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.yl</groupId>
  12.     <artifactId>springbootgson</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>springbootgson</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.             <!--排除jackson依赖-->
  24.             <exclusions>
  25.                 <exclusion>
  26.                     <groupId>org.springframework.boot</groupId>
  27.                     <artifactId>spring-boot-starter-json</artifactId>
  28.                 </exclusion>
  29.             </exclusions>
  30.         </dependency>
  31.         <!--gson依赖-->
  32.         <dependency>
  33.             <groupId>com.google.code.gson</groupId>
  34.             <artifactId>gson</artifactId>
  35.         </dependency>
  36.         <dependency>
  37.             <groupId>org.springframework.boot</groupId>
  38.             <artifactId>spring-boot-starter-test</artifactId>
  39.             <scope>test</scope>
  40.         </dependency>
  41.     </dependencies>
  43.     <build>
  44.         <plugins>
  45.             <plugin>
  46.                 <groupId>org.springframework.boot</groupId>
  47.                 <artifactId>spring-boot-maven-plugin</artifactId>
  48.             </plugin>
  49.         </plugins>
  50.     </build>
  52. </project>

2.2 实体类

  1. package com.yl.springbootgson.model;
  3. import com.google.gson.annotations.Expose;
  5. import java.util.Date;
  7. public class User {
  9.     @Expose
  10.     private String name;
  11.     @Expose
  12.     private Date birth;
  14.     public String getName() {
  16.         return name;
  17.     }
  19.     public void setName(String name) {
  21.         this.name = name;
  22.     }
  24.     public Date getBirth() {
  26.         return birth;
  27.     }
  29.     public void setBirth(Date birth) {
  31.         this.birth = birth;
  32.     }
  33. }

2.3 controller

  1. package com.yl.springbootgson.controller;
  3. import com.yl.springbootgson.model.User;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. import java.util.Date;
  9. @RestController
  10. public class UserController {
  13.     @GetMapping("/getUser")
  14.     public User getUser() {
  16.         User user = new User();
  17.         user.setName("小南");
  18.         user.setBirth(new Date());
  19.         return user;
  20.     }
  21. }

2.4 gson的全局配置方式

2.4.1 application.properties
  1. spring.gson.date-format=yyyy-MM-dd HH:mm:ss
  2. # 是否禁用HTML的转义字符
  3. spring.gson.disable-html-escaping=true
  4. # 序列化时是否排除内部类
  5. spring.gson.disable-inner-class-serialization=false
  6. # 序列化时是否弃用复杂映射键
  7. spring.gson.enable-complex-map-key-serialization=
  8. # 是否排除没有@Expose注解的字段
  9. spring.gson.exclude-fields-without-expose-annotation=true
  10. # 序列化时字段名的命名策略
  11. spring.gson.field-naming-policy=lower_case_with_underscores
  12. # 在输出之前添加一些特殊的的文本来生成一个不可执行的json
  13. spring.gson.generate-non-executable-json=
  14. # 是否序列化空字段
  15. spring.gson.serialize-nulls=false
2.4.2 通过配置文件，提供一个GsonBuilder或者转换器的Bean
  1. package com.yl.springbootgson.config;
  3. import com.google.gson.GsonBuilder;
  4. import org.springframework.context.annotation.Bean;
  5. import org.springframework.context.annotation.Configuration;
  7. /**
  8.  * 自定义一个GsonBuilder,配置一些gson的属性
  9.  */
  10. @Configuration
  11. public class WebMVCConfig {
  13.     @Bean
  14.     GsonBuilder gsonBuilder() {
  16.         GsonBuilder gsonBuilder = new GsonBuilder();
  17.         gsonBuilder.setDateFormat("yyyy-MM-dd");
  18.         return gsonBuilder;
  19.     }
  20. }

3.springboot整合fastjson

3.1 pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.5.4</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.yl</groupId>
  12.     <artifactId>fastjson</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>fastjson</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-web</artifactId>
  23.             <exclusions>
  24.                 <exclusion>
  25.                     <groupId>org.springframework.boot</groupId>
  26.                     <artifactId>spring-boot-starter-json</artifactId>
  27.                 </exclusion>
  28.             </exclusions>
  29.         </dependency>
  30.         <!--fastjson依赖-->
  31.         <dependency>
  32.             <groupId>com.alibaba</groupId>
  33.             <artifactId>fastjson</artifactId>
  34.             <version>1.2.75</version>
  35.         </dependency>
  37.         <dependency>
  38.             <groupId>org.springframework.boot</groupId>
  39.             <artifactId>spring-boot-starter-test</artifactId>
  40.             <scope>test</scope>
  41.         </dependency>
  42.     </dependencies>
  44.     <build>
  45.         <plugins>
  46.             <plugin>
  47.                 <groupId>org.springframework.boot</groupId>
  48.                 <artifactId>spring-boot-maven-plugin</artifactId>
  49.             </plugin>
  50.         </plugins>
  51.     </build>
  53. </project>

3.2 实体类

  1. package com.yl.fastjson.model;
  3. import java.util.Date;
  5. public class User {
  7.     private String name;
  8.     private Date birth;
  9.     private Integer sex;
  11.     public String getName() {
  13.         return name;
  14.     }
  16.     public void setName(String name) {
  18.         this.name = name;
  19.     }
  21.     public Date getBirth() {
  23.         return birth;
  24.     }
  26.     public void setBirth(Date birth) {
  28.         this.birth = birth;
  29.     }
  31.     public Integer getSex() {
  33.         return sex;
  34.     }
  36.     public void setSex(Integer sex) {
  38.         this.sex = sex;
  39.     }
  40. }

3.3 controller

  1. package com.yl.fastjson.controller;
  3. import com.yl.fastjson.model.User;
  4. import org.springframework.web.bind.annotation.GetMapping;
  5. import org.springframework.web.bind.annotation.RestController;
  7. import java.util.Date;
  9. @RestController
  10. public class UserController {
  13.     @GetMapping("/getUser")
  14.     public User user() {
  16.         User user = new User();
  17.         user.setName("小白");
  18.         user.setBirth(new Date());
  19.         user.setSex(0);
  20.         return user;
  21.     }
  22. }

3.4 fastjson的配置

  1. package com.yl.fastjson.config;
  3. import com.alibaba.fastjson.serializer.SerializerFeature;
  4. import com.alibaba.fastjson.support.config.FastJsonConfig;
  5. import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.http.MediaType;
  9. import org.springframework.http.converter.HttpMessageConverter;
  10. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
  12. import java.nio.charset.Charset;
  13. import java.util.ArrayList;
  14. import java.util.List;
  16. /**
  17.  * fastjson如果想要使用，必须提供一个Converter
  18.  */
  19. @Configuration
  20. public class WebMvcConfig implements WebMvcConfigurer {
  23.     //方式一：继承WebMvcConfigurer，重写configureMessageConverters，将converter添加到converters中
  24.     @Override
  25.     public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
  27.         FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
  28.         List supportedMediaTypes = new ArrayList<>();
  29.         supportedMediaTypes.add(MediaType.APPLICATION_JSON);
  30.         supportedMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
  31.         supportedMediaTypes.add(MediaType.APPLICATION_ATOM_XML);
  32.         supportedMediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
  33.         supportedMediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);
  34.         supportedMediaTypes.add(MediaType.APPLICATION_PDF);
  35.         supportedMediaTypes.add(MediaType.APPLICATION_RSS_XML);
  36.         supportedMediaTypes.add(MediaType.APPLICATION_XHTML_XML);
  37.         supportedMediaTypes.add(MediaType.APPLICATION_XML);
  38.         supportedMediaTypes.add(MediaType.IMAGE_GIF);
  39.         supportedMediaTypes.add(MediaType.IMAGE_JPEG);
  40.         supportedMediaTypes.add(MediaType.IMAGE_PNG);
  41.         supportedMediaTypes.add(MediaType.TEXT_EVENT_STREAM);
  42.         supportedMediaTypes.add(MediaType.TEXT_HTML);
  43.         supportedMediaTypes.add(MediaType.TEXT_MARKDOWN);
  44.         supportedMediaTypes.add(MediaType.TEXT_PLAIN);
  45.         supportedMediaTypes.add(MediaType.TEXT_XML);
  46.         converter.setSupportedMediaTypes(supportedMediaTypes);
  47.         FastJsonConfig config = converter.getFastJsonConfig();
  48.         config.setCharset(Charset.forName("UTF-8"));
  49.         config.setDateFormat("yyyy-MM-dd HH:mm:ss");
  50.         config.setSerializerFeatures(SerializerFeature.PrettyFormat, SerializerFeature.WriteClassName);
  51.         converter.setFastJsonConfig(config);
  52.         converter.setDefaultCharset(Charset.forName("UTF-8"));
  53.         converters.add(converter);
  54.     }
  56.     //方式二：注册一个Bean
  57. //    @Bean
  58. //    FastJsonHttpMessageConverter fastJsonHttpMessageConverter() {
  60. //        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
  61. //        List supportedMediaTypes = new ArrayList<>();
  62. //        supportedMediaTypes.add(MediaType.APPLICATION_JSON);
  63. //        supportedMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
  64. //        supportedMediaTypes.add(MediaType.APPLICATION_ATOM_XML);
  65. //        supportedMediaTypes.add(MediaType.APPLICATION_FORM_URLENCODED);
  66. //        supportedMediaTypes.add(MediaType.APPLICATION_OCTET_STREAM);
  67. //        supportedMediaTypes.add(MediaType.APPLICATION_PDF);
  68. //        supportedMediaTypes.add(MediaType.APPLICATION_RSS_XML);
  69. //        supportedMediaTypes.add(MediaType.APPLICATION_XHTML_XML);
  70. //        supportedMediaTypes.add(MediaType.APPLICATION_XML);
  71. //        supportedMediaTypes.add(MediaType.IMAGE_GIF);
  72. //        supportedMediaTypes.add(MediaType.IMAGE_JPEG);
  73. //        supportedMediaTypes.add(MediaType.IMAGE_PNG);
  74. //        supportedMediaTypes.add(MediaType.TEXT_EVENT_STREAM);
  75. //        supportedMediaTypes.add(MediaType.TEXT_HTML);
  76. //        supportedMediaTypes.add(MediaType.TEXT_MARKDOWN);
  77. //        supportedMediaTypes.add(MediaType.TEXT_PLAIN);
  78. //        supportedMediaTypes.add(MediaType.TEXT_XML);
  79. //        converter.setSupportedMediaTypes(supportedMediaTypes);
  80. //        FastJsonConfig config = converter.getFastJsonConfig();
  81. //        config.setCharset(Charset.forName("UTF-8"));
  82. //        config.setDateFormat("yyyy-MM-dd HH:mm:ss");
  83. //        config.setSerializerFeatures(SerializerFeature.PrettyFormat, SerializerFeature.WriteClassName);
  84. //        converter.setFastJsonConfig(config);
  85. //        converter.setDefaultCharset(Charset.forName("UTF-8"));
  86. //        return converter;
  87. //    }
  88. }

3.总结

3.1springboot默认是使用jackson的，对jackson和gson都做了自动配置，所以一般使用这两者之一即可。如果非得要fastjson，那么必须将FastJsonHttpMessageConverter注册到容器中或者实现WebMvcConfigurer接口重写configureMessageConverters方法，将FastJsonHttpMessageConverter对象加到converters集合中即可。
3.2 除此之外，我们也可以自定义jackson或者gson的转换器，然后在里面设置一些自己需要的属性，然后注册到容器中即可使用

发表评论

表情：
评论列表 （有 0 条评论，202人围观）

还没有评论，来说两句吧...

相关阅读