性能文章>Jackson修改字段名和自定义命名策略>

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

792126

国庆期间写了一教程:《轻松学习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" ...

可以看到,第一行的序列化和第二行的反序列化结果,符合我们的预期。

但第二个反序列化抛出了异常,提示无法识别name字段。

第一次和第二次反序列化的区别,在于第一次使用了映射之后的属性名,而第二次则使用了对象的字段名。

也就是说,如果指定了属性名称,那么在进行序列化和反序列化时,都需要使用指定的属性名称。

命名策略PropertyNamingStrategy

使用属性名称,可以为不同字段设置不同的名称,而且这个名称是固定的。

如果被操作的字段,都需要遵循相同的命名规则,那么可以使用命名策略PropertyNamingStrategy来简化命名操作。

全局的命名策略

Jackson为我们提供了6个默认的命名策略。

public class AnimalNaming {

	private String animalName;
	private int animalSex;
	private int animalWeight;

	public String getAnimalName() {
		return animalName;
	}

	public void setAnimalName(String animalName) {
		this.animalName = animalName;
	}

	public int getAnimalSex() {
		return animalSex;
	}

	public void setAnimalSex(int animalSex) {
		this.animalSex = animalSex;
	}

	public int getAnimalWeight() {
		return animalWeight;
	}

	public void setAnimalWeight(int animalWeight) {
		this.animalWeight = animalWeight;
	}

	@Override
	public String toString() {
		return "AnimalNaming [animalName=" + animalName + ", animalSex=" + animalSex + ", animalWeight=" + animalWeight
		        + "]";
	}

}
/**
 * 使用预定义的属性命名策略
 * 
 * @throws IOException
 */
@Test
public void naming() throws IOException {
	AnimalNaming animal = new AnimalNaming();
	animal.setAnimalName("sam");
	animal.setAnimalSex(1);
	animal.setAnimalWeight(100);
	
	// 驼峰命名,字段的首字母小写. {"animalName":"sam","animalSex":1,"animalWeight":100}
	ObjectMapper mapper1 = new ObjectMapper();
	mapper1.setPropertyNamingStrategy(PropertyNamingStrategy.LOWER_CAMEL_CASE);
	System.out.println(mapper1.writeValueAsString(animal));
	
	// 驼峰命名,字段的首字母大写. {"AnimalName":"sam","AnimalSex":1,"AnimalWeight":100}
	ObjectMapper mapper2 = new ObjectMapper();
	mapper2.setPropertyNamingStrategy(PropertyNamingStrategy.UPPER_CAMEL_CASE);
	System.out.println(mapper2.writeValueAsString(animal));
	
	// 字段小写,多个单词以下划线_分隔. {"animal_name":"sam","animal_sex":1,"animal_weight":100}
	ObjectMapper mapper3 = new ObjectMapper();
	mapper3.setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
	System.out.println(mapper3.writeValueAsString(animal));

	// 字段小写,多个单词以中横线-分隔. {"animal-name":"sam","animal-sex":1,"animal-weight":100}
	ObjectMapper mapper4 = new ObjectMapper();
	mapper4.setPropertyNamingStrategy(PropertyNamingStrategy.KEBAB_CASE);
	System.out.println(mapper4.writeValueAsString(animal));
			
	// 字段小写,多个单词间无分隔符. {"animalname":"sam","animalsex":1,"animalweight":100}
	ObjectMapper mapper5 = new ObjectMapper();
	mapper5.setPropertyNamingStrategy(PropertyNamingStrategy.LOWER_CASE);
	System.out.println(mapper5.writeValueAsString(animal));

	// 字段小写,多个单词以点号.分隔. {"animal.name":"sam","animal.sex":1,"animal.weight":100}
	ObjectMapper mapper6 = new ObjectMapper();
	mapper6.setPropertyNamingStrategy(PropertyNamingStrategy.LOWER_DOT_CASE);
	System.out.println(mapper6.writeValueAsString(animal));
}

执行结果:

{"animalName":"sam","animalSex":1,"animalWeight":100}
{"AnimalName":"sam","AnimalSex":1,"AnimalWeight":100}
{"animal_name":"sam","animal_sex":1,"animal_weight":100}
{"animal-name":"sam","animal-sex":1,"animal-weight":100}
{"animalname":"sam","animalsex":1,"animalweight":100}
{"animal.name":"sam","animal.sex":1,"animal.weight":100}

