【Jackson 技术专题】全方位系统化学习和使用指南，学习指南

最新推荐文章于 2024-04-01 02:16:00 发布

架构师老李华

最新推荐文章于 2024-04-01 02:16:00 发布

阅读量791

点赞数 16

分类专栏： 2024年程序员学习文章标签：学习 windows

本文链接：https://blog.csdn.net/m0_60721860/article/details/136962393

版权

2024年程序员学习专栏收录该内容

269 篇文章 0 订阅

订阅专栏

在了解 Jackson 的基本用法后，下面详细地介绍它的一些高阶应用。

Jackson 的高阶应用

格式处理（含日期格式）

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

日期类型： java.util.Calendar,java.util.GregorianCalendar,java.sql.Date,java.util.Date,java.sql.Timestamp，若不指定格式，在 json 文件中将序列化为 long 类型的数据。显然这种默认格式，可读性差，转换格式是必要的。Jackson 有很多方式转换日期格式。注解方式，请参照" Jackson 的注解的使用"的 @ JsonFormat 的示例。

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

日期类型：

java.time.LocalDate，还需要添加代码 mapper.registerModule(new JavaTimeModule())，同时添加相应的依赖 jar 包

<dependency> `` <groupId>com.fasterxml.jackson.datatype</groupId> `` <artifactId>jackson-datatype-jsr310</artifactId> ``<version>2.9.1</version> </dependency>

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

日期类型：

org.joda.time.DateTime

还需要添加代码 mapper.registerModule(new JodaModule())，同时添加相应的依赖 jar 包

<dependency> `` <groupId>com.fasterxml.jackson.datatype</groupId> <artifactId>jackson-datatype-joda</artifactId>``<version>2.9.1</version> </dependency>

泛型反序列化

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

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

CollectionType javaType = mapper.getTypeFactory() ``.constructCollectionType(List.class, Person.class); List<Person> personList = mapper.readValue(jsonInString, javaType); List<Person> personList = mapper.readValue(jsonInString,new TypeReference<List<Person>>(){});

对于 map 类型，与 List 的实现方式相似。

//第二参数是 map 的 key 的类型，第三参数是 map 的 value 的类型 MapType javaType = mapper.getTypeFactory().constructMapType(HashMap.class,String.class, Person.class);`` Map<String, Person> personMap = mapper.readValue(jsonInString, javaType); `` Map<String, Person> personMap = mapper.readValue(jsonInString,new TypeReference<Map<String, Person>>() {});

Array 和 Collection 的处理与 List，Map 相似，这里不再详述。

属性可视化

是 java 对象的所有的属性都被序列化和反序列化，换言之，不是所有属性都可视化，默认的属性可视化的规则如下：

若该属性修饰符是 public，该属性可序列化和反序列化。
若属性的修饰符不是 public，但是它的 getter 方法和 setter 方法是 public，该属性可序列化和反序列化。因为 getter 方法用于序列化，而 setter 方法用于反序列化。
若属性只有 public 的 setter 方法，而无 public 的 getter 方法，该属性只能用于反序列化。

若想更改默认的属性可视化的规则，需要调用 ObjectMapper 的方法 setVisibility。

下面的示例使修饰符为 protected 的属性 name 也可以序列化和反序列化。

mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY); public class Person { `` public int age; ``protected String name; }

PropertyAccessor 支持的类型有:

ALL,CREATOR,FIELD,GETTER,IS_GETTER,NONE,SETTER

Visibility

**支持的类型有:ANY,DEFAULT,NON_PRIVATE,NONE,PROTECTED_AND_PUBLIC,PUBLIC_ONLY**

属性过滤（1）

在将 Java 对象序列化为 json 时，有些属性需要过滤掉，不显示在 json 中， Jackson 有多种实现方法。注解方式，可以用 @JsonIgnore 过滤单个属性或用 @JsonIgnoreProperties 过滤多个属性，示例如下：

@JsonIgnore public int getAge() @JsonIgnoreProperties(value = { "age","birth_date" }) public class Person

属性过滤（2）

addMixIn 方法加注解方式 @JsonIgnoreProperties。

addMixIn 方法签名如下：

public ObjectMapper addMixIn(Class<?> target, Class<?> mixinSource);

设置 Filter 类或接口，SimpleBeanPropertyFilter 方式。这种方式比前两种方式更加灵活，也更复杂一些。

首先需要设置 @JsonFilter 类或接口，其次设置 addMixIn，将 @JsonFilter 作用于 java 对象上，最后调用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法或重写 SimpleBeanPropertyFilter 的 serializeAsField 方法来过滤相关属性。示例如下：

@JsonFilter("myFilter") public interface MyFilter {} //设置 addMixIn mapper.addMixIn(Person.class, MyFilter.class); //调用 SimpleBeanPropertyFilter 的 serializeAllExcept 方法 SimpleBeanPropertyFilter newFilter = ``SimpleBeanPropertyFilter.serializeAllExcept("age"); //或重写 SimpleBeanPropertyFilter 的 serializeAsField 方法 `` SimpleBeanPropertyFilter newFilter = new SimpleBeanPropertyFilter() { `` @Override `` public void serializeAsField(Object pojo, JsonGenerator jgen, SerializerProvider provider, PropertyWriter writer) throws Exception { `` if (!writer.getName().equals("age")) { `` writer.serializeAsField(pojo, jgen, provider); `` } ``} }; //设置 FilterProvider FilterProvider filterProvider = new SimpleFilterProvider() ``.addFilter("myFilter", newFilter); mapper.setFilterProvider(filterProvider).writeValueAsString(person);

自定义序列化和反序列化

当 Jackson 默认序列化和反序列化的类不能满足实际需要，可以自定义新的序列化和反序列化的类。

自定义序列化类。自定义的序列化类需要直接或间接继承 StdSerializer 或 JsonSerializer，同时需要利用 JsonGenerator 生成 json，重写方法 serialize，示例如下：

public class CustomSerializer extends StdSerializer<Person> {

@Override

public void serialize(Person person, JsonGenerator jgen, SerializerProvider provider) throws IOException {

jgen.writeStartObject();

jgen.writeNumberField("age", person.getAge());

jgen.writeStringField("name", person.getName());

jgen.writeEndObject();

}

JsonGenerator 有多种 write 方法以支持生成复杂的类型的 json，比如 writeArray，writeTree 等。若想单独创建 JsonGenerator，可以通过 JsonFactory() 的 createGenerator。