设为首页收藏本站
开启辅助访问

史上最全的Jackson框架使用教程

 您所在的位置：网站首页 › jackson冰鞋怎么样 › 史上最全的Jackson框架使用教程

史上最全的Jackson框架使用教程

2024-01-18 10:53| 来源: 网络整理| 查看: 265

简单介绍

别再使用 fastJson 了！漏洞天天报，Bug 修不完。快来拥抱 Jackson 吧！

Jackson 是用来序列化和反序列化 json 的 Java 的开源框架。Spring MVC 的默认 json 解析器便是 Jackson。与其他 Java 的 json 的框架 Gson 等相比， Jackson 解析大的 json 文件速度比较快；Jackson 运行时占用内存比较低，性能比较好；Jackson 有灵活的 API，可以很容易进行扩展和定制。

Jackson 的 1.x 版本的包名是 org.codehaus.jackson ，当升级到 2.x 版本时，包名变为 com.fasterxml.jackson，本文讨论的内容是基于最新的 Jackson 的 2.9.1 版本。

Jackson 的核心模块由三部分组成。

jackson-core，核心包，提供基于"流模式"解析的相关 API，它包括 JsonPaser 和 JsonGenerator。Jackson 内部实现正是通过高性能的流模式 API 的 JsonGenerator 和 JsonParser 来生成和解析 json。

jackson-annotations，注解包，提供标准注解功能；

jackson-databind ，数据绑定包， 提供基于"对象绑定" 解析的相关 API （ ObjectMapper ） 和"树模型" 解析的相关 API （JsonNode）；基于"对象绑定" 解析的 API 和"树模型"解析的 API 依赖基于"流模式"解析的 API。

在了解 Jackson 的概要情况之后，下面介绍 Jackson 的基本用法。

导入依赖

若想在 Java 代码中使用 Jackson 的核心模块的 jar 包 ，需要在 pom.xml 中添加如下信息。

  com.fasterxml.jackson.core  jackson-databind  2.9.1 

jackson-databind 依赖 jackson-core 和 jackson-annotations，当添加 jackson-databind 之后， jackson-core 和 jackson-annotations 也随之添加到 Java 项目工程中。在添加相关依赖包之后，就可以使用 Jackson。

快速入门

Jackson 最常用的 API 就是基于"对象绑定" 的 ObjectMapper。下面是一个 ObjectMapper 的使用的简单示例。

准备一个名称为 Person 的 Java 对象：

