Jackson前后端开发模式必备json利器

前言

json是我们现代互联网程序最常用的交互格式，是否你在工作中会遇到前端说字段不一致需要改的需求，是否遇到过数据库字段名与javaBean的规范不同，是否遇到过json与javaBean相互转换时因为需求写的土匪代码，这些都可以用Jackson完成，我们经常和json打交道，而Jackson就是帮助我们更好的处理json的框架，SpringBoot默认自带，还有一款Fastjson，阿里开源的，国内这两种用的比较多，我选择了Jackson，老牌稳定。

先来了解两个概念：

JSON序列化：Object -> JSONString
JSON反序列化：JSONString -> Object

Jackson库介绍

Jackson库有两个核心类：ObjectMapper和JsonNode。

ObjectMapper类是Jackson库中最重要的类，它提供了序列化和反序列化Java对象与JSON之间的转换。ObjectMapper类的实例是线程安全的，可以在多线程环境中共享。

JsonNode类是一个抽象类，它代表了一个JSON节点。JsonNode类有多个子类，例如ObjectNode、ArrayNode、ValueNode等，分别对应JSON中的对象、数组和值。JsonNode类提供了方便的方法来读取JSON节点的值。

注解

注解是我们最常用的方式，直接选择常用的开搞，全注解 http://https://www.baeldung.com/jackson-annotations

适用序列化和反序列化

@JsonProperty

@JsonProperty 序列化与反序列化别名，作用于属性上

@JsonProperty.value: 要使用的名称（别名）
@JsonProperty.index：要使用的物理索引，如果数据格式（JSON 除外）是基于索引的默认值-1
@JsonProperty.defaultValue: 定义为元数据的文本默认值。注意：核心数据绑定不使用这个值；它目前只暴露给扩展模块。
@JsonProperty.required: 序列化与反序列化时候属性是否必须要有，如果为true没有的话会抛出异常，默认值 false

@JsonFormat

@JsonFormat 日期、时间、数字，序列化与反序列化
@JsonFormat.pattern：用于指定日期、时间、数字等的格式模式。例如，"yyyy-MM-dd" 表示日期格式为 "年-月-日"。默认为空字符串 ""。
@JsonFormat.shape：用于指定属性的序列化和反序列化形状。默认为 JsonFormat.Shape.ANY。常用的取值包括：

JsonFormat.Shape.STRING：将属性序列化为字符串。

JsonFormat.Shape.NUMBER：将属性序列化为数字。

JsonFormat.Shape.ARRAY：将属性序列化为数组。

JsonFormat.Shape.OBJECT：将属性序列化为对象。
@JsonFormat.locale：用于指定地区（Locale），在日期、时间格式化时可能会用到。默认为 JsonFormat.DEFAULT_LOCALE，系统默认地区
@JsonFormat.timezone：用于指定时区，对于日期和时间的处理往往与时区有关。默认为空字符串 ""，系统默认时区
@JsonFormat.patternLocale：用于指定日期、时间格式模式的地区（Locale）。默认为 JsonFormat.DEFAULT_LOCALE，通常是 Java 虚拟机默认的地区（Locale）。
@JsonFormat.lenient：用于指定是否允许宽松的解析，例如接受部分格式不符合模式的输入。默认为 false

如果将 lenient 属性设置为 true，则在反序列化过程中可以允许一些非严格匹配的输入。例如，如果输入的日期字符串为 "2021-01"，它并不符合完整的 "yyyy-MM-dd" 格式，但由于 lenient 设置为 true，Jackson 可以进行宽松解析，将其解释为 2021 年 1 月的某个日期（如 2021 年 1 月 1 日）。

@JsonUnwrapped

@JsonUnwrapped 序列与反序列化时对象属性是否需要展开在父对象上，Map不适用，Map用@JsonAnyGetter

例如：

public class User {

    private String name;

    @JsonUnwrapped

    private Address address;

}

public class Address {

    private String street;

    private String city;

}

结果

{

  "name": "John",

  "street": "123 Main St",

  "city": "New York"

}

适用序列化

@JsonPropertyOrder

@JsonPropertyOrder 序列化时排列排列顺序

@JsonProperty.value: 属性名
@JsonProperty.alphabetic：是否按字母顺序排列

@JsonIgnore

@JsonIgnore 序列化时忽略的属性，作用于属性上

@JsonIgnoreProperties

@JsonIgnoreProperties 序列化忽略的属性集合，作用于类上

@JsonIgnoreProperties.value ：在序列化时，忽略列出的属性
@JsonIgnoreProperties.ignoreUnknown：在反序列化时，忽略没有 getter/setter 的属性

@JsonIgnoreType

@JsonIgnoreType 忽略注释类型的所有属性，作用于类上

@JsonInclude

@JsonInclude 序列化时，值为规则这个属性隐藏，作用于类和属性上

@JsonInclude.value：规则默认值JsonInclude.Include.ALWAYS
@JsonInclude.content：集合类型属性规则默认值JsonInclude.Include.ALWAYS

JsonInclude.Include.ALWAYS：始终包含属性，即使属性值为 null。

JsonInclude.Include.NON_NULL：仅在属性值不为 null 时才包含属性。

JsonInclude.Include.NON_DEFAULT：仅在属性值与默认值不相等时才包含属性。

JsonInclude.Include.NON_EMPTY：仅在属性值不为 null 且不为空（例如空字符串或空集合）时才包含属性。

