Jackson 常用注解

最新推荐文章于 2023-12-28 07:45:00 发布
最新推荐文章于 2023-12-28 07:45:00 发布
阅读量981 收藏 4
点赞数 1
文章标签： java gson aop ehcache 分布式存储
原文链接：https://mp.weixin.qq.com/s?__biz=MzA4MTk3MjI0Mw==&mid=2247496583&idx=1&sn=3d35921bb9558135c1c4697b88253d4d&chksm=9f8e6efba8f9e7edfb6978549af78c9fe7193c311bb2cee1cc466272e290e7692ee1ac4cb544&scene=126&&sessionid=0
版权

@JacksonInject

通过 @JacksonInject 注解可以在 Jackson 反序列化的时候为空值字段动态赋值，当反序列化的对应属性值不存在时，可通过该注解为其动态设置值。

@Getter
@Setter
public class User {


    @JacksonInject(value = "dynamic")
    private String name;

    private Integer age;
}

对其进行反序列化：

public class JacksonInjectTest {


    private static final ObjectMapper MAPPER = new ObjectMapper();

    public static void main(String[] args) throws JsonProcessingException {
        // 名称和注解中声明的相同才行
        InjectableValues.Std injectableValues = new InjectableValues.Std()
                .addValue("dynamic", "some dynamic value");
        MAPPER.setInjectableValues(injectableValues);
        // 反序列化空对象
        User u = MAPPER.readValue("{}", User.class);
        System.out.println(u.getName());
    }

}
// 输出结果：some dynamic value

@JsonAlias

通过 @JsonAlias 注解可以为对象属性定义一个或多个别名，然后在反序列化时根据别名进行属性映射。但要注意，别名不能与其他属性名冲突，否则反序列化时会抛异常。

@Getter
@Setter
public class User {

@JsonAlias(value = "nm")
private String name;

private Integer age;

}

对其进行反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User u = MAPPER.readValue("{\"nm\":\"张三\"}", User.class);
    System.out.println(u.getName());
}
// 输出结果：张三

@JsonAnyGetter、@JsonAnySetter

@JsonAnyGetter 注解可用于将一组键值对平铺展开到常规属性中，比如某个对象正常序列化的结果为：

{
  "name": "张三",
  "info": {
    "address": "china",
    "age": "25"
  }
}

通过该注解修饰后，序列化后的结果为：

{
  "name": "张三",
  "address": "china",
  "age": "25"
}

不过这个注解的使用也是有条件限制的：

  • 被修饰的方法不能是静态方法

  • 被修饰的方法必须是无参方法

  • 被修饰的方法返回值必须是 Map 类型

  • 同一实体中只能有一个方法使用该注解

具体如下例所示：

@Getter
@Setter
public class User {

    private String name;

    private Map<String, String> info;

    @JsonAnyGetter
    public Map<String, String> getInfo() {
        return info;
    }
}

对该对象进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    Map<String, String> info = new HashMap<>();
    info.put("age", "25");
    info.put("address", "china");
    User user = new User();
    user.setName("张三");
    user.setInfo(info);
    System.out.println(MAPPER.writeValueAsString(user));
}
// 输出结果：{"name":"张三","address":"china","age":"25"}

@JsonAnySetter

 注解的功能与 @JsonAnyGetter 正好相反，使用示例如下：

@Getter
@Setter
public class User {

     private String name;


    
     private String address;

     private String age;

    @JsonAnySetter
    public void setInfo(Map<String, String> info) {
        this.address = info.get("address");
        this.age = info.get("age");
    }

}

对其进行反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = MAPPER.readValue("{\"name\":\"张三\",\"info\":{\"address\":\"china\",\"age\":\"25\"}}", User.class);
    System.out.println(user.getAddress());
}
// 输出结果：china

@JsonAutoDetect

@JsonAutoDetect 注解可以用于强制序列化私有属性，即使没有提供 Getter 方法：

@Setter
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY)
public class User {


    private String name;


    private String age;

}

我们没有为 User 提供 Getter 方法，对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    user.setAge("25");
    System.out.println(MAPPER.writeValueAsString(user));

}
// 输出结果：{"name":"张三","age":"25"}

@JsonBackReference、@JsonManagedReference

@JsonManagedReference 注解和 @JsonBackReference 注解用于处理父子关系并解决对象间的循环引用，比如两个类互相持有对方的场景：

@Getter
@Setter
public class User {

    private String name;
    


    @JsonManagedReference
     private Friend friend;

}

@Getter
@Setter
public class Friend {


private String number;

