Jackson 2.x 系列【6】注解大全篇二

有道无术，术尚可求，有术无道，止于术。

本系列Jackson 版本 2.17.0

源码地址：https://gitee.com/pearl-organization/study-jaskson-demo

文章目录

    • 注解大全
      • 2.11 @JsonValue
      • 2.12 @JsonKey
      • 2.13 @JsonAnySetter
      • 2.14 @JsonAnyGetter
      • 2.15 @JacksonInject
      • 2.16 @JsonCreator
      • 2.17 @JsonTypeInfo
      • 2.18 @JsonSubTypes
      • 2.19 @JsonTypeName
      • 2.20 @JsonTypeId

注解大全

2.11 @JsonValue

@JsonValue用于将整个对象序列化为单个值，常用于只包含单个值的简单对象或枚举类型。Jackson 会忽略对象的其他属性和字段，只序列化由 @JsonValue 注解指定的方法或属性值。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonValue {boolean value() default true;
}

例如当前有个性别枚举类：

public enum GenderEnum {MAN("man", "男"),WOMAN("woman", "女");GenderEnum(String code, String desc) {this.code = code;this.desc = desc;}private String code;private String desc;// 省略getter\serter.......
}

用户对象类包含了性别枚举类属性：

    GenderEnum gender;

设置性别并进行序列化：

        user.setGender(GenderEnum.WOMAN);String jsonValuesStr = objectMapper.writeValueAsString(user);System.out.println(jsonValuesStr);

输出时可以看到枚举类被序列化为WOMAN，我们期望输出的是女：

{"gender":"WOMAN","userAge":25,"mobilePhone":"13899996666"}

在枚举类字段上添加@JsonValue：

    @JsonValueprivate String desc;

再次执行，可以看到将整个枚举类序列化为了一个值：

{"gender":"女","userAge":25,"mobilePhone":"13899996666"}

2.12 @JsonKey

@JsonKey也是将某个对象序列化为单个值，但是仅在实例作为Map类型中的键进行序列化时有效。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonKey {boolean value() default true;
}

例如下方代码：

        Org org1=new Org();org1.setId(1765672919981232128L);org1.setOrgName("阿里巴巴");Org org2=new Org();org2.setId(1772078846569590784L);org2.setOrgName("支付宝");Map<Org, String> map = new HashMap<>();map.put(org1,"顶级机构");map.put(org2,"下级机构");String orgStr = objectMapper.writeValueAsString(map);System.out.println(orgStr);

序列化后输出如下：

{"Org{id=1765672919981232128, orgName='null', address='null'}":"顶级机构","Org{id=1772078846569590784, orgName='null', address='null'}":"下级机构"}

在Org属性上添加@JsonKey注解，表示序列化该对象时，使用orgName值作为Map中的键：

    @JsonKeyprivate String orgName;

输出如下：

{"阿里巴巴":"顶级机构","支付宝":"下级机构"}

2.13 @JsonAnySetter

@JsonAnySetter用于反序列化时，将被忽略或无法反序列化的内容，统一存放在Map集合中。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonAnySetter {boolean enabled() default true;
}

在UserInfo中添加一个Map属性，Setter方法使用@JsonAnySetter标识：

    private Map<String,Object> collect =new HashMap<>();@JsonAnySetterpublic void setCollect(String key,Object value) {this.collect.put(key,value);}

JSON中有一个idCard属性是UserInfo类没有的：

        String jsonAnySetterStr="{\"idCard\":\"43268825255522222\",\"userSex\":\"男\",\"id\":1767798780627279873,\"username\":\"坤坤\",\"userAge\":18,\"org\":{\"id\":1699967647585800192,\"orgName\":\"阿里巴巴\",\"address\":\"浙江杭州\"},\"roleList\":null}";UserInfo readUserByAnySetter = objectMapper.readValue(jsonAnySetterStr, UserInfo.class);System.out.println(readUserByAnySetter);

这时idCard会被存放到Map中：
在这里插入图片描述

2.14 @JsonAnyGetter

@JsonAnyGetter则用于在序列化时，将Map集合中的内容以对象属性的方式进行输出。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonAnyGetter {boolean enabled() default true;
}

直接将上面@JsonAnySetter反序列化的对象进行序列化时，和之前的JSON内容不一致：

{"collect":{"idCard":"43268825255522222","id":1767798780627279873},"userAge":18,"userSex":"男","mobilePhone":null}

添加@JsonAnyGetter：

    @JsonAnyGetterpublic Map<String, Object> getCollect() {return collect;}

输出结果如下：

{"mobilePhone":null,"idCard":"43268825255522222","id":1767798780627279873}

2.15 @JacksonInject

