jackson学习之七:常用Field注解

Wesley13
• 阅读 571

欢迎访问我的GitHub

https://github.com/zq2599/blog_demos

内容:所有原创文章分类汇总及配套源码,涉及Java、Docker、Kubernetes、DevOPS等;

系列文章汇总

本篇概览

  1. 本文是《jackson学习》系列的第七篇,继续学习jackson强大的注解能力,本篇学习的是常用的Field注解,并通过实例来加深印象,下图是常用Field注解的简介:

jackson学习之七:常用Field注解

  1. 接下来逐个学习;

不止是Filed

  • 虽然标题说是常用Field注解,其实上图中的这些注解也能用在方法上,只不过多数情况下这些注解修饰在field上更好理解一些,例如JsonIgnore,放在field上和get方法上都是可以的;

  • 接下来逐个学习;

源码下载

  1. 如果您不想编码,可以在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协议

  1. 这个git项目中有多个文件夹,本章的应用在jacksondemo文件夹下,如下图红框所示:

jackson学习之七:常用Field注解 3. jacksondemo是父子结构的工程,本篇的代码在annotation子工程中,里面的fieldannonation这个package下,如下图:

jackson学习之七:常用Field注解

JsonProperty

  1. JsonProperty可以作用在成员变量和方法上,作用是在序列化和反序列化操作中指定json字段的名称;

  2. 先来看序列化操作(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;
        }
    }
    
  3. 执行结果如下图红框所示,可见JsonProperty的value就是序列化后的属性名,另外带有JsonProperty注解的成员变量,即使是私有而且没有get和set方法,也能被成功序列化,而且顺序也和index属性对应:

jackson学习之七:常用Field注解

  1. 接下来看反序列化操作(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 + '\'' +
                    '}';
        }
    }
    
  2. 用json字符串尝试反序列化,结果如下,可见field0和field1都能被正确赋值:

jackson学习之七:常用Field注解

JsonIgnore

  1. JsonIgnore好理解,作用在成员变量或者方法上,指定被注解的变量或者方法不参与序列化和反序列化操作

  2. 先看序列化操作(JsonIgnoreSerialization.java),如下所示,Test类的field1字段和getField2方法都有JsonIgnore注解:

    static class Test {
    
        private String field0;
    
        @JsonIgnore
        private String field1;
    
        private String field2;
    
        public String getField0() { return field0; }
        public void setField0(String field0) { this.field0 = field0; }
        public String getField1() { return field1; }
        public void setField1(String field1) { this.field1 = field1; }
        public void setField2(String field2) { this.field2 = field2; }
    
        @JsonIgnore
        public String getField2() { return field2; }
    }
    
  3. 给field0、field1、field2三个字段都赋值,再看序列化结果,如下图,可见field0和field2都被忽略了:

jackson学习之七:常用Field注解

  1. 再来尝试JsonIgnore注解在反序列化场景的作用,注意反序列化的时候,JsonIgnore作用的方法应该是set了,如下图:

jackson学习之七:常用Field注解

  1. 另外实测发现,反序列化的时候,JsonIgnore注解在get方法上也可以让对应字段被忽略;