通过ObjectMapper指定命名策略,这个策略是全局的。也就是说,只要使用了该ObjectMapper,那么都会应用该命名策略。

单个类的命名策略

如果命名策略只需要作用于某个类,那么可以使用@JsonNaming注解。

@JsonNaming(PropertyNamingStrategy.SnakeCaseStrategy.class)
public class AnimalJSONNaming {

	private String animalName;
	private int animalSex;
	private int animalWeight;

	public String getAnimalName() {
		return animalName;
	}

	public void setAnimalName(String animalName) {
		this.animalName = animalName;
	}

	public int getAnimalSex() {
		return animalSex;
	}

	public void setAnimalSex(int animalSex) {
		this.animalSex = animalSex;
	}

	public int getAnimalWeight() {
		return animalWeight;
	}

	public void setAnimalWeight(int animalWeight) {
		this.animalWeight = animalWeight;
	}

	@Override
	public String toString() {
		return "AnimalNaming [animalName=" + animalName + ", animalSex=" + animalSex + ", animalWeight=" + animalWeight
		        + "]";
	}

}
/**
 * 使用@JsonNaming注解,指定属性命名策略
 * 
 * @throws IOException
 */
@Test
public void jsonNaming() throws IOException {
	AnimalJSONNaming animal = new AnimalJSONNaming();
	animal.setAnimalName("sam");
	animal.setAnimalSex(1);
	animal.setAnimalWeight(100);
	
	ObjectMapper mapper = new ObjectMapper();
	System.out.println(mapper.writeValueAsString(animal));
}

执行结果:

{"animal_name":"sam","animal_sex":1,"animal_weight":100}

自定义的命名策略

命名策略的接口是PropertyNamingStrategy,而上面的预定义策略,都继承自PropertyNamingStrategyBase。

PropertyNamingStrategyBase的定义如下:

public static abstract class PropertyNamingStrategyBase extends PropertyNamingStrategy
{
    @Override
    public String nameForField(MapperConfig<?> config, AnnotatedField field, String defaultName)
    {
        return translate(defaultName);
    }

    @Override
    public String nameForGetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName)
    {
        return translate(defaultName);
    }

    @Override
    public String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName)
    {
        return translate(defaultName);
    }

    @Override
    public String nameForConstructorParameter(MapperConfig<?> config, AnnotatedParameter ctorParam,
            String defaultName)
    {
        return translate(defaultName);
    }
    
    public abstract String translate(String propertyName);
}

可见,如果要实现自定义的命名策略,只要简单的继承PropertyNamingStrategyBase,并实现translate()方法即可。

/**
 * 自定义命名策略,为字段添加下划线前缀
 */
@SuppressWarnings("serial")
public static class AppendPrefixStrategy extends PropertyNamingStrategyBase {
    @Override
    public String translate(String input){
        return '_' + input;
    }
}

/**
 * 自定义命名策略
 * 
 * @throws IOException
 */
@Test
public void customNaming() throws IOException {
	AnimalNaming animal = new AnimalNaming();
	animal.setAnimalName("sam");
	animal.setAnimalSex(1);
	animal.setAnimalWeight(100);
	
	ObjectMapper mapper = new ObjectMapper();
	mapper.setPropertyNamingStrategy(new AppendPrefixStrategy());
	System.out.println(mapper.writeValueAsString(animal));
	
	String jsonString = "{\"_animalName\":\"sam\",\"_animalSex\":1,\"_animalWeight\":100}";
//	String jsonString = "{\"animalName\":\"sam\",\"animalSex\":1,\"animalWeight\":100}";
	AnimalNaming animal2 = mapper.readValue(jsonString, AnimalNaming.class);
	System.out.println(animal2.toString());
}

执行结果:

{"_animalName":"sam","_animalSex":1,"_animalWeight":100}
AnimalNaming [animalName=sam, animalSex=1, animalWeight=100]

对于更复杂的命名策略,可以分别实现PropertyNamingStrategy中的各个方法。

例如,在反序列化时,想使用原来的字段名,而不是添加前缀后的名称。

/**
 * 自定义命名策略,为字段添加下划线前缀,其中setter方法使用默认的字段名
 */
@SuppressWarnings("serial")
public static class AppendPrefixStrategyForSetter extends PropertyNamingStrategyBase {
	@Override
	public String translate(String input){
		return '_' + input;
	}
	
