[Java] jackson注解

Posted 2020-06-14

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了[Java] jackson注解相关的知识，希望对你有一定的参考价值。

Jackson(http://jackson.codehaus.org)库是基于java语言的开源json格式解析工具。相对于javajson解析的其他库，诸如json-lib、gson包，Jackson具有以下优点：

功能全面，提供多种模式的json解析方式，“对象绑定”使用方便，利用注解包能为我们开发提供很多便利。

性能较高，“流模式”的解析效率超过绝大多数类似的json包。

jackson主要的包

jackson-core——核心包（必须），提供基于“流模式”解析的API。核心包：JsonPaser（json流读取），JsonGenerator（json流输出）。

jackson-databind——数据绑定包（可选），提供基于“对象绑定”和“树模型”相关API。数据绑定包：ObjectMapper（构建树模式和对象绑定模式），JsonNode（树节点）。

jackson-annotations——注解包（可选），提供注解功能。

jackson-datatype-joda-2.1.5.jar——日期转换

Jackson注解

1. 重命名属性，忽略属性，以及修改属性所使用的类型。

① 属性重命名时使用的注解

最常见的使用方式之一就是改变某个成员属性所使用的JSON名称。例如： class Name { @JsonProperty("firstName") public String _first_name; }

②忽略属性使用的注解

有时POJO包括了一些你不希望输出的属性，在这种情况下，你可以进行如下操作：

public class Value {
public int value;
@JsonIgnore public int internalValue;
}

或者，你可能忽略掉某些从JSON数据中得到的属性，如果是这样，你可以使用：
@JsonIgnoreProperties({ "extra", "uselessValue" })
public class Value {
public int value;
}

或者，更粗暴点的，忽略掉从JSON（由于在应用中没有完全匹配的POJO）中获得的所有“多余的”属性。

@JsonIgnoreProperties(ignoreUnknown=true)
public class PojoWithAny {
public int value;
}

③choose more/less specific types 时使用的注解

在有些情况下，Jackson在读入或输出一个成员属性时，所选用的类型（type）可能并不是你想要的

@JsonSerialize(as=BasicType.class) 将类型序列化成指定类型

@JsonSerialize(using=CustomDoubleSerialize.class) 作用于属性或者字段上，用于在序列化时嵌入我们自定义的代码，比如序列化一个double时在其后面限制两位小数点。

@JsonDeserialize 作用于属性或者字段上，指定反序列化方式

@JsonDeserialize(as=ValueImpl.class) 将类型反序列化成指定类型

@JsonDeserialize(using= CustomDateDeserialize.class) 用于在反序列化时嵌入我们自定义的代码

2. 使用构造器或工厂方法

在默认情况下，当由JSON数据创建相应类的实例时，Jackson尝试使用该类的“默认”构造器（即无参数构造器）。不过，你可以选择使用其他的构造器，或者一个静态工厂方法，来创建实例。完成这个操作，你需要使用@JsonCreator注解，有可能还需要使用@JsonProperty注解给参数（arguments）绑定名称。

publicclass MyBean {
  private int value;

  @JsonCreator
  publicMyBean(@JsonProperty("value") int v) {
    this.value = v;
  }
  public int getValue() { return value; }
}

使用相同的方式，可以将@JsonCreator用在静态工厂方法上。不过，还有一个可选的替代方案，被称作“授权式”构建器（“delegating” creator）：

publicclass DelegatingPOJO {
   private final int _x, _y;

   @JsonCreator
   publicDelegatingPOJO(Map<String,Object> delegate) {
      _x = (Integer)delegate.get("x");
      _y = (Integer)delegate.get("y");
   }
}

不同之处在于，构建器方法只能有一个参数，而且参数一定不要（must NOT）添加@JsonProperty注解。

3. 处理多态类型

如果你要进行读取、输出操作的对象拥有许多可能的子类型（即表现出多态性），你可能还需要添加一些类型信息。Jackson在反序列化时（读取JSON数据，生成相应的对象）需要这些信息，以便能正确地读取对象的类型。我们可以通过在“基本类型”上添加@JsonTypeInfo注解来完成操作：

@JsonTypeInfo 类注解，当输出操作的对象拥有多个子类型且在反序列化时需要添加子类对象的类型信息，使用此注解可以正确地设置子类对象的类型

@JsonTypeInfo(use=Id.CLASS,include=As.PROPERTY,property=”class”) 子类类型作为属性,属性名为class

// 将Java类的名称（“com.myempl.ImplClass”）存储到JSON的一个名称为“class”的属性中

@JsonTypeInfo(use=Id.CLASS, include=As.PROPERTY,property=”class”)
public abstract class BaseClass {
}

public class Impl1 extends BaseClass {
　　public int x;
}

public class Impl2 extends BaseClass {
　　public String name;
}

public class PojoWithTypedObjects {
　　public List<BaseClass> items;
}