Jackson修改字段名和自定义命名策略

>>《轻松学习Jackson》程序员口袋里的开发手册

Jackson支持在处理数据的时候，使用不同于对象字段名的JSON名称（Jackson内部使用），来代替原来的字段名进行序列化和反序列化。

主要有几种实现方式：

• 使用@JsonProperty指定固定的名称进行名称映射；
• 使用预定义的命名策略PropertyNamingStrategy，设置全局或单个类的命名策略；
• 扩展PropertyNamingStrategy，实现自定义命名策略，读和写支持使用不同的命名策略。

本篇内容基于Jackson 2.11.2版本，马上开始学习吧。

属性名称@JsonProperty

对于需要修改名称的字段，可以在字段或getter方法添加@JsonProperty注解，指定一个固定的名称来替代原来的字段名。

public class AnimalPropertyName {
   

	@JsonProperty("animalName") // 字段重命名. 可以对字段或getter进行声明
	private String name;
	private int sex;
	private Integer weight;
	
	public String getName() {
   
		return name;
	}

	public void setName(String name) {
   
		this.name = name;
	}

	@JsonProperty("animalSex") // 字段重命名. 可以对字段或getter进行声明
	public int getSex() {
   
		return sex;
	}

	public void setSex(int sex) {
   
		this.sex = sex;
	}

	public Integer getWeight() {
   
		return weight;
	}

	public void setWeight(Integer weight) {
   
		this.weight = weight;
	}

	@Override
	public String toString() {
   
		return "Animal [name=" + name + ", sex=" + sex + ", weight=" + weight + "]";
	}

}

/**
 * 使用@JsonProperty("字段别名")注解，序列化和反序列化时使用指定的名称替代字段名
 *  
 * @throws IOException
 */
@Test
public void propertyName() throws IOException {
   
	AnimalPropertyName animal = new AnimalPropertyName();
	animal.setName("sam");
	animal.setSex(26);
	animal.setWeight(100);
	
	ObjectMapper mapper = new ObjectMapper();
	
	// 序列化
	String jsonString = mapper.writeValueAsString(animal);
	System.out.println(jsonString);
	
	// 正确反序列化
	String jsonString2 = "{\"weight\":200,\"animalName\":\"sam2\",\"animalSex\":2}";
	AnimalPropertyName animal2 = mapper.readValue(jsonString2, AnimalPropertyName.class);
	System.out.println(animal2.toString());

	// 错误反序列化. 不能使用原来的字段名name和sex，需要使用注解的名称animalName和animalSex
	String jsonString3 = "{\"weight\":200,\"name\":\"sam2\",\"sex\":2}";;
	AnimalPropertyName animal3 = mapper.readValue(jsonString3, AnimalPropertyName.class);
	System.out.println(animal3.toString());
}

执行结果：

{"weight":100,"animalName":"sam","animalSex":26}
Animal [name=sam2, sex=2, weight=200]
com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "name" ...