1.Springboot返回JSON数据的方式
目前SpringBoot提供的Json格式有三种：
- Jackson(默认)
- Gson
- JsonB
我们都可以在springboot自动配置模块spring-boot-autoconfigure中查看到
Springboot为什么默认使用Jackson?
这是因为在spring-boot-starter-web依赖包中已经依赖了Jaskson的依赖包jackson-databind,使得Jackson变成了Springboot的默认Json处理器。
2.Jackson详解
2.1 Jackson默认实现
当我们创建springboot项目引入spring-boot-starter-web依赖以后，Springboot就开始帮助我们对实体进行Json处理了。
比如创建User实体类：
public class User implements Serializable {
private String id;
private String username;
private String sex;
private Integer age;
private String email;
private Date createTime;
private Date updateTime;
.....
}然后创建对应控制层处理类：
@RestController注解，会采用HttpMessageConverter将数据进行转换后写入Response的body数据区。
@RestController
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/user/list")
public Object list(){
Map resultMap = new HashMap<>(8);
resultMap.put("code","10000");
resultMap.put("data",userService.findList());
return resultMap;
}
} 测试结果如下：
2.2 自定义Jackson配置
2.2.1 通过配置文件
上面测试结果可以看到日期格式并不是我们想要的yyyy-MM-dd HH:mm:ss格式，这时候我就需要进行相关的jackson配置。
在application.yml中进行jackson的对应配置去实现
spring:
jackson:
date-format: yyyy-MM-dd HH:mm:ss重新进行测试结果如下：
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
2.2.2 通过ObjectMapper 进行代码配置实现
注释2.2.1中的配置文件，在代码中使用ObjectMapper进行实现。
@Configuration
public class JacksonConfig {
@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;
}
}2.2.3 使用注解实现
在字段上添加注解
@JsonPropertyOrder(value={"username","age","sex"})
public class User implements Serializable {
@JsonIgnore
private String id;
@JsonProperty("姓名")
private String username;
@JsonProperty("性别")
private String sex;
@JsonProperty("年龄")
private Integer age;
@JsonProperty("EMAIL")
private String email;
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createTime;
private Date updateTime;
......
}测试结果如下：
常用的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)：如果字段为空则不做序列化和反序列化