    @JsonBackReference
    private User user;

}

对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    Friend friend = new Friend();
    friend.setNumber("001");
    friend.setUser(user);
    user.setFriend(friend);
    System.out.println(MAPPER.writeValueAsString(user));
}
// 输出结果：{"name":"张三","friend":{"number":"001"}}

@JsonCreator

Jackson 在反序列化时默认会通过对象的无参构造方法创建对象，如果想要通过自定义的构造方法创建对象，需要通过 @JsonCreator 来指定构造方法，并通过 @JsonProperty 设置构造方法中参数对应的 JSON 属性名：

@Getter
public class User {

private final String name;


    private final String age;

    @JsonCreator
    public User(@JsonProperty("name") String name, @JsonProperty("age") String age)
        this.name = name;
        this.age = age;
    }
}

反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = MAPPER.readValue("{\"name\":\"张三\",\"age\":\"25\"}", User.class);
    System.out.println(user.getName());
}

// 输出结果：张三

@JsonEnumDefaultValue

反序列化时，如果对应的枚举值不存在 Jackson 默认会抛出异常。我们可以通过 @JsonEnumDefaultValue 注解为未知的枚举类型赋一个默认值来兜底，但要记得在 ObjectMapper 中手动开启该功能。

@Setter
@Getter
public static class User {
    private String name;
    private Sex sex;
}

private enum Sex {
    MAN,
    WOMAN,
    @JsonEnumDefaultValue
    UNKNOWN
}

反序列化：

public static void main(String[] args) throws JsonProcessingException {
    MAPPER.enable(DeserializationFeature.READ_UNKNOWN_ENUM_VALUES_USING_DEFAULT_VALUE);
    User user = MAPPER.readValue("{\"name\":\"张三\",\"sex\":\"NONE\"}", User.class);
    System.out.println(user.getSex());
}
// 输出结果：UNKNOWN

@JsonFormat

默认序列化会将 Date 类型解析成时间戳，如果是 Java 8 提供的 LocalDateTime 则默认不支持序列化，需要额外注册 Module 支持，可以通过 @JsonFormat 注解在序列化过程中对数据进行格式化输出：

格式化时间（只支持 Date 类型）：

@Setter
@Getter
public static class User {

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

}
// 序列化输出：{"birthday":"2021-09-06 21:13:42"}

格式化枚举类型（默认只输出枚举名称，如果有枚举属性会忽略）：



@Getter
@JsonFormat(shape = JsonFormat.Shape.OBJECT)
public enum Sex {
    MAN(1, "男生"),
    WOMAN(2, "女生");

    private final Integer code;

    private final String description;

    Sex(Integer code, String description) {
        this.code = code;
        this.description = description;
    }

}
// 序列化输出：{"sex":{"code":1,"description":"男生"}}

@JsonGetter、@JsonSetter

@JsonGetter、@JsonSetter 注解用于在序列化和反序列化时指定属性的 Getter 和 Setter 方法。特别针对有些不正规的方法：

public class User {

    private String name;

    @JsonGetter("name")
    public String returnName() {
        return name;
    }

    @JsonSetter("name")
    public void putName(String name) {
        this.name = name;
    }

}

User 类没有提供标准的 Setter、Getter 方法，对其进行序列化和反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.putName("张三");
    System.out.print(MAPPER.writeValueAsString(user));
    User userD = MAPPER.readValue("{\"name\":\"张三\"}", User.class);
    System.out.print(userD.returnName());
}
// 输出结果：{"name":"张三"}张三

@JsonIdentityInfo

@JsonIdentityInfo 注解作用于类或属性上，在序列化、反序列化时可以为该对象或字段添加一个对象识别码，比如 @id 或者 Class 对象名，主要用于解决字段循环嵌套的问题。

@Getter
@Setter
public class User {


private String name;


    @JsonIdentityInfo(generator = ObjectIdGenerators.UUIDGenerator.class)
     private User friend;

}

循环嵌套后进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User userA = new User();
    userA.setName("张三");
    User userB = new User();
    userB.setName("李四");
    // 循环引用
    userA.setFriend(userB);
    userB.setFriend(userA);
    System.out.println(MAPPER.writeValueAsString(userA));
}
// 输出结果：
{
  "name": "张三",
  "friend": {
    "@id": "5eba3199-ed97-4642-81b8-ad7b61ed9fd8",
    "name": "李四",
    "friend": {
      "@id": "fddcb9fa-c934-4735-8fec-2923675976cc",
      "name": "张三",
      "friend": "5eba3199-ed97-4642-81b8-ad7b61ed9fd8"
    }
  }
}