public class Person {     // 正常case     private String name;     // 空对象case     private Integer age;     // 日期转换case     private Date date;     // 默认值case     private int height; }

使用示例：

@Test public void test1() throws IOException {     ObjectMapper mapper = new ObjectMapper();     // 造数据     Person person = new Person();     person.setName("Tom");     person.setAge(40);     person.setDate(new Date());     System.out.println("序列化");     String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(person);     System.out.println(jsonString);     System.out.println("反序列化");     Person deserializedPerson = mapper.readValue(jsonString, Person.class);     System.out.println(deserializedPerson); }

打印输出：

序列化 { "name" : "Tom", "age" : 40, "date" : 1594634846647, "man" : null, "height" : 0 } 反序列化 JackSonTest.Person(name=Tom, age=40, date=Mon Jul 13 18:07:26 CST 2020, man=null, height=0)

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); //在序列化时自定义时间日期格式 mapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")); //在序列化时忽略值为 null 的属性 mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); //在序列化时忽略值为默认值的属性 mapper.setDefaultPropertyInclusion(JsonInclude.Include.NON_DEFAULT);

更多配置信息可以查看 Jackson 的 DeserializationFeature，SerializationFeature 和 Include。

重新运行单元测试1，打印输出：

序列化 {   "name" : "Tom",   "age" : 40,   "date" : "2020-07-26 18:46:51" } 反序列化 JackSonTest.Person(name=Tom, age=40, date=Sun Jul 26 18:46:51 CST 2020, height=0) 使用注解

Jackson 根据它的默认方式序列化和反序列化 java 对象，若根据实际需要，灵活的调整它的默认方式，可以使用 Jackson 的注解。常用的注解及用法如下。

注解用法@JsonProperty用于属性，把属性的名称序列化时转换为另外一个名称。示例：@JsonProperty("birth_date") private Date birthDate@JsonIgnore可用于字段、getter/setter、构造函数参数上，作用相同，都会对相应的字段产生影响。使相应字段不参与序列化和反序列化。@JsonIgnoreProperties该注解是类注解。该注解在Java类和JSON不完全匹配的时候使用。@JsonFormat用于属性或者方法，把属性的格式序列化时转换成指定的格式。示例：@JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm") public Date getBirthDate()@JsonPropertyOrder用于类， 和 @JsonProperty 的index属性类似，指定属性在序列化时 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 any() { return map; }@JsonNaming类注解。序列化的时候该注解可将驼峰命名的字段名转换为下划线分隔的小写字母命名方式。反序列化的时候可以将下划线分隔的小写字母转换为驼峰命名的字段名。示例：@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)@JsonRootName类注解。需开启mapper.enable(SerializationFeature.WRAP_ROOT_VALUE)，用于序列化时输出带有根属性名称的 JSON 串，形式如 {"root_name":{"id":1,"name":"zhangsan"}}。但不支持该 JSON 串反序列化。

使用示例：

// 用于类,指定属性在序列化时 json 中的顺序 @JsonPropertyOrder({"date", "user_name"}) // 批量忽略属性，不进行序列化 @JsonIgnoreProperties(value = {"other"}) // 用于序列化与反序列化时的驼峰命名与小写字母命名转换 @JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class) public static class User {     @JsonIgnore     private Map other = new HashMap();     // 正常case     @JsonProperty("user_name")     private String userName;     // 空对象case     private Integer age;     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")     // 日期转换case     private Date date;     // 默认值case     private int height;     public User() {     }     // 反序列化执行构造方法     @JsonCreator     public User(@JsonProperty("user_name") String userName) {         System.out.println("@JsonCreator 注解使得反序列化自动执行该构造方法 " + userName);         // 反序列化需要手动赋值         this.userName = userName;     }     @JsonAnySetter     public void set(String key, Object value) {         other.put(key, value);     }     @JsonAnyGetter     public Map any() {         return other;     }     // 本文默认省略getter、setter方法 }

单元测试：

@Test public void test3() throws IOException {     ObjectMapper mapper = new ObjectMapper();     // 造数据     Map map = new HashMap();     map.put("user_name", "Tom");     map.put("date", "2020-07-26 19:28:44");     map.put("age", 100);     map.put("demoKey", "demoValue");     String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(map);     System.out.println(jsonString);     System.out.println("反序列化");     User user = mapper.readValue(jsonString, User.class);     System.out.println(user);     System.out.println("序列化");     jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(user);     System.out.println(jsonString); }

打印输出：

{   "date" : "2020-07-26 19:28:44",   "demoKey" : "demoValue",   "user_name" : "Tom",   "age" : 100 } 反序列化 @JsonCreator 注解使得反序列化自动执行该构造方法Tom JackSonTest.User(other={demoKey=demoValue}, userName=Tom, age=100, date=Sun Jul 26 19:28:44 CST 2020, height=0) 序列化 {   "date" : "2020-07-26 19:28:44",   "user_name" : "Tom",   "age" : 100,   "height" : 0,   "demoKey" : "demoValue" } 日期处理

不同类型的日期类型，JackSon 的处理方式也不同。

普通日期

对于日期类型为 java.util.Calendar, java.util.GregorianCalendar, java.sql.Date, java.util.Date, java.sql.Timestamp，若不指定格式，在 json 文件中将序列化为 long 类型的数据。显然这种默认格式，可读性差，转换格式是必要的。

JackSon 有很多方式转换日期格式。

注解方式，使用 @JsonFormat 注解指定日期格式。

ObjectMapper 方式，调用 ObjectMapper 的方法 setDateFormat，将序列化为指定格式的 string 类型的数据。

Local日期

对于日期类型为 java.time.LocalDate, java.time.LocalDateTime，还需要添加代码 mapper.registerModule(new JavaTimeModule())，同时添加相应的依赖 jar 包。

导入依赖：

    com.fasterxml.jackson.datatype    jackson-datatype-jsr310    2.9.1 

对于 Jackson 2.5 以下版本，需要添加代码 mapper.registerModule(new JSR310Module ())。

使用示例：

@Data public static class Student {     // 正常case     private String name;     // 日期转换case     private LocalDateTime date; } @Test public void test4() throws IOException {     ObjectMapper mapper = new ObjectMapper();     // 必须添加对LocalDate的支持     mapper.registerModule(JavaTimeModule());     // 造数据     Student student = new Student();     student.setName("Tom");     student.setDate(LocalDateTime.now());     System.out.println("序列化");     String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(student);     System.out.println(jsonString);     System.out.println("反序列化");     Student deserializedPerson = mapper.readValue(jsonString, Student.class);     System.out.println(deserializedPerson); } private Module JavaTimeModule() {     JavaTimeModule module = new JavaTimeModule();     String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";     String DATE_FORMAT = "yyyy-MM-dd";     String TIME_FORMAT = "HH:mm:ss";     module.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DATE_TIME_FORMAT)));     module.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DATE_FORMAT)));     module.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern((TIME_FORMAT))));     module.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DATE_TIME_FORMAT)));     module.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DATE_FORMAT)));     module.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(TIME_FORMAT)));     return module; }

打印输出：

序列化 {   "name" : "Tom",   "date" : "2020-07-26 23:10:42" } 反序列化 JackSonTest.Student(name=Tom, date=2020-07-26T23:10:42) Joda日期

对于日期类型为 org.joda.time.DateTime，还需要添加代码 mapper.registerModule(new JodaModule())，同时添加相应的依赖 jar 包

    com.fasterxml.jackson.datatype   jackson-datatype-joda    2.9.1  对象集合

Jackson 对泛型反序列化也提供很好的支持。

List

对于 List 类型 ，可以调用 constructCollectionType 方法来序列化，也可以构造 TypeReference 来序列化。

使用示例：

@Test public void test5() throws IOException {     ObjectMapper mapper = new ObjectMapper();     CollectionType javaType = mapper.getTypeFactory().constructCollectionType(List.class, Person.class);     // 造数据     List list = new ArrayList();     for (int i = 0; i 


【本文地址】


今日新闻

推荐新闻

CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3