@JacksonInject标识该属性值不是直接从JSON数据中读取，而是通过注入的方式，根据ObjectMapper的配置或其他机制提供。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JacksonInject {// 逻辑ID，根据该ID从配置或者其他环境中查询对应的值并注入String value() default "";OptBoolean useInput() default OptBoolean.DEFAULT;// 省略........
}

应用场景：

  • 依赖注入：在对象创建时，可能有一些值需要通过外部机制（如Spring框架的依赖注入）提供，而不是从JSON中解析，这时可以使用@JacksonInject来标记这些属性
  • 默认值：有时我们可能希望为某些属性提供默认值，而这些默认值不是从JSON数据中读取的。使用@JacksonInject可以确保在没有从JSON中找到对应值的情况下使用这些默认值。
  • 上下文相关值：当处理与特定上下文相关的数据时，可能需要将某些上下文信息注入到对象中。这些上下文信息可能不是JSON数据的一部分，而是由调用方或应用程序的其他部分提供的

添加@JacksonInject注解：

    @JacksonInject(value = "phone")private String phone;

使用InjectableValues注入默认值：

        // 设置默认值InjectableValues.Std injectableValues = new InjectableValues.Std();injectableValues.addValue("phone","13788889999");objectMapper.setInjectableValues(injectableValues);// 反序列化String jsonInjectStr="{}";UserInject readUserByInject = objectMapper.readValue(jsonInjectStr, UserInject.class);System.out.println(readUserByInject);

输出结果如下：

User{name='null', phone='13788889999'}

2.16 @JsonCreator

@JsonCreator指定反序列化时构造对象实例使用的方法。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonCreator {// 构建者类型Mode mode() default JsonCreator.Mode.DEFAULT;public static enum Mode {DEFAULT,DELEGATING,PROPERTIES,DISABLED;private Mode() {}}
}

添加无参、有参的构造方法：

    public UserInject() {System.out.println("无参构造");}public UserInject(String name, String phone) {this.name = name;this.phone = phone;System.out.println("有参构造");}

进行序列化：

        String jsonCreatorStr="{\"phone\":\"13566666665\",\"name\":\"张三\"}";UserInject readUserByCreator = objectMapper.readValue(jsonCreatorStr, UserInject.class);System.out.println(readUserByCreator);

输出结果中，可以看到默认使用的是无参构造和setter方法：

无参构造
setPhone
setName
User{name='张三', phone='13566666665'}

可以使用 @JsonCreator指定使用的构造函数，使用@JsonProperty指定属性映射关系：

    @JsonCreatorpublic UserInject(@JsonProperty("name") String name, @JsonProperty(value = "phone") String phone)  {this.name = name;this.phone = phone;System.out.println("有参构造");}

输出结果如下：

有参构造
User{name='张三', phone='13566666665'}

2.17 @JsonTypeInfo

@JsonTypeInfo用于多态类型时指定子类类型，以便在反序列化时能够准确地重建原始对象类型。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonTypeInfo {// 定义如何包含类型信息Id use();// 定义类型信息应该在哪里包含As include() default JsonTypeInfo.As.PROPERTY;// 当 use 设置为 Id.AS_PROPERTY 时，这个属性定义了包含类型信息的 JSON 属性的名称String property() default "";// 当无法确定具体的子类型时，使用的默认实现类Class<?> defaultImpl() default JsonTypeInfo.class;// 定义是否传递类型标识符值的属性boolean visible() default false;// 确定在其子类型的多态反序列化过程中是否应严格要求类型IDOptBoolean requireTypeIdForSubtypes() default OptBoolean.DEFAULT;

例如，定义了一个抽象类Person，它有两个类型Student、Teacher，并定义一个返回对象PersonVO定义了属性为Person实例集合：

public abstract class Person {public String name;// getters and setters  
}public class Student extends Person{
}public class Teacher extends Person{
}public class PersonVO {List<Person> personList;// getters and setters  
}

执行序列化和反序列化操作：

        Student student=new Student();student.setName("坤坤童鞋");Teacher teacher=new Teacher();teacher.setName("悠上老师");List<Person> personList=new ArrayList<>();personList.add(student);personList.add(teacher);PersonVO personVO=new PersonVO();personVO.setPersonList(personList);String jsonStrByPerson = objectMapper.writeValueAsString(personVO);System.out.println(jsonStrByPerson);PersonVO readUserByPerson = objectMapper.readValue(jsonStrByPerson, PersonVO.class);System.out.println(readUserByPerson);

反序列化时，直接调用抽象类Person的构造导致报错（应该调用具体的实现类的构造）：

{"personList":[{"name":"坤坤童鞋"},{"name":"悠上老师"}]}
Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Cannot construct instance of `com.pearl.jacksoncore.demo.databind.anno.Person` (no Creators, like default constructor, exist): abstract types either need to be mapped to concrete types, have custom deserializer, or contain additional type informationat [Source: REDACTED (`StreamReadFeature.INCLUDE_SOURCE_IN_LOCATION` disabled); line: 1, column: 16] (through reference chain: com.pearl.jacksoncore.demo.databind.anno.PersonVO["personList"]->java.util.ArrayList[0])

在Person类上添加@JsonTypeInfo，property配置表示使用@class作为类型属性名，JsonTypeInfo.Id.CLASS表示使用全限定类名作为类型值：

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS, include = JsonTypeInfo.As.PROPERTY, property = "@class")
public abstract class Person {}