@JsonIgnore

@JsonIgnore 也是常用的一个注解，在序列化、反序列化时会忽略被该注解标记的属性。

@Getter
@Setter
public class User {

    @JsonIgnore
    private String name;

    private String age;

}

对其进行序列化和反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    user.setAge("25");
    System.out.print(MAPPER.writeValueAsString(user));
    User userD = MAPPER.readValue("{\"name\":\"张三\",\"age\":\"25\"}", User.class);
    System.out.print(userD.getName());
}
// 输出结果：{"age":"25"}null

@JsonIgnoreProperties

@JsonIgnoreProperties 注解可以在序列化、反序列化时忽略多个属性，通常标记在类上。

@Getter
@Setter
@JsonIgnoreProperties({"name", "age"})
public class User {

     private String name;

     private String age;

     private String sex;

}
// 序列化结果：{"sex":"男"}

如果有些属性不太确定也可以通过该注解过滤掉，避免未知属性异常：

@JsonIgnoreProperties(ignoreUnknown = true)

此外，还提供了 allowGetters、allowSetters 属性用于仅忽略 Setter 或 Getter：

@JsonIgnoreProperties(allowGetters = true, allowSetters = true)

@JsonIgnoreType

@JsonIgnoreType 注解用于在序列化、反序列化时忽略掉某种特定类型，作用在类上，引用这个类的其他对象在序列化、反序列化时会忽略这个类，主要用来对一些数据敏感对象进行忽略。

@Getter
@Setter
public class User {

   private String name;

   private Hobby hobby;


}

@Getter
@Setter
@JsonIgnoreType
public class Hobby {

    private String item;

}

对其进行序列化、反序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    Hobby hobby = new Hobby();
    hobby.setItem("basketball");
    user.setHobby(hobby);
    System.out.print(MAPPER.writeValueAsString(user));
    User userD = MAPPER.readValue("{\"name\":\"张三\",\"hobby\":{\"item\":\"basketball\"}}", User.class);
    System.out.print(userD.getHobby() == null);
}
// 输出结果：{"name":"张三"}true

@JsonInclude

@JsonInclude 注解用于标识对象属性何时可以被序列化，可以把该注解标记在属性字段上，也可以通过 ObjectMapper 的 setSerializationInclusion 方法进行统一设置。Jackson 默认会把空值字段序列化为 null，我们可以通过 JsonInclude.Include.NON_NULL 来过滤掉空值字段：

@Getter
@Setter
public class User {

    private String name;

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

}

对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    System.out.println(MAPPER.writeValueAsString(user));
}
// 输出结果：{"name":"张三"}

@JsonIncludeProperties

@JsonIncludeProperties 注解与 @JsonIgnoreProperties 注解正好相反，它只会在序列化、反序列化包含在注解中的属性，其它属性都不参与序列化和反序列化。

@Getter
@Setter
@JsonIncludeProperties({"name", "age"})
public class User {


     private String name;

     private String age;
    


     private String sex;

}

对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    user.setAge("25");
    user.setSex("男");
    System.out.println(MAPPER.writeValueAsString(user));
}
// 输出结果：{"name":"张三","age":"25"}

@JsonProperty

@JsonProperty 也是常用注解，它包含了很多其他注解的功能，因此最好不要与功能重复的注解同时使用，以免产生干扰。该注解通常标记在属性或属性的 Getter、Setter 方法上，功能如下：

可以在反序列化时指定属性的名称，类似 @JsonAlias 的效果。

@Getter
@Setter
public class User {

    @JsonProperty("nm")
    private String name;

    private String age;

}
// 反序列化时可以将nm对应的值赋值到name字段上

通过 Access 枚举可以控制哪些属性可以进行序列化、反序列化，类似 @JsonIgnore 的效果。

@Getter
@Setter
public class User {

    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
    private String name;


    
    private String age;

}
// 因为name属性被设置为只读，所以反序列化时会忽略name属性

@JsonRawValue

@JsonRawValue 注解会将字符串形式的 JSON 也尝试序列化为对象，示例如下：


@Getter
@Setter
public class User {


    private String name;

    @JsonRawValue
    private String json;

}

对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    user.setJson("{\"age\":\"25\"}");
    System.out.println(MAPPER.writeValueAsString(user));
}
// 输出结果：
{
  "name": "张三",
  "json": {
    "age": "25"
  }
}
// 如果没有该注解修饰则输出：
{
  "name": "张三",
  "json": "{\"age\":\"25\"}"
}