JacksonInject

  1. JacksonInject的作用是在反序列化的时候,将配置好的值注入被JacksonInject注解的字段;

  2. 如下所示,Test类的field1和field2都有JacksonInject注解,不同的是field1指定了注入值的key为defaultField1,而field2由于没有指定key,只能按照类型注入:

    static class Test {
        private String field0;
        @JacksonInject(value = "defaultField1")
        private String field1;
        @JacksonInject
        private String field2;
    
  3. 注入时所需的数据来自哪里呢?如下所示,通过代码配置的,可以指定key对应的注入值,也可以指定类型对应的注入值:

        InjectableValues.Std injectableValues = new InjectableValues.Std();
        // 指定key为"defaultField1"对应的注入参数
        injectableValues.addValue("defaultField1","field1 default value");
        // 指定String类型对应的注入参数
        injectableValues.addValue(String.class,"String type default value");
        ObjectMapper mapper = new ObjectMapper();        // 把注入参数的配置设置给mapper
        mapper.setInjectableValues(injectableValues);
    
  4. 反序列化结果如下图,可见field1和field2的值都是被注入的:

jackson学习之七:常用Field注解

JsonSerialize

  1. JsonSerialize用于序列化场景,被此注解修饰的字段或者get方法会被用于序列化,并且using属性指定了执行序列化操作的类

  2. 执行序列化操作的类,需要继承自JsonSerializer,如下所示,Date2LongSerialize的作用是将Date类型转成long类型:

    static class Date2LongSerialize extends JsonSerializer<Date> {
    
        @Override
        public void serialize(Date value, JsonGenerator gen, SerializerProvider serializers) throws IOException {
            gen.writeNumber(value.getTime());
        }
    }
    
  3. Test类的field0字段是私有的,且没有get和set方法,但是添加了注释JsonDeserialize就能被反序列化了,并且使用Date2LongSerialize类对将json中的long型转成field0所需的Date型:

    static class Test {
        @JsonDeserialize(using = Long2DateDeserialize.class)
        private Date field0;
        @Override
        public String toString() { return "Test{" + "field0='" + field0 + '\'' + '}'; }
    }
    
  4. 执行结果如下:

jackson学习之七:常用Field注解

JsonDeserialize

  1. JsonDeserialize用于反序列化场景,被此注解修饰的字段或者set方法会被用于反序列化,并且using属性指定了执行反序列化操作的类;

  2. 执行反序列化操作的类需要继承自JsonDeserializer,如下所示,Long2DateDeserialize的作用是将Long类型转成field0字段对应的Date类型:

    static class Long2DateDeserialize extends JsonDeserializer<Date> {
    
        @Override
        public Date deserialize(JsonParser p, DeserializationContext ctxt) throws IOException, JsonProcessingException {
    
            if(null!=p && null!=ctxt && p.getLongValue()>0L ) {
                return new Date(p.getLongValue());
            }
    
            return null;
        }
    }
    
  3. 测试反序列化,结果如下:

jackson学习之七:常用Field注解

JsonRawValue

最后要介绍的是JsonRawValue,使用该注解的字段或者方法,都会被序列化,但是序列化结果是原始值,例如字符串是不带双引号的

jackson学习之七:常用Field注解

  • 至此,常用的Filed注解就操作完毕了,希望能带给您一些参考,助您更精确控制自己的序列化和反序列化操作;

你不孤单,欣宸原创一路相伴

  1. Java系列
  2. Spring系列
  3. Docker系列
  4. kubernetes系列
  5. 数据库+中间件系列
  6. DevOps系列

欢迎关注公众号:程序员欣宸

微信搜索「程序员欣宸」,我是欣宸,期待与您一同畅游Java世界... https://github.com/zq2599/blog_demos

点赞
收藏
评论区
推荐文章
blmius blmius
2年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
1星期前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Stella981 Stella981
2年前
K8S的StorageClass实战(NFS)
欢迎访问我的GitHubhttps://github.com/zq2599/blog\_demos(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2Fzq2599%2Fblog_demos)内容:所有原创文章分类汇总及配套源码,涉及Java、Doc
Stella981 Stella981
2年前
CDH+Kylin三部曲之一:准备工作
欢迎访问我的GitHubhttps://github.com/zq2599/blog\_demos(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2Fzq2599%2Fblog_demos)内容:所有原创文章分类汇总及配套源码,涉及Java、Doc
Stella981 Stella981
2年前
Kubernetes官方java客户端之四:内部应用
欢迎访问我的GitHubhttps://github.com/zq2599/blog\_demos(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2Fzq2599%2Fblog_demos)内容:所有原创文章分类汇总及配套源码,涉及Java、Doc
Stella981 Stella981
2年前
Kubernetes官方java客户端之二:序列化和反序列化问题
欢迎访问我的GitHubhttps://github.com/zq2599/blog\_demos(https://www.oschina.net/action/GoToLink?urlhttps%3A%2F%2Fgithub.com%2Fzq2599%2Fblog_demos)内容:所有原创文章分类汇总及配套源码,涉及Java、Doc
Wesley13 Wesley13
2年前
00:Java简单了解
浅谈Java之概述Java是SUN(StanfordUniversityNetwork),斯坦福大学网络公司)1995年推出的一门高级编程语言。Java是一种面向Internet的编程语言。随着Java技术在web方面的不断成熟,已经成为Web应用程序的首选开发语言。Java是简单易学,完全面向对象,安全可靠,与平台无关的编程语言。
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
6个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这