再次执行，可以看到序列化时，包含了一个对象的Class类型属性键值对，所以在反序列时使用指定类型的构造，正确输出：

{"personList":[{"@class":"com.pearl.jacksoncore.demo.databind.anno.Student","name":"坤坤童鞋"},{"@class":"com.pearl.jacksoncore.demo.databind.anno.Teacher","name":"悠上老师"}]}
com.pearl.jacksoncore.demo.databind.anno.PersonVO@32eff876

2.18 @JsonSubTypes

@JsonSubTypes用于指定用于多态类型时，指定子类的类型标识。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonSubTypes {Type[] value();boolean failOnRepeatedNames() default false;

下方示例中，@JsonTypeInfo表示使用type作为子类类型属性名，使用自定义名称作为子类类型值，@JsonSubTypes指定Student类的名称为stu，Teacher类的名称为stu：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
@JsonSubTypes({@JsonSubTypes.Type(value = Student.class,name = "stu"),@JsonSubTypes.Type(value = Teacher.class,name = "tea")
})
public abstract class Person {//......}

序列化后输出如下：

{"personList":[{"type":"stu","name":"坤坤童鞋"},{"type":"tea","name":"悠上老师"}]}

2.19 @JsonTypeName

@JsonTypeName作用在类上，用于添加当前类的类型标识符，常用于配合@JsonTypeInfo多态类型处理问题。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonTypeName {String value() default "";
}

在Student类上添加注解：

@JsonTypeName("student111111")
public class Student extends Person{//......}

可以看到在序列化后携带了配置的类型标识：

{"personList":[{"student111111":{"name":"坤坤童鞋"}},{"teacher":{"name":"悠上老师"}}]}

2.20 @JsonTypeId

除了使用@JsonTypeName还可以使用@JsonTypeId添加类型标识，可以添加在属性、方法、参数上。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonTypeId {
}

示例代码：

public class Student extends Person{@JsonTypeIdprivate String typeId;// getters and setters     
}public class Student extends Person{@JsonTypeIdprivate String typeId;// getters and setters     
}```java
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.WRAPPER_OBJECT)
@JsonSubTypes({@JsonSubTypes.Type(value = Student.class,name = "sut11111111"),@JsonSubTypes.Type(value = Teacher.class,name = "tea1111111")
})

输出结果：

{"personList":[{"sut11111111":{"name":"坤坤童鞋"}},{"tea1111111":{"name":"悠上老师"}}]}

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/576713.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

新华保险失速？业绩负增长，“欺骗投保人”问题屡罚屡犯

新华保险失速？业绩负增长，“欺骗投保人”问题屡罚屡犯

近日&#xff0c;新华保险&#xff08;601336.SH、01336.HK&#xff09;披露了2023年全年财报。贝多财经发现&#xff0c;该公司营收和利润出现双位数下滑&#xff0c;即便身处寿险市场回暖的大环境下&#xff0c;该公司今年以来的原保险保费收入也处于下跌态势。 即便新华保险…
阅读更多...
Elastic 8.13：Elastic AI 助手中 Amazon Bedrock 的正式发布 (GA) 用于可观测性

Elastic 8.13：Elastic AI 助手中 Amazon Bedrock 的正式发布 (GA) 用于可观测性

作者&#xff1a;来自 Elastic Brian Bergholm 今天&#xff0c;我们很高兴地宣布 Elastic 8.13 的正式发布。 有什么新特性&#xff1f; 8.13 版本的三个最重要的组件包括 Elastic AI 助手中 Amazon Bedrock 支持的正式发布 (general availability - GA)&#xff0c;新的向量…
阅读更多...
免费在线制流程图和思维导图ProcessOn高效协同

免费在线制流程图和思维导图ProcessOn高效协同

免费在线制流程图和思维导图ProcessOn高效协同&#xff0c;还有海量的免费模板。在ProcessOn&#xff0c;你可以与全球超过1.1亿的优秀人才一起合作&#xff0c;共同绘制出精美的流程图和思维导图。无论是工作中的项目管理&#xff0c;还是学习中的知识整理&#xff0c;Process…
阅读更多...
GESP Python编程二级认证真题 2024年3月

GESP Python编程二级认证真题 2024年3月

Python 二级 2024 年 03 月 1 单选题&#xff08;每题 2 分&#xff0c;共 30 分&#xff09; 第 1 题 小杨的父母最近刚刚给他买了一块华为手表&#xff0c;他说手表上跑的是鸿蒙&#xff0c;这个鸿蒙是&#xff1f;&#xff08; &#xff09; A. 小程序 B. 计时器 C. 操作系统…
阅读更多...
动态规划刷题（算法竞赛、蓝桥杯）--导弹拦截（线性DP）

动态规划刷题（算法竞赛、蓝桥杯）--导弹拦截（线性DP）

1、题目链接&#xff1a;[NOIP1999 提高组] 导弹拦截 - 洛谷 #include <bits/stdc.h> using namespace std; const int N2e55; int a[N],x,n; int b[N],len;int main(){while(cin>>x)a[n]x;//求最长不上升子序列 b[0]2e9;//初始化为无穷大for(int i1;i<n;i){if(…
阅读更多...
Immunity(IF=32.4)|空间多组学揭示免疫检查点联合疗法响应机制

Immunity(IF=32.4)|空间多组学揭示免疫检查点联合疗法响应机制

免疫检查点疗法&#xff08;immune checkpoint blockade&#xff0c;ICB&#xff09;已经在肿瘤疾病中得到了广泛应用&#xff0c;但部分患者依然出现低应答甚至不应答的现象。因此开发新型免疫疗法是解决患者低响应的关键。aPD-L1aCTLA4联合治疗是目前研究最广泛的联合疗法之一…
阅读更多...
如何在CentOS使用Docker搭建Rsshub服务并实现无公网IP远程访问

如何在CentOS使用Docker搭建Rsshub服务并实现无公网IP远程访问

文章目录 1. Docker 安装2. Docker 部署Rsshub3. 本地访问Rsshub4. Linux安装Cpolar5. 配置公网地址6. 远程访问Rsshub7. 固定Cpolar公网地址8. 固定地址访问 Rsshub是一个开源、简单易用、易于扩展的RSS生成器&#xff0c;它可以为各种内容生成RSS订阅源。 Rsshub借助于开源社…
阅读更多...
【计算机图形学】3D Implicit Transporter for Temporally Consistent Keypoint Discovery

【计算机图形学】3D Implicit Transporter for Temporally Consistent Keypoint Discovery

对3D Implicit Transporter for Temporally Consistent Keypoint Discovery的简单理解 文章目录 1. 现有方法限制和文章改进2. 方法2.1 寻找时间上一致的3D特征点2.1.1 3D特征Transporter2.1.2 几何隐式解码器2.1.3 损失函数 2.2 使用一致特征点的操纵 1. 现有方法限制和文章改…
阅读更多...
数据库索引及优化

数据库索引及优化

数据库索引及优化 什么是索引&#xff1f; MySQL官方对索引的定义为&#xff1a;索引&#xff08;INDEX&#xff09;是帮助MySQL高效获取数据的数据结构。 索引的本质&#xff1a; 数据结构 为什么要引入索引&#xff1f; 引入索引的目的在于提高查询效率&#xff0c;就好像是…
阅读更多...
fast_bev学习笔记

fast_bev学习笔记

目录 一. 简述二. 输入输出三. github资源四. 复现推理过程4.1 cuda tensorrt 版 一. 简述 原文:Fast-BEV: A Fast and Strong Bird’s-Eye View Perception Baseline FAST BEV是一种高性能、快速推理和部署友好的解决方案&#xff0c;专为自动驾驶车载芯片设计。该框架主要包…
阅读更多...
QT布局管理和空间提升为和空间间隔

QT布局管理和空间提升为和空间间隔

QHBoxLayout&#xff1a;按照水平方向从左到右布局&#xff1b; QVBoxLayout&#xff1a;按照竖直方向从上到下布局&#xff1b; QGridLayout&#xff1a;在一个网格中进行布局&#xff0c;类似于HTML的table&#xff1b; 基本布局管理类包括&#xff1a;QBoxLayout、QGridL…
阅读更多...
平台介绍-搭建赛事运营平台（3）

平台介绍-搭建赛事运营平台（3）

上文介绍了品牌隔离的基本原理&#xff0c;就是通过不同的前端和微服务来实现。但是确实很多功能是类似的&#xff0c;所以从编程角度还是有些管理手段的。 前端部分&#xff1a;前端部分没有什么特别手段&#xff0c;就是两个独立的项目工程&#xff0c;分别维护。相同的部分复…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023