SpringBoot-24-默认Json框架jackson配置详解

SpringBoot返回JSON数据的方式

目前SpringBoot提供的JSon格式有三种：

默认jackson
Gson
JsonB
fastjson（这是阿里提供的，现在国内也较多使用）

这些我们都可以在springboot自动配置模块spring-boot-autoconfigure中查看到

为什么springboot默认使用Jackson呢?

这是因为在spring-boot-starter-web依赖包中已经依赖了Jaskson的依赖包jackson-databind,是的Jackson变成了Springboot的默认Json处理器。

下面我们就开始讲解一下SpringBoot默认Json框架Jackson的详细配置。

Jackson详解

Jackson默认实现

当我们创建springboot项目引入spring-boot-starter-web依赖以后，Springboot就开始帮助我们对实体进行Json处理了。

例如我们创建Student实体类：

@Data
public class Student implements Serializable{

    private Long id;
    private String name;
    private String sex;
    private int age;
    private String email;
    private String mobile;
    private int isEnabled;
    private Date createDate;
    private Date updateDate;

}

然后创建对应控制层处理类：

@Slf4j
@RestController
@RequestMapping("/student")
public class StudentController {


    @Autowired
    private StudentService studentService;

    @GetMapping("/selectall")
    public List<Student> getAll() {
        return studentService.getAll();
    }
}

注：

@RestController注解，会采用HttpMessageConverter将数据进行转换后写入Response的body数据区。

测试结果为：

Jackson配置

在上面图中我们发现日期格式不是我们想要的yyyy-MM-dd HH:mm:ss格式，那么我们需要通过Jackson怎么将默认时间格式，转换为我们想要的时间格式呢？

通过在application.yml中进行jackson的对应配置去实现

  jackson:
    #日期类型格式化
    date-format: yyyy-MM-dd HH:mm:ss

配置结束以后，我们再次测试http://localhost:8899/student/selectall接口结果如下：

通过ObjectMapper 进行代码配置实现

我们首先将在application.yml中配置的时间格式的配置注释，然后在代码中使用ObjectMapper进行实现

@Configuration
public class MyJacksonConfig {


    @Bean
    @Primary
    @ConditionalOnMissingBean
    public ObjectMapper objectMapper(Jackson2ObjectMapperBuilder builder){
        ObjectMapper mapper = builder.createXmlMapper(false).build();
        mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return  mapper;
    }
}

结果和在配置中的实现是一致的。

在实体类中使用注解

在想要变换格式的字段上添加注解，进行变换格式，实现如下

@Data
@JsonPropertyOrder(value={"name","mobile","sex"})
public class Student implements Serializable{

    @JsonIgnore
    private Long id;
    private String mobile;
    @JsonProperty("性别")
    private String sex;
    private String name;

    private int age;
    @JsonProperty("邮箱")
    private String email;

    private int isEnabled;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date createDate;
    private Date updateDate;
}

添加注解结束以后，我们再次测试http://localhost:8899/student/selectall接口结果如下：

在图中我们发现name、mobile字段顺序变换了，sex不仅顺序变换了而且使用了别名，id字段消失了，这都是jackson注解发挥的作用。

常用的Jackson注解：

**@JsonPropertyOrder(value={“value1″,”value2″,”value3”})**：将实体对应转换后默认json顺序，根据注解要求进行变换
@JsonIgnore：将某字段排除在序列化和反序列化之外
**@JsonFormat(pattern = “yyyy-MM-dd HH:mm:ss”, timezone = “GMT+8”)**：按照指定日期格式进行转换
**@JsonProperty(“邮箱”)**：给对应字段起别名
**@JsonInclude(JsonInclude.Include.NON_NULL)**：如果字段为空则不做序列化和反序列化

Jackson常用配置

# 日期格式字符串或标准日期格式类全限定名，只控制java.util.Date的序列化format
spring.jackson.date-format= yyyy-MM-dd HH:mm:ss

# 指定Joda date/time的格式，比如yyyy-MM-ddHH:mm:ss. 如果没有配置的话，dateformat会作为backup。
spring.jackson.joda-date-time-format= yyyy-MM-dd HH:mm:ss

# 全局设置pojo或被@JsonInclude注解的属性的序列化方式
spring.jackson.default-property-inclusion= NON_NULL
# 不为空的属性才会序列化,具体属性可看JsonInclude.Include

# 是否开启Jackson的序列化
# 示例：spring.jackson.serialization.indent-output= true
spring.jackson.serialization.*=

# 是否开启Jackson的反序列化
spring.jackson.deserialization.*= 

# 是否开启json的generators
# 示例：spring.jackson.generator.auto-close-json-content=true
spring.jackson.generator.*= 

# 指定json使用的Locale
spring.jackson.locale= zh

# 是否开启Jackson通用的特性
spring.jackson.mapper.*= 

# 是否开启jackson的parser特性
spring.jackson.parser.*= 

# 指定Json策略模式
spring.jackson.property-naming-strategy=com.fasterxml.jackson.databind.PropertyNamingStrategy.UpperCamelCaseStrategy
# 或
spring.jackson.property-naming-strategy=UPPER_CAMEL_CASE

# 是否开启Jackson的反序列化
spring.jackson.serialization.*= 

# 指定日期格式化时区，比如America/Los_Angeles或者GMT+10
spring.jackson.time-zone= GMT+8