json是我们现代互联网程序最常用的交互格式,是否你在工作中会遇到前端说字段不一致需要改的需求,是否遇到过数据库字段名与javaBean的规范不同,是否遇到过json与javaBean相互转换时因为需求写的土匪代码,这些都可以用Jackson完成,我们经常和json打交道,而Jackson就是帮助我们更好的处理json的框架,SpringBoot默认自带,还有一款Fastjson,阿里开源的,国内这两种用的比较多,我选择了Jackson,老牌稳定。
先来了解两个概念:
Jackson库有两个核心类:ObjectMapper和JsonNode。
ObjectMapper类是Jackson库中最重要的类,它提供了序列化和反序列化Java对象与JSON之间的转换。ObjectMapper类的实例是线程安全的,可以在多线程环境中共享。
JsonNode类是一个抽象类,它代表了一个JSON节点。JsonNode类有多个子类,例如ObjectNode、ArrayNode、ValueNode等,分别对应JSON中的对象、数组和值。JsonNode类提供了方便的方法来读取JSON节点的值。
注解是我们最常用的方式,直接选择常用的开搞,全注解 http://https://www.baeldung.com/jackson-annotations
@JsonProperty 序列化与反序列化别名,作用于属性上
JsonFormat.Shape.STRING:将属性序列化为字符串。JsonFormat.Shape.NUMBER:将属性序列化为数字。JsonFormat.Shape.ARRAY:将属性序列化为数组。JsonFormat.Shape.OBJECT:将属性序列化为对象。如果将 lenient 属性设置为 true,则在反序列化过程中可以允许一些非严格匹配的输入。例如,如果输入的日期字符串为 "2021-01",它并不符合完整的 "yyyy-MM-dd" 格式,但由于 lenient 设置为 true,Jackson 可以进行宽松解析,将其解释为 2021 年 1 月的某个日期(如 2021 年 1 月 1 日)。
@JsonUnwrapped 序列与反序列化时对象属性是否需要展开在父对象上,Map不适用,Map用@JsonAnyGetter
例如:
public class User {
private String name;
@JsonUnwrapped
private Address address;
}
public class Address {
private String street;
private String city;
}
结果
{
"name": "John",
"street": "123 Main St",
"city": "New York"
}
@JsonPropertyOrder 序列化时排列排列顺序
@JsonIgnore 序列化时忽略的属性,作用于属性上
@JsonIgnoreProperties 序列化忽略的属性集合,作用于类上
@JsonIgnoreType 忽略注释类型的所有属性,作用于类上
@JsonInclude 序列化时,值为规则这个属性隐藏,作用于类和属性上
JsonInclude.Include.ALWAYS:始终包含属性,即使属性值为 null。JsonInclude.Include.NON_NULL:仅在属性值不为 null 时才包含属性。JsonInclude.Include.NON_DEFAULT:仅在属性值与默认值不相等时才包含属性。JsonInclude.Include.NON_EMPTY:仅在属性值不为 null 且不为空(例如空字符串或空集合)时才包含属性。@JsonAnyGetter 注释允许灵活地将Map属性用作标准属性平铺在父对象上,适用序列化,作用于get方法上,返序列化用@JsonAnySetter
例如:
@Data
public class OrderDetails {
Map tempMap = new HashMap(){{
put("temp","temp");
put("temp1","temp1");
}};
@JsonAnyGetter
public Map getTempMap() {
return tempMap;
}
}
结果
{
"temp": "temp",
"temp1": "temp1"
}
@JsonGetter 序列化时别名,作用于get方法上
@JsonView 序列与反序列化 分组选择需要显示的属性
例子:
@Data
public class OrderDetails {
public interface UserSimpleView {};
public interface UserDetailView {};
@JsonView({UserSimpleView.class,UserDetailView.class})
String name = "yues";
@JsonView(UserDetailView.class)
String password = "123";
}
结果:
@JsonView(OrderDetails.UserSimpleView.class)
@RequestMapping("/add")
public Object add(@RequestBody OrderDetails orderDetails) {
// {
// "name": "yues"
// }
return orderDetails;
}
@JsonView(OrderDetails.UserDetailView.class)
@RequestMapping("/add")
public Object add(@RequestBody OrderDetails orderDetails) {
// {
// "name": "yues",
// "password": "123"
// }
return orderDetails;
}
@JsonRootName 包一层
例子:
@Data
@JsonRootName("user")
public class OrderDetails {
String name = "yues";
}
{
"user": {
"name": "yues"
},
}
@JsonSerialize 自定义序列化器
值为null不会执行
@JsonGetter 反序列化时别名,作用于set方法上
@JsonAlias 反序列化时别名,可以应用于类的属性上且可以指定多个
@JsonDeserialize 自定义反序列化器
例子
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotationsInside
@JsonInclude(Include.NON_NULL)
@JsonPropertyOrder({ "name", "id", "dateCreated" })
@JsonDeserialize //自定义反序列化
@@JsonSerialize //自定义序列化
public @interface CustomAnnotation {}
以上的注解都可以使用ObjectMapper对象来配置,先有ObjectMapper才有的这些注解,上面的注解都是使用ObjectMapper来完成的,在SpringBoot中我们还可以用ObjectMapper Bean来达到全局配置,当然也可以用配置文件。在日常的开发工作中,我们经常全局制定日期格式、驼峰_转换等等。
这里就不多做使用ObjectMapper来详细说,贴一些常用的方法吧
ObjectMapper mapper = new ObjectMapper()
mapper.enable(序列化配置);
mapper.configure(反序列化配置);
// 将字符串、byte[]转换为对象 序列化
mapper.readValue(jsonString, User.class);
// 此方法更灵活,可以只将用户感兴趣的Json串信息值提取出来 序列化
mapper.readTree(test);
// 将对象转换为json字符串 反序列化
mapper.writeValueAsString(user);
// 将对象转换为byte 反序列化
mapper.writeValueAsBytes(user)
登录查看全部
参与评论
手机查看
返回顶部