@JsonAnyGetter

@JsonAnyGetter 注释允许灵活地将Map属性用作标准属性平铺在父对象上，适用序列化，作用于get方法上，返序列化用@JsonAnySetter

例如：

@Data

public class OrderDetails {

    Map<String, String> tempMap = new HashMap<String, String>(){{

        put("temp","temp");

        put("temp1","temp1");

    }};

    @JsonAnyGetter

    public Map<String, String> getTempMap() {

        return tempMap;

    }

}

结果

{

    "temp": "temp",

    "temp1": "temp1"

}

@JsonGetter

@JsonGetter 序列化时别名，作用于get方法上

@JsonView

@JsonView 序列与反序列化分组选择需要显示的属性

例子：

@Data

public class OrderDetails {

    public interface UserSimpleView {};

    public interface UserDetailView {};

    @JsonView({UserSimpleView.class,UserDetailView.class})

    String name = "yues";

    @JsonView(UserDetailView.class)

    String password = "123";

}

结果：

@JsonView(OrderDetails.UserSimpleView.class)

@RequestMapping("/add")

public Object add(@RequestBody OrderDetails orderDetails) {

//        {

//            "name": "yues"

//        }

	return orderDetails;

}

@JsonView(OrderDetails.UserDetailView.class)

@RequestMapping("/add")

public Object add(@RequestBody OrderDetails orderDetails) {

//        {

//            "name": "yues",

//            "password": "123"

//        }

	return orderDetails;

}

@JsonRootName

@JsonRootName 包一层

例子：

@Data

@JsonRootName("user")

public class OrderDetails {

    String name = "yues";

}

{

  "user":  {

     "name": "yues"

  },

}

@JsonSerialize

@JsonSerialize 自定义序列化器

using：指定要使用的自定义序列化器类。该参数接受一个实现了 Jackson 的 JsonSerializer 接口的类。您可以编写自定义的序列化器类来控制属性的序列化行为。

值为null不会执行
as：在序列化过程中，指定使用的序列化器类型。默认情况下，Jackson 会根据属性的类型来选择合适的序列化器。使用 as 参数可以强制指定序列化器的类型，覆盖默认的选择。
keyUsing：在序列化过程中，指定用于序列化属性键（如果属性是一个 Map 或类似结构的键值对）的自定义序列化器。该参数接受一个实现了 Jackson 的 JsonSerializer 接口的类。
contentUsing：在序列化过程中，指定用于序列化属性值（如果属性是一个 Collection 或类似结构的集合）的自定义序列化器。该参数接受一个实现了 Jackson 的 JsonSerializer 接口的类。
nullsUsing：在序列化过程中，指定用于处理属性值为 null 的自定义序列化器。该参数接受一个实现了 Jackson 的 JsonSerializer 接口的类。通过设置 nullsUsing 参数，您可以定义在属性值为 null 时应该采取的序列化行为。

反序列化

@JsonSetter

@JsonGetter 反序列化时别名，作用于set方法上

@JsonAlias

@JsonAlias 反序列化时别名，可以应用于类的属性上且可以指定多个

@JsonDeserialize

@JsonDeserialize 自定义反序列化器

using：指定要使用的自定义反序列化器类。该属性接受一个实现了 Jackson 的 JsonDeserializer 接口的类。您可以编写自定义的反序列化器类来控制属性的反序列化行为。
contentUsing：在反序列化过程中，指定用于处理属性值（如果属性是一个 Collection 或类似结构的集合）的自定义反序列化器。该属性接受一个实现了 Jackson 的 JsonDeserializer 接口的类。
keyUsing：在反序列化过程中，指定用于处理属性键（如果属性是一个 Map 或类似结构的键值对）的自定义反序列化器。该属性接受一个实现了 Jackson 的 JsonDeserializer 接口的类。
contentAs：在反序列化过程中，指定用于处理属性值（如果属性是一个 Collection 或类似结构的集合）的类型。通过设置 contentAs 属性，您可以强制 Jackson 使用指定的类型进行属性值的反序列化。

自定义注解

例子

@Retention(RetentionPolicy.RUNTIME)

@JacksonAnnotationsInside

@JsonInclude(Include.NON_NULL)

@JsonPropertyOrder({ "name", "id", "dateCreated" })

@JsonDeserialize //自定义反序列化

@@JsonSerialize  //自定义序列化

public @interface CustomAnnotation {}

不用注解ObjectMapper对象

以上的注解都可以使用ObjectMapper对象来配置，先有ObjectMapper才有的这些注解，上面的注解都是使用ObjectMapper来完成的，在SpringBoot中我们还可以用ObjectMapper Bean来达到全局配置，当然也可以用配置文件。在日常的开发工作中，我们经常全局制定日期格式、驼峰_转换等等。

这里就不多做使用ObjectMapper来详细说，贴一些常用的方法吧

ObjectMapper mapper = new ObjectMapper()

mapper.enable(序列化配置);

mapper.configure(反序列化配置);

// 将字符串、byte[]转换为对象 序列化

mapper.readValue(jsonString, User.class);

// 此方法更灵活，可以只将用户感兴趣的Json串信息值提取出来 序列化

mapper.readTree(test);

// 将对象转换为json字符串 反序列化

mapper.writeValueAsString(user);

// 将对象转换为byte 反序列化

mapper.writeValueAsBytes(user)