Jackson 2.x 系列【5】注解大全篇一

2024-03-29 06:52
文章标签 系列 注解 jackson 全篇

本文主要是介绍Jackson 2.x 系列【5】注解大全篇一，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

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

本系列Jackson 版本 2.17.0

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

文章目录

    • 1. 前言
    • 2. 注解大全
      • 2.1 @JsonIgnore
      • 2.2 @JsonFormat
      • 2.3 @JsonInclude
      • 2.4 @JsonProperty
      • 2.5 @JsonAlias
      • 2.6 @JsonIgnoreType
      • 2.7 @JsonIgnoreProperties
      • 2.8 @JsonPropertyOrder
      • 2.9 @JsonGetter
      • 2.10 @JsonSetter

1. 前言

在前几篇文档中，我们学习了Jackson中几个非常重要的类，并实现了一些简单的JSON数据转换功能。在实际开发中，可能会遇到的一些个性化要求的场景，而不是简单的一些直接转换，例如，对于null值字段、敏感字段不进行序列化；Long类型的字段需要序列化为String类型（不然返回给前端时会丢失精度）…

Jackson提供了两种方式来满足个性化场景，以定制序列化/反序列化行为：

  • 配置注解：Jackson提供了很多注解，用于标识Java Bean类、方法、构造器、属性
  • 配置特性枚举：Jackson提供了很多xxxFeature枚举类，在读写对象中进行设置

⛹⛹⛹接下来我们了解下Jackson提供的所有注解，按照它们的使用频率顺序进行讲解。⛹⛹⛹

2. 注解大全

Jackson中的大部分注解都在jackson-annotations模块中，位于com.fasterxml.jackson.annotation包下，在jackson-databind模块中也提供了一些注解。

2.1 @JsonIgnore

@JsonIgnore标识序列化/反序列化时是否忽略该字段。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonIgnore {// 是否忽略，默认trueboolean value() default true;
}

在UserInfo类的id属性添加 @JsonIgnore：

public class UserInfo{@JsonIgnore// 用户IDprivate Long id;// 省略其他......
}

进行转换：

        ObjectMapper objectMapper = new ObjectMapper();// POJO -> JSONUserInfo user = new UserInfo();user.setId(1767798780627279333L);user.setName("老三");user.setAge(25);String json = objectMapper.writeValueAsString(user);System.out.println(json);// JSON -> POJOString userJson="{\"id\":1767798780627279873,\"name\":\"坤坤\",\"age\":18,\"org\":null,\"roleList\":null}";UserInfo readUserByJson = objectMapper.readValue(userJson, UserInfo.class);System.out.println(readUserByJson);

可以看到id字段被忽略了：

{"name":"老三","age":25,"org":null,"roleList":null}
UserInfo{id=null, name='坤坤', age=18, org=null, roleList=null}

2.2 @JsonFormat

@JsonFormat标识使用格式模板进行序列化/反序列化。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonFormat {// 默认的 Locale，java.util.Locale#getDefault()String DEFAULT_LOCALE = "##default";// 默认的 时区，来自于  java.util.TimeZoneString DEFAULT_TIMEZONE = "##default";// 格式模板String pattern() default "";// 指定序列化后的类型Shape shape() default JsonFormat.Shape.ANY;// Java Locale String locale() default "##default";// 时区String timezone() default "##default";// 是否启用“宽松”处理OptBoolean lenient() default OptBoolean.DEFAULT;// 开启某些特性Feature[] with() default {};// 关闭某些特征Feature[] without() default {};// 省略其他......
}

