jackson学习之八：常用方法注解(1)

系列文章汇总

• jackson学习之一：基本信息

• jackson学习之二：jackson-core

• jackson学习之三：常用API操作

• jackson学习之四：WRAP_ROOT_VALUE（root对象）

• jackson学习之五：JsonInclude注解

• jackson学习之六：常用类注解

• jackson学习之七：常用Field注解

• jackson学习之八：常用方法注解

• jackson学习之九：springboot整合(配置文件)

• jackson学习之十(终篇)：springboot整合(配置类)

本篇概览

• 本文是《jackson学习》系列的第八篇，继续学习jackson强大的注解能力，本篇学习常用的方法注解，并通过实例来加深印象，下图是常用方法注解的简介：

源码下载

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协议 |

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

3. jacksondemo是父子结构的工程，本篇的代码在annotation子工程中，里面的methodannotation这个package下，如下图：

JsonValue

1. 在序列化时起作用，可以用来注解get方法或者成员变量；

2. 一个类中，JsonValue只允许出现一次；

3. 如果注解的是get方法，那么该方法的返回值就是整个实例的序列化结果；

4. 如果注解的是成员变量，那么该成员变量的值就是整个实例的序列化结果；

5. 下面是用来测试的Pojo类，JsonValue注解放在getField0方法上，此方法的返回值已经写死了"abc"：

static class Test {

private String field0;

private String field1;

@JsonValue

public String getField0() { return “abc”; }

public void setField0(String field0) { this.field0 = field0; }

public String getField1() { return field1; }

public void setField1(String field1) { this.field1 = field1; }

}

6. Test类的序列化结果如下，即getField0方法的返回值：

JsonCreator

1. 在反序列化时，当出现有参构造方法时（可能是多个有参构造方法），需要通过JsonCreator注解指定反序列化时用哪个构造方法，并且在入参处还要通过JsonProperty指定字段关系：

static class Test {

private String field0;

private String field1;

public Test(String field0) {

this.field0 = field0;

}

// 通过JsonCreator指定反序列化的时候使用这个构造方法

// 通过JsonProperty指定字段关系

@JsonCreator

public Test(@JsonProperty(“field0”) String field0,

@JsonProperty(“field1”) String field1) {

this.field0 = field0;

this.field1 = field1;

}

@Override

public String toString() {

return “Test{” +

“field0='” + field0 + ‘’’ +

“, field1='” + field1 + ‘’’ +

‘}’;

}

}

2. 反序列化结果如下：

JsonSetter

1. JsonSetter注解在set方法上，被用来在反序列化时指定set方法对应json的哪个属性；

2. JsonSetter源码中，推荐使用JsonProperty来取代JsonSetter：

3. 测试代码和结果如下，可见反序列化时，是按照JsonSetter的value去json中查找属性的：

JsonGetter

1. JsonGetter只能作为方法注解；

2. 在序列化时，被JsonGetter注解的get方法，对应的json字段名是JsonGetter的value；

3. JsonGetter源码中，推荐使用JsonProperty来取代JsonGetter：

4. 测试代码和结果如下，可见序列化时JsonGetter的value会被作为json字段名：

JsonAnyGetter

1. JsonAnyGetter的作用有些特别：在序列化时，用Map对象的键值对转成json的字段和值；

2. 理解JsonAnyGetter最好的办法，是对比使用前后序列化结果的变化，先来看以下这段代码，是没有JsonAnyGetter注解的，Test有两个成员变量，其中map字段是HashMap类型的：

package com.bolingcavalry.jacksondemo.annotation.methodannotation;

import com.fasterxml.jackson.annotation.JsonAnyGetter;

import com.fasterxml.jackson.databind.ObjectMapper;

import com.fasterxml.jackson.databind.SerializationFeature;

import java.util.HashMap;

import java.util.Map;

public class JsonAnySetterSerialization {

static class Test {

private String field0;

private Map<String, Object> map;

public String getField0() { return field0; }

public void setField0(String field0) { this.field0 = field0; }

public void setMap(Map<String, Object> map) { this.map = map; }

public Map<String, Object> getMap() { return map; }

}

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

ObjectMapper mapper = new ObjectMapper();

// 美化输出

mapper.enable(SerializationFeature.INDENT_OUTPUT);

// 新增一个HashMap，里面放入两个元素

Map<String, Object> map = new HashMap<>();

map.put(“aaa”, “value_aaa”);

map.put(“bbb”, “value_bbb”);

Test test = new Test();

test.setField0(“000”);

// map赋值给test.map

test.setMap(map);

System.out.println(mapper.writeValueAsString(test));

}

}

3. 上述代码的执行结果如下，其实很好理解，就是field0和map两个字段而已：

{

“field0” : “000”,

“map” : {

“aaa” : “value_aaa”,

“bbb” : “value_bbb”

}

}

4. 接下来，对上述代码做一处改动，如下图红框所示，给getMap方法增加JsonAnyGetter注解：

5. 修改后的执行结果如下，原来的map字段没有了，map内部的所有键值对都成了json的字段：

{

“field0” : “000”,

“aaa” : “value_aaa”,

“bbb” : “value_bbb”

}

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
…(img-3FgsBr2c-1714795614766)]

[外链图片转存中…(img-q0OppM4M-1714795614766)]

[外链图片转存中…(img-a7ylehGx-1714795614766)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门！

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！