欢迎访问我的GitHub
https://github.com/zq2599/blog_demos
内容:所有原创文章分类汇总及配套源码,涉及Java、Docker、Kubernetes、DevOPS等;
系列文章汇总jackson学习之三:常用API操作
jackson学习之四:WRAP_ROOT_VALUE(root对象)
jackson学习之五:JsonInclude注解
jackson学习之六:常用类注解
jackson学习之七:常用Field注解
jackson学习之八:常用方法注解
jackson学习之九:springboot整合(配置文件)
jackson学习之十(终篇):springboot整合(配置类)
本篇概览本文是《jackson学习》系列的第七篇,继续学习jackson强大的注解能力,本篇学习的是常用的Field注解,并通过实例来加深印象,下图是常用Field注解的简介:
接下来逐个学习;
不止是Filed
虽然标题说是常用Field注解,其实上图中的这些注解也能用在方法上,只不过多数情况下这些注解修饰在field上更好理解一些,例如JsonIgnore,放在field上和get方法上都是可以的;
接下来逐个学习;
源码下载如果您不想编码,可以在GitHub下载所有源码,地址和链接信息如下表所示(https://github.com/zq2599/blog_demos):
名称 链接 备注项目主页 https://github.com/zq2599/blog_demos 该项目在GitHub上的主页
git仓库地址(https) https://github.com/zq2599/blog_demos.git 该项目源码的仓库地址,https协议
git仓库地址(ssh) git@github.com:zq2599/blog_demos.git 该项目源码的仓库地址,ssh协议
这个git项目中有多个文件夹,本章的应用在jacksondemo文件夹下,如下图红框所示:
3. jacksondemo是父子结构的工程,本篇的代码在annotation子工程中,里面的fieldannonation这个package下,如下图: JsonProperty
JsonProperty可以作用在成员变量和方法上,作用是在序列化和反序列化操作中指定json字段的名称;
先来看序列化操作(JsonPropertySerialization.java),如下所示,JsonProperty修饰了私有成员变量field0和公共方法getField1,并且field0没有get和set方法,是通过构造方法设置的,另外还要注意JsonProperty注解的index属性,用来指定序列化结果中的顺序,这里故意将field1的顺序设置得比field0靠前:
static class Test { @JsonProperty(value="json_field0", index = 1) private String field0; @JsonProperty(value="json_field1", index = 0) public String getField1() { return "111"; } public Test(String field0) { this.field0 = field0; } }执行结果如下图红框所示,可见JsonProperty的value就是序列化后的属性名,另外带有JsonProperty注解的成员变量,即使是私有而且没有get和set方法,也能被成功序列化,而且顺序也和index属性对应:
接下来看反序列化操作(JsonPropertyDeserialization.java),注解相关代码如下,field0是私有且没有get和set方法,另外setField1方法也有JsonProperty注解:
static class Test { @JsonProperty(value = "json_field0") private String field0; private String field1; @JsonProperty(value = "json_field1") public void setField1(String field1) { this.field1 = field1; } @Override public String toString() { return "Test{" + "field0='" + field0 + '\'' + ", field1='" + field1 + '\'' + '}'; } }用json字符串尝试反序列化,结果如下,可见field0和field1都能被正确赋值:
JsonIgnoreJsonIgnore好理解,作用在成员变量或者方法上,指定被注解的变量或者方法不参与序列化和反序列化操作;