Jackson 是当前用的比较广泛的,用来序列化和反序列化 json 的 Java 的开源框架。Jackson 社 区相对比较活跃,更新速度也比较快, 从 Github 中的统计来看,Jackson 是最流行的 json 解析器之一 。 Spring MVC 的默认 json 解析器便是 Jackson。 Jackson 优点很多。 Jackson 所依赖的 jar 包较少 ,简单易用。与其他 Java 的 json 的框架 Gson 等相比, Jackson 解析大的 json 文件速度比较快;Jackson 运行时占用内存比较低,性能比较好;Jackson 有灵活的 API,可以很容易进行扩展和定制。
Jackson 的 1.x 版本的包名是 org.codehaus.jackson
,当升级到 2.x 版本时,包名变为com.fasterxml.jackson
。
项目主页:https://github.com/FasterXML/jackson
Jackson 的核心模块由三部分组成。
jackson-core
,核心包,提供基于”流模式”解析的相关 API,它包括JsonPaser
和JsonGenerator
。 Jackson 内部实现正是通过高性能的流模式 API 的JsonGenerator
和JsonParser
来生成和解析 json。jackson-annotations
,注解包,提供标准注解功能;jackson-databind
,数据绑定包, 提供基于”对象绑定” 解析的相关 API (ObjectMapper) 和”树模型” 解析的相关 API (JsonNode);基于”对象绑定” 解析的 API 和”树模型”解析的 API 依赖基于”流模式”解析的 API。
在了解 Jackson 的概要情况之后,下面介绍 Jackson 的基本用法。
Jackson 的 基本用法
若想在 Java 代码中使用 Jackson 的核心模块的 jar 包 ,需要在 pom.xml 中添加如下信息。
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.0</version>
</dependency>
jackson-databind
依赖 jackson-core
和 jackson-annotations
,当添加 jackson-databind
之后, jackson-core
和 jackson-annotations
也随之添加到 Java 项目工程中。在添加相关依赖包之后,就可以使用 Jackson。
ObjectMapper 的使用
Jackson 最常用的 API 就是基于”对象绑定” 的 ObjectMapper。下面是一个 ObjectMapper 的使用的简单示例。
ObjectMapper mapper = new ObjectMapper();
Person person = new Person();
person.setName("Tom");
person.setAge(40);
String jsonString = mapper.writerWithDefaultPrettyPrinter()
.writeValueAsString(person);
Person deserializedPerson = mapper.readValue(jsonString, Person.class);
ObjectMapper
通过 writeValue
系列方法 将 java 对 象序列化 为 json,并 将 json 存 储成不同的格式,String(writeValueAsString),Byte Array(writeValueAsString),Writer, File,OutStream 和 DataOutput。ObjectMapper
通过 readValue
系列方法从不同的数据源像 String , Byte Array, Reader,File,URL, InputStream 将 json 反序列化为 java 对象。
信息配置
在调用 writeValue
或调用 readValue
方法之前,往往需要设置 ObjectMapper
的相关配置信息。这些配置信息应用 java 对象的所有属性上。示例如下:
//在反序列化时忽略在 json 中存在但 Java 对象不存在的属性
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//在序列化时日期格式默认为 yyyy-MM-dd'T'HH:mm:ss.SSSZ
mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
//在序列化时忽略值为 null 的属性
mapper.setSerializationInclusion(Include.NON_NULL);
//忽略值为默认值的属性
mapper.setDefaultPropertyInclusion(Include.NON_DEFAULT);
更多配置信息可以查看 Jackson 的 DeserializationFeature
,SerializationFeature
和 Include
。
Jackson 的注解的使用
Jackson 根据它的默认方式序列化和反序列化 java 对象,若根据实际需要,灵活的调整它的默认方式,可以使用 Jackson 的注解。常用的注解及用法如下。
注解 | 用法 |
---|---|
@JsonProperty |
用于属性,把属性的名称序列化时转换为另外一个名称。示例: @JsonProperty("birth_ d ate") private Date birthDate; |
@JsonFormat |
用于属性或者方法,把属性的格式序列化时转换成指定的格式。示例: @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") public Date getBirthDate() {...} |
@JsonPropertyOrder |
用于类, 指定属性在序列化时 json 中的顺序 , 示例: @JsonPropertyOrder({ "birth_Date", "name" }) public class Person |
@JsonCreator |
用于构造方法,和 @JsonProperty 配合使用,适用有参数的构造方法。 示例: @JsonCreator public Person(@JsonProperty("name")String name) {…} |
@JsonAnySetter |
用于属性或者方法,设置未反序列化的属性名和值作为键值存储到 map 中 @JsonAnySetter public void set(String key, Object value) { map.put(key, value); } |
@JsonAnyGetter |
用于方法 ,获取所有未序列化的属性 public Map<string, object> any() { return map; } |
参考资源
https://www.cnblogs.com/guanbin-529/p/11488869.html,Jackson的基本使用
https://developer.ibm.com/zh/articles/jackson-advanced-application/,Jackson 框架的高阶应用
http://tutorials.jenkov.com/java-json/jackson-objectmapper.html,介绍 Jackson 的 ObjectMapper 的各种 write 和 read 方法 。
https://www.liaoxuefeng.com/wiki/1252599548343744/1320418650619938,使用Jackson