HeapDump性能社区

性能工具
登录注册
性能文章>Jackson修改字段名和自定义命名策略>

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

betterlife
4年前
1210127

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

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

为你推荐

Redis stream 用做消息队列完美吗？

Redis stream 用做消息队列完美吗？

redis
Netty源码解析：writeAndFlush

Netty源码解析：writeAndFlush

netty
源码
7
2
Lv1
betterlife

徽章

推荐阅读

Redis stream 用做消息队列完美吗？Netty源码解析：writeAndFlush一次 Rancher go 应用内存占用过高问题排查一文讲透消息队列RocketMQ实现消费幂等【云原生•监控】Micrometer打造SpringBoot服务的可观测能力解锁 ElasticJob 云原生实践的难题
站内搜索
SpringBoot
实战案例
堆外内存泄漏
zookeeper
docker
Prometheus
java
jvm
gc
linux
内存泄漏
内核

本月精选性能专题

本月精选线上案例

本月精选原创好文

HeapDump

有性能问题，上HeapDump性能社区

Copyright © 2019-2024 heapdump.cn 版权所有 浙ICP备17054444号

联系我们

HeapDump性能社区

网媒渠道

堆堆酱

扫码加堆堆酱好友

友情链接

PerfMa官网SegmentFault思否TesterHomeXPocket开源社区DCloud 问答社区稀土掘金博客园W3CTech