@JsonUnwrapped

@JsonUnwrapped 注解可以在序列化时把一个对象中嵌套对象的属性平铺展开，放到同一层级：

@Getter
@Setter
public static class User {

     private String name;

    @JsonUnwrapped
    private Identity identity;

}

@Getter
@Setter
public static class Identity {

    private String age;

    private String address;

}

对其进行序列化：

public static void main(String[] args) throws JsonProcessingException {

    User user = new User();

    user.setName("张三");

    Identity identity = new Identity();

    identity.setAge("25");

    identity.setAddress("china");

    user.setIdentity(identity);

    System.out.println(MAPPER.writeValueAsString(user));

}
// 输出结果：{"name":"张三","age":"25","address":"china"}

@JsonFilter

@JsonFilter 注解用于指定在序列化期间要使用的过滤器：

@Getter
@Setter
@JsonFilter("customFilter")
public static class User {


private String name;

    private String age;

     private String cardCode;


     
     private String address;

}

我们对 User 对象进行序列化：

public static void main(String[] args) throws JsonProcessingException {
    SimpleBeanPropertyFilter propertyFilter = SimpleBeanPropertyFilter.filterOutAllExcept("cardCode", "address");
    FilterProvider provider = new SimpleFilterProvider().addFilter("customFilter", propertyFilter);
    User user = new User();
    user.setName("张三");
    user.setAge("25");
    user.setAddress("china");
    user.setCardCode("123456");
    System.out.println(MAPPER.writer(provider).writeValueAsString(user));
}
// 输出结果：{"cardCode":"123456","address":"china"}

@JsonAppend

@JsonAppend 注解可以在序列化时额外添加指定的属性：

@Getter
@Setter
@JsonAppend(attrs = {
    @JsonAppend.Attr(value = "version")
    })
public class User {


     private String name;

     private String age;

}

我们可以在序列化时手动增加 version=1.0 的属性值：

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setName("张三");
    user.setAge("25");
    String str = MAPPER.writerFor(User.class).withAttribute("version", "1.0").writeValueAsString(user);
    System.out.println(str);
}
// 输出结果：{"name":"张三","age":"25","version":"1.0"}

记得点「赞」和「在看」↓

爱你们

