Jackson架构的高阶用转载

原创

小哥 3年前 (2022-10-27) 阅读数 90 #大杂烩

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，本文讨论的内容是基于最新的 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 基本用法。

Jackson 的基本用法

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

清单 1.在 pom.xml 的 Jackson 配置信息

< dependency >

< groupId >com.fasterxml.jackson.core</ groupId >

< artifactId >jackson-databind</ artifactId >

< version >2.9.1</ version >

</ dependency >

jackson-databind 依赖 jackson-core 和 jackson-annotations，当添加 jackson-databind 之后， jackson-core 和 jackson-annotations 还添加了 Java 项目成功了。添加相关依赖包后，即可使用。 Jackson。

ObjectMapper 的使用

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

清单 2 . 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 对象的所有属性。以下是一些例子：

清单 3 . 配置信息用法示例

//在反序列化中忽略 json 中存在但 Java 该对象不存在的属性。

mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,

false);

//日期格式在序列化时默认为。 yyyy-MM-ddTHH: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 和 I nclude。

Jackson 的笔记的使用

Jackson 根据其缺省值进行序列化和反序列化 java 对象，如果您根据实际需要灵活调整其默认方式，则可以使用它。 Jackson 笔记。常见的注释和用法如下。

表 1. 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; }

在了解 Jackson 在基本用法之后，下面将详细描述其一些更高阶的应用。

Jackson 的高阶应用

格式处理(包括日期格式)

不同类型对于DATE类型，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 包

清单 4 . JSR31 0 配置信息

< 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 包

清单 5. joda 的配置信息

< dependency >

< groupId >com.fasterxml.jackson.datatype</ groupId >

< artifactId >jackson-datatype-joda</ artifactId >

< version >2.9.1</ version >

</ dependency >

泛型反序列化

Jackson 泛型反序列化也得到了很好的支持。

对于 List 类型，您可以致电 constructCollectionType 方法来序列化，也可以构造。 TypeReference 连载。

清单 6 . List 泛类型使用示例

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 实现方式是相似的。

清单 7 . Map 泛类型使用示例

//第二个参数是 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 它还可以被序列化和反序列化。

清单 8 . 属性可视化示例

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 支持的类型包括 A

NY,DEFAULT,NON_PRIVATE,NONE,PROTECTED_AND_PUBLIC,PUBLIC_ONLY

属性过滤

在将 Java 对象序列化是 json 时，则需要过滤掉某些属性并不在中显示 json 中， Jackson 有几种方法可以实现它。

批注方法，可以用 @JsonIgnore 过滤单个属性或使用 @JsonIgnoreProperties 过滤多个属性，例如：

清单 9 . 属性过滤示例一。

@JsonIgnore

public int getAge()

@JsonIgnoreProperties(value = { "age","birth_date" })

public class Person

addMixIn 方法加注释法@JsonIgnoreProperties。

addMixIn 方法签名如下：

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

addMixIn 该方法的功能是使用 mixinSource 重写接口或类的注释。 target 或 target 批注的子类型的。用ixIn 设置

Person peixIn 的 @JsonIgnoreProperties("name")重写后，最终被忽略的属性是。 name，最终生成 json 如下：

{"birthDate":"2017/09/13","age":40}

SimpleBeanPropertyFilter 道路。这种方法比前两种方法更灵活、更复杂。

首先，您需要设置@JsonFilter 类或接口，后跟设置 addMixIn，将@JsonFilter 作用于 java 对象上的最后一个调用。 SimpleBeanPropertyFilter 的 serializeAllExcept 方法或重写 S impleBeanPropertyFilter 的 serializeAsField 方法筛选相关属性。以下是一些例子：

清单 11 . 属性过滤示例3

//设置 Filter 类或接口

@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，示例如下：

清单 12 . 自定义序列化

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。

自定义反序列化类。自定义反序列化类需要直接或间接继承 StdDeserializer 或 StdDeserializer，同时需要利用 JsonParser 读取 json，覆盖方法 deserialize，示例如下：

清单 13 . 自定义序列化

public class CustomDeserializer extends StdDeserializer< Person > {

@Override

public Person deserialize(JsonParser jp, DeserializationContext ctxt)

throws IOException, JsonProcessingException {

JsonNode node = jp.getCodec().readTree(jp);

Person person = new Person();

int age = (Integer) ((IntNode) node.get("age")).numberValue();

String name = node.get("name").asText();

person.setAge(age);

person.setName(name);

return person;

}

JsonParser 提供了多种阅读方式 json 信息，如 isClosed(), nextToken(), getValueAsString()等。如果您想单独创建它 JsonParser，可以通过 JsonFactory() 的 createParser。

定义自定义序列化类和自定义反序列化类。如果你想在程序中调用它们，你需要注册它们。 ObjectMapper 的 Module，示例如下：

清单 14 . 注册 M odule 示例

SimpleModule module = new SimpleModule("myModule");

module.addSerializer(new CustomSerializer(Person.class));

module.addDeserializer(Person.class, new CustomDeserializer());

mapper.registerModule(module);

也可以通过注解进行添加。 java 对象属性、方法或上面的类来调用它们，

@JsonSerialize(using = CustomSerializer.class)

@JsonDeserialize(using = CustomDeserializer.class)

public class Person

树模型处理

Jackson 此外，还提供了树模型(tree model)生成和分析 json。如果要修改或访问 json 有些属性，树模型是一个很好的选择。树模型 JsonNode 节点组成。经常在程序中使用 ObjectNode，ObjectNode 继承于 JsonNode，示例如下：

清单 15 . ObjectNode 生成和解析 json 示例

ObjectMapper mapper = new ObjectMapper();

//构建 ObjectNode

ObjectNode personNode = mapper.createObjectNode();

//添加/更改属性

personNode.put("name","Tom");

personNode.put("age",40);

ObjectNode addressNode = mapper.createObjectNode();

addressNode.put("zip","000000");

addressNode.put("street","Road NanJing");

//设置子节点

personNode.set("address",addressNode);

//通过 path 查找节点

JsonNode searchNode = personNode.path("street ")；

//删除属性

((ObjectNode) personNode).remove("address");

//读取 json

JsonNode rootNode = mapper.readTree(personNode.toString());

//JsonNode 转换成 java 对象

Person person = mapper.treeToValue(personNode, Person.class);

//java 对象转换 JsonNode

JsonNode node = mapper.valueToTree(person);

总结

这篇文章首先与其他人一起通过 Java 的 json 框架比较，介绍 Jackson 的优点，并介绍 Jackson 的核心模块的组成，以及各部分的作用。然后, 本文通过实例加以说明。 Jackson 的基本用法 ObjectMapper 的 write 和 read 方法，ObjectMapper 配置信息设定，以及 jackson-annotations 使用包装下的附注。最后，本文对此进行了详细的介绍。 Jackson 这也是本文研究的重点。这些较高级别的使用包括不同类型的日期格式处理(正常日期的类型，jdk 8 对于DATE类型，joda 日期类型)、List 和 Map 例如泛型反序列化、属性可视化管理Jackson 的三种属性筛选方法、自定义序列化和反序列化实现以及树模型的使用。通过对这篇文章的系统解释，我相信读者是对的。 Jackson 会有一个更深层次、更全面的把握。