在UserInfo类的birthdayDate属性添加 @JsonFormat注解：

    @JsonFormat(shape= JsonFormat.Shape.STRING, pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")private Date birthdayDate;

序列化/反序列化结果：

{"id":1767798780627279333,"birthdayDate":"2024-03-21 09:40:33","birthdayLocalDateTime":null,"name":"老三","age":25,"org":null,"roleList":null}
UserInfo{id=1767798780627279333, birthdayDate=Thu Mar 21 09:40:33 CST 2024, birthdayLocalDateTime=null, name='老三', age=25, org=null, roleList=null}

在UserInfo类的birthdayLocalDateTime属性添加 @JsonFormat注解：

    @JsonFormat(shape= JsonFormat.Shape.STRING, pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")private LocalDateTime birthdayLocalDateTime;

这时会报错InvalidDefinitionException，不支持java.time.LocalDateTime：

Exception in thread "main" com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Java 8 date/time type `java.time.LocalDateTime` not supported by default: add Module "com.fasterxml.jackson.datatype:jackson-datatype-jsr310" to enable handling (through reference chain: com.pearl.jacksoncore.demo.databind.anno.UserInfo["birthdayLocalDateTime"])

LocalDateTime是Java 8中JSR 310规范下新的日期时间API，Jackson核心模块并没有实现支持，需要引入jackson-datatype-jsr310模块：

        <dependency><groupId>com.fasterxml.jackson.datatype</groupId><artifactId>jackson-datatype-jsr310</artifactId><version>2.17.0</version></dependency>

并指定序列化/反序列化器：

    @JsonDeserialize(using = LocalDateTimeDeserializer.class)@JsonSerialize(using = LocalDateTimeSerializer.class)@JsonFormat(shape= JsonFormat.Shape.STRING, pattern="yyyy-MM-dd HH:mm:ss",timezone = "GMT+8")private LocalDateTime birthdayLocalDateTime;

再次运行，结果如下：

{"id":1767798780627279333,"birthdayDate":"2024-03-21 09:47:59","birthdayLocalDateTime":"2024-03-21 09:47:59","name":"老三","age":25,"org":null,"roleList":null}
UserInfo{id=1767798780627279333, birthdayDate=Thu Mar 21 09:47:59 CST 2024, birthdayLocalDateTime=2024-03-21T09:47:59, name='老三', age=25, org=null, roleList=null}

2.3 @JsonInclude

@JsonFormat标识符合指定规格时才进行序列化。

@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.TYPE, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonInclude {//   规则：//   ALWAYS, 总是序列化//   NON_NULL, 不为NULL才序列化//   NON_ABSENT, NON_NULL的基础上，支持 Optional//   NON_EMPTY,  NON_ABSENT的基础上，支持集合、String//   NON_DEFAULT, 不是默认值才序列化//   CUSTOM, 自定义//   USE_DEFAULTS; 默认//  作用于类、属性Include value() default JsonInclude.Include.ALWAYS;// 作用于 Map、AtomicReference等Include content() default JsonInclude.Include.ALWAYS;// 自定义规则需要实现的过滤器Class<?> valueFilter() default Void.class;// 自定义规则需要实现的过滤器Class<?> contentFilter() default Void.class;

在UserInfo类的birthdayDate属性添加 @JsonFormat注解，配置规则为NON_NULL时才进行序列化：

    @JsonInclude(JsonInclude.Include.NON_NULL)private String name;

运行结果如下：

        user.setName(null);String JsonIncludeJson = objectMapper.writeValueAsString(user);System.out.println(JsonIncludeJson);// {"birthdayDate":"2024-03-21 11:00:23","birthdayLocalDateTime":"2024-03-21 11:00:23","age":25,"org":null,"roleList":null}

2.4 @JsonProperty

@JsonProperty用于在序列化/反序列化时进行重命名。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonProperty {String USE_DEFAULT_NAME = "";int INDEX_UNKNOWN = -1;// 重命名后的属性名称String value() default "";String namespace() default "";boolean required() default false;// 索引位置int index() default -1;String defaultValue() default "";// 可见性配置 可以控制只在序列化或者只反序列化时生效Access access() default JsonProperty.Access.AUTO;public static enum Access {// 自动确定对此属性的读/或访问权限AUTO,// 只读READ_ONLY,// 只写WRITE_ONLY,// 可读写READ_WRITE;}
}

在UserInfo类的age属性添加 @JsonProperty注解：

    @JsonProperty(value = "userAge")private Integer age;

序列化后结果：

{"userAge":25,"birthdayDate":"2024-03-21 11:43:25","birthdayLocalDateTime":"2024-03-21 11:43:25","org":null,"roleList":null}

2.5 @JsonAlias

@JsonAlias用于在反序列化时进行重命名。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonAlias {String[] value() default {};
}

例如JSON中属性名称为username，UserInfo类中的属性名称为name，则可以使用@JsonAlias指定反序列化时的别名：

    @JsonAlias("username")private String name;

示例如下：

        String userAliasJson="{\"id\":1767798780627279873,\"username\":\"坤坤\",\"userAge\":18,\"org\":null,\"roleList\":null}";UserInfo readUserByAliasJson = objectMapper.readValue(userAliasJson, UserInfo.class);System.out.println(readUserByAliasJson);// UserInfo{id=null, birthdayDate=null, birthdayLocalDateTime=null, name='坤坤', age=18, org=null, roleList=null}

2.6 @JsonIgnoreType

@JsonIgnoreType作用于类，当该类作为对象属性在序列化/反序列化时会被忽略。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonIgnoreType {// 是否忽略，默认 tureboolean value() default true;
}

例如我们在Org类中添加该注解：

@JsonIgnoreType
public class Org {// 省略.....}

执行反序列化：

        // 6. @JsonIgnoreTypeString userJsonIgnoreTypeStr="{\"id\":1767798780627279873,\"username\":\"坤坤\",\"userAge\":18,\"org\":{\"id\":1699967647585800192,\"orgName\":\"阿里巴巴\",\"address\":\"浙江杭州\"},\"roleList\":null}";UserInfo readUserByJsonIgnoreType = objectMapper.readValue(userJsonIgnoreTypeStr, UserInfo.class);System.out.println(readUserByJsonIgnoreType);

虽然JSON内容包含了Org对象，但是被忽略掉了：

UserInfo{id=null, birthdayDate=null, birthdayLocalDateTime=null, name='坤坤', age=18, org=null, roleList=null}

2.7 @JsonIgnoreProperties

@JsonIgnoreProperties用于在序列化/反序列化时忽略某个字段属性，比@JsonIgnore功能更强，可以作用于类，配置多个忽略属性。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonIgnoreProperties {// 忽略的多个属性名称String[] value() default {};// 是否忽略不能识别的属性boolean ignoreUnknown() default false;// 是否允许访问属性的Getter方法，即支持Getter进行序列化boolean allowGetters() default false;// 是否允许访问属性的Setters方法，即支持Setters进行反序列化boolean allowSetters() default false;
}

Org类上标识忽略id、orgName属性：

@JsonIgnoreProperties({"orgName","id"})
public class Org {// 省略.....}

案例演示，当前JSON包含了id、orgName属性：

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

反序列化时id、orgName属性被忽略：

UserInfo{id=null, birthdayDate=null, birthdayLocalDateTime=null, name='坤坤', age=18, org=Org{id=null, orgName='null', address='浙江杭州'}, roleList=null}

之外还支持allowGetters 配置可以进行序列化，但反序列化时被忽略（allowSetters同理）：

@JsonIgnoreProperties( value = "password",allowGetters = true)

2.8 @JsonPropertyOrder

@JsonPropertyOrder用于在序列化时进行排序。

@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonPropertyOrder {// 指定顺序String[] value() default {};// 是否按照字母表排序boolean alphabetic() default false;
}

示例代码：

@JsonPropertyOrder({"org","roleList","birthdayDate","id"})

输出结果：

{"org":null,"roleList":null,"birthdayDate":"2024-03-21 14:44:49","birthdayLocalDateTime":"2024-03-21 14:44:49","password":null,"userAge":25}

2.9 @JsonGetter

@JsonGetter和@JsonProperty功能类似用于重命名，官方提示使用其替代方案@JsonProperty。

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

示例代码：

    @JsonGetter("userSex")public String getSex() {return sex;}

可以看到在序列化/反序列化时都会生效，一般使用@JsonProperty即可：

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

2.10 @JsonSetter

@JsonSetter和@JsonProperty功能类似用于重命名，官方提示使用其替代方案@JsonProperty。

@Target({ElementType.ANNOTATION_TYPE, ElementType.FIELD, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@JacksonAnnotation
public @interface JsonSetter {String value() default "";Nulls nulls() default Nulls.DEFAULT;Nulls contentNulls() default Nulls.DEFAULT;

示例代码：

    @JsonSetter("mobilePhone")public void setPhone(String phone) {this.phone = phone;}

可以看到在序列化/反序列化时都会生效：

        user.setPhone("13899996666");String jsonSettersStr = objectMapper.writeValueAsString(user);System.out.println(jsonSettersStr);String jsonSetterStr="{\"mobilePhone\":\"13899996666\",\"userSex\":\"男\",\"id\":1767798780627279873,\"username\":\"坤坤\",\"userAge\":18,\"org\":{\"id\":1699967647585800192,\"orgName\":\"阿里巴巴\",\"address\":\"浙江杭州\"},\"roleList\":null}";UserInfo readUserByJsoSetter = objectMapper.readValue(jsonSetterStr, UserInfo.class);System.out.println(readUserByJsoSetter);

这篇关于Jackson 2.x 系列【5】注解大全篇一的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/857904。

相关文章

mapstruct中的@Mapper注解的基本用法

mapstruct中的@Mapper注解的基本用法

《mapstruct中的@Mapper注解的基本用法》在MapStruct中,@Mapper注解是核心注解之一,用于标记一个接口或抽象类为MapStruct的映射器（Mapper）,本文给大家介绍ma... 目录1. 基本用法2. 常用属性3. 高级用法4. 注意事项5. 总结6. 编译异常处理在MapSt
阅读更多...
Spring @RequestMapping 注解及使用技巧详解

Spring @RequestMapping 注解及使用技巧详解

《Spring@RequestMapping注解及使用技巧详解》@RequestMapping是SpringMVC中定义请求映射规则的核心注解,用于将HTTP请求映射到Controller处理方法... 目录一、核心作用二、关键参数说明三、快捷组合注解四、动态路径参数（@PathVariable）五、匹配请
阅读更多...
SpringCloud中的@FeignClient注解使用详解

SpringCloud中的@FeignClient注解使用详解

《SpringCloud中的@FeignClient注解使用详解》在SpringCloud中使用Feign进行服务间的调用时,通常会使用@FeignClient注解来标记Feign客户端接口,这篇文章... 在Spring Cloud中使用Feign进行服务间的调用时，通常会使用@FeignClient注解
阅读更多...
Java 关键字transient与注解@Transient的区别用途解析

Java 关键字transient与注解@Transient的区别用途解析

《Java关键字transient与注解@Transient的区别用途解析》在Java中,transient是一个关键字,用于声明一个字段不会被序列化,这篇文章给大家介绍了Java关键字transi... 在Java中，transient 是一个关键字，用于声明一个字段不会被序列化。当一个对象被序列化时，被
阅读更多...
Spring Cache注解@Cacheable的九个属性详解

Spring Cache注解@Cacheable的九个属性详解

《SpringCache注解@Cacheable的九个属性详解》在@Cacheable注解的使用中,共有9个属性供我们来使用,这9个属性分别是：value、cacheNames、key、key... 目录1.value/cacheNames 属性2.key属性3.keyGeneratjavascriptor
阅读更多...
使用@Cacheable注解Redis时Redis宕机或其他原因连不上继续调用原方法的解决方案

使用@Cacheable注解Redis时Redis宕机或其他原因连不上继续调用原方法的解决方案

《使用@Cacheable注解Redis时Redis宕机或其他原因连不上继续调用原方法的解决方案》在SpringBoot应用中,我们经常使用​​@Cacheable​​注解来缓存数据,以提高应用的性能... 目录@Cacheable注解Redis时，Redis宕机或其他原因连不上，继续调用原方法的解决方案1
阅读更多...
Spring Boot 常用注解整理(最全收藏版)

Spring Boot 常用注解整理(最全收藏版)

《SpringBoot常用注解整理(最全收藏版)》本文系统整理了常用的Spring/SpringBoot注解,按照功能分类进行介绍,每个注解都会涵盖其含义、提供来源、应用场景以及代码示例,帮助开发... 目录Spring & Spring Boot 常用注解整理一、Spring Boot 核心注解二、Spr
阅读更多...
Java Jackson核心注解使用详解

Java Jackson核心注解使用详解

《JavaJackson核心注解使用详解》：本文主要介绍JavaJackson核心注解的使用,​​Jackson核心注解​​用于控制Java对象与JSON之间的序列化、反序列化行为,简化字段映射... 目录前言一、@jsonProperty-指定JSON字段名二、@JsonIgnore-忽略字段三、@Jso
阅读更多...
Spring Boot 常用注解详解与使用最佳实践建议

Spring Boot 常用注解详解与使用最佳实践建议

《SpringBoot常用注解详解与使用最佳实践建议》：本文主要介绍SpringBoot常用注解详解与使用最佳实践建议,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要... 目录一、核心启动注解1. @SpringBootApplication2. @EnableAutoConfi
阅读更多...
Java注解之超越Javadoc的元数据利器详解

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解？注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2