BUG弄潮儿
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
boot:常用的工具或者服务
04-08
boot模块boot-parent项目依赖管理boot-dependenciesboot模块管理，其他项目可以导入pom使用boot-annotation常用的自定义注解，比如@Id,@Table等boot-util常用工具类，比如集合工具，Jackson工具类，日期工具类等boot...
jackson常用注解
永不停歇的人
07-07 4801
1、@JsonAutoDetect 自动检测，（作用在类上）来开启/禁止自动检测。 fieldVisibility:字段的可见级别 ANY:任何级别的字段都可以自动识别 NONE:所有字段都不可以自动识别 NON_PRIVATE:非private修饰的字段可以自动识别 PROTECTED_AND_PUBLIC:被protected和public修饰的字段可以被自动识别 PUBLIC_ONLY:只有被public修饰的字段才可以被自动识别 DEFAULT: ...
Jackson注解大全，你都学会了吗？
IT学习社
07-21 2298
Jackson常用注解 序列化注解 @JsonAnyGetter 像普通属性一样序列化Map public class ExtendableBean { public String name; private Map<String, String> properties; @JsonAnyGetter public Map<String, String> getProperties() { return properties;
Jackson别名@JsonAlias详细用法
https://oldmoon.top
08-31 5076
Jackson别名@JsonAlias详细用法
@JsonIdentityInfo 处理循环引用
赵丙双的博客
05-25 2134
@JsonIdentityInfo 用于处理对象的循环引用，方法是只在第一次遇到时序列化为完整的对象，之后再遇到同一个对象，都以对象的标识符代替。 生成对象标识符有两种主要方法:使用生成器(标准生成器或自定义生成器之一)，或者使用属性的值。后一种情况是通过使用占位符生成器标记ObjectIdGenerators.PropertyGenerator来指示的;前者使用显式生成器。对象id必须序列化为pojo的属性;对象标识目前不支持JSON数组类型(Java数组或列表)或Java Map类型。 @JsonIde
Java中jackson常用注解
最新发布
时代各有不同，青春一脉相承。
12-28 537
Java中jackson常用注解 @JsonProperty - 字段命名 @JsonPropertyOrder - 字段序列化顺序 @JsonAlias - 字段别名，反序列化 @JsonIgnore -序列化时忽略字段 @JsonIgnoreProperties - 序列化时忽略某些字段 @JsonInclude - 序列化时作用于满足条件的 @JsonFormat - 设置格式，如日期时间等 @JacksonInject - 反序列化时注入到java对象
Ajax&Json&XML.html
02-04
Ajax&Json&XML常用基本操作 JSON数据和Java对象的相互转换 常见的解析器：Jsonlib，Gson，fastjson，jackson JSON转为Java对象 1. 导入jackson的相关jar包 2. 创建Jackson核心对象 ObjectMapper 3.调用...
maven-jaxb2-plugin-0.14.0.jar
02-18
JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations)，既方便生成XML，也方便生成JSON，这样一来可以更好的标志可以转换为JSON对象的JAVA类。JAXB允许JAVA人员将JAVA类映射为XML表示方式，...
jaxb-api-2.2.jar.zip
02-18
JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations)，既方便生成XML，也方便生成JSON，这样一来可以更好的标志可以转换为JSON对象的JAVA类。JAXB允许JAVA人员将JAVA类映射为XML表示方式，...
jaxb-libs.jar.zip
02-18
JAXB能够使用Jackson对JAXB注解的支持实现(jackson-module-jaxb-annotations)，既方便生成XML，也方便生成JSON，这样一来可以更好的标志可以转换为JSON对象的JAVA类。JAXB允许JAVA人员将JAVA类映射为XML表示方式，...
Jackson 注解及配置大全
weixin_45817985的博客
12-20 187
Jackson 注解及配置大全
Jackson常用注解学习
Mosqiote的博客
05-09 573
读写注解 @JsonProperty(value = "***") 属性使用的注解，用来表示外部属性名字，就时使用别名序列化，而不是对象的属性名 public class Student { private int id; @JsonProperty("s_name") private String name; private int age; ...
Jackson之注解大全
热门推荐
blwinner的专栏
08-19 1万+
Jackson简介
jackSon中@JacksonInject 注解详解
weixin_44130081的博客
04-29 3602
jackSon中@JacksonInject 注解详解 前言 假设json字段有一些缺少的属性，抓换成实体类的时候没有的属性将为null,但是我们在某些需求当中需要将为null的属性都设置为默认值，这时候我们就可以用到这个注解了，它的功能就是在反序列化的时候将没有的字段设置为我们设置好的默认值，下面就看下他的用法吧。 @JacksonInject用法 //value 相当于id,之后会用到， //...
将java对象转换为json格式，然后将json转化为java对象遇到的问题
m0_61849361的博客
05-09 2057
将java对象转换为json格式，然后将json转化为java对象遇到的问题
Json字符串转对象，使用ObjectMapper方式报错：no String-argument constructor/factory method
卉卉的博客
12-27 1万+
今天实训，springboot接受vue axios传来的json字符串对象，想将其转换为Java POJO对象，使用ObjectMapper方式如下： @RequestMapping(value = "/insertSong", method = RequestMethod.POST) public String insertSong(@RequestBody String songStr) throws JsonProcessingException { ObjectMa
Jackson常用注解介绍
夜黑博客
04-21 6023
1 排除属性 @JsonIgnore，一般标记在属性或方法上；作用于序列化与反序列化； @JsonIgnoreProperties，如果是代理类，由于无法标记在属性或方法上，所以，可以标记在类声明上；也作用于反序列化时的字段解析； 有时POJO包括了一些你不希望输出的属性，在这种情况下，你可以进行如下操作： public class Value { public int value
json学习
li11261221的博客
12-07 827
1.什么是JSON？ JSON(JavaScript Object Notation, JS 对象标记) 是一种轻量级的数据交换格式，目前使用特别广泛。 采用完全独立于编程语言的 文本格式 来存储和表示数据。 简洁和清晰的层次结构使得 JSON 成为理想的数据交换语言。 易于人阅读和编写，同时也易于机器解析和生成，并有效地提升网络传输效率。 2.JSON 和 JavaScript 对象的关系： JSON 是 JavaScript 对象的字符串表示法，它使用文本表示一个 JS 对象的信息，本质是一个字符
@JacksonInject与@JsonAlias注解-JSON框架Jackson精解
Jaemon
12-23 351
@JacksonInject与@JsonAlias注解-JSON框架Jackson精解
jackson中的 各种注解
06-08
Jackson是一个流行的Java库，用于将Java对象序列化为JSON格式，或将JSON格式反序列化为Java对象。它提供了许多注解来控制序列化和反...以上是一些常用的Jackson注解，使用它们可以更好地控制序列化和反序列化的过程。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值