	@Override
	public String nameForSetterMethod(MapperConfig<?> config, AnnotatedMethod method, String defaultName) {
		return defaultName;
	}
}

/**
 * 自定义命名策略
 * 
 * @throws IOException
 */
@Test
public void customNamingForSetter() throws IOException {
	AnimalNaming animal = new AnimalNaming();
	animal.setAnimalName("sam");
	animal.setAnimalSex(1);
	animal.setAnimalWeight(100);
	
	ObjectMapper mapper = new ObjectMapper();
	mapper.setPropertyNamingStrategy(new AppendPrefixStrategyForSetter());
	System.out.println(mapper.writeValueAsString(animal));
	
//	String jsonString = "{\"_animalName\":\"sam\",\"_animalSex\":1,\"_animalWeight\":100}";
	String jsonString = "{\"animalName\":\"sam\",\"animalSex\":1,\"animalWeight\":100}";
	AnimalNaming animal2 = mapper.readValue(jsonString, AnimalNaming.class);
	System.out.println(animal2.toString());
}

执行结果:

{"_animalName":"sam","_animalSex":1,"_animalWeight":100}
AnimalNaming [animalName=sam, animalSex=1, animalWeight=100]

小结

Jackson提供了多种方法,来支持对字段的灵活命名。

最简单直接的方式,是使用@JsonProperty注解来为字段命名。

如果命名规则统一,可以使用命名策略PropertyNamingStrategy来简化编码。

命名策略可以是全局的,也可以只针对特定的类。

如果命名规则复杂多样,可以自行实现命名规则,来满足实际的需求。

可以简单的继承PropertyNamingStrategyBase,也可以继承PropertyNamingStrategy实现更灵活的命名策略。

参考

https://dzone.com/articles/jackson-property-custom-naming-strategy

https://www.baeldung.com/jackson-name-of-property

关于我

公众号:二进制之路

教程:996geek.com

博客:binarylife.icu

请先登录,查看2条精彩评论吧
快去登录吧,你将获得
  • 浏览更多精彩评论
  • 和开发者讨论交流,共同进步

为你推荐

关于内存溢出,咱再聊点有意思的?
概述 上篇文章讲了JVM在GC上的一个设计缺陷,揪出一个导致GC慢慢变长的JVM设计缺陷,可能有不少人还是没怎么看明白的,今天准备讲的大家应该都很容易看明白 本文其实很犹豫写不写,因为感觉没有
又发现一个导致JVM物理内存消耗大的Bug(已提交Patch)
概述 最近我们公司在帮一个客户查一个JVM的问题(JDK1.8.0_191-b12),发现一个系统老是被OS Kill掉,是内存泄露导致的。在查的过程中,阴差阳错地发现了JVM另外的一个Bug。这个B
LONG究竟有多长,从皇帝的新衣到海康SDK
转眼之间初中毕业30年了,但我仍清楚的记得初中英语的一篇课文,题目叫《皇帝的新装》(“The king’s new clothes”)。这篇课文的前两句话是:”Long long ago, there
谨防JDK8重复类定义造成的内存泄漏
概述 如今JDK8成了主流,大家都紧锣密鼓地进行着升级,享受着JDK8带来的各种便利,然而有时候升级并没有那么顺利?比如说今天要说的这个问题。我们都知道JDK8在内存模型上最大的改变是,放弃了Perm
JVM垃圾回收与一次线上内存泄露问题分析和解决过程
本文转载自:花椒技术微信公众号 前言内存泄漏(Memory Leak)是指程序中己动态分配的堆内存由于某种原因程序未释放或无法释放,造成系统内存的浪费,导致程序运行速度减慢甚至系统崩溃等严重后果。Ja
Jackson修改字段名和自定义命名策略
国庆期间写了一教程:[《轻松学习Jackson》程序员口袋里的开发手册](https://996geek.com/articles/164),这是其中的一篇。Jackson支持在处理数据的时候,使用不
Java Record 的一些思考 - 序列化相关
Record 在设计之初,就是为了找寻一种纯表示数据的类型载体。Java 的 class 现在经过不断的迭代做功能加法,用法已经非常复杂,各种语法糖,各种多态构造器,各种继承设计导致针对 Java 的序列化框架也做得非常复杂,要考虑的情况有很多很多。
抛砖系列之-MySQL中的数据类型JSON
今天介绍一个MySQL中的数据类型-JSON,相信大家对JSON都不陌生,在日常工作中使用到的频率也很高