[转]Spring Boot 2.7新特性:@JsonMixin的解释和应用

2022-10-23 743点热度 0人点赞 0条评论

在我们普通的应用中,如果我们要定制一个类对象的Json输出的话,我们可以轻松的通过Jackson提供的注解如:“@JsonProperties”等注解在类上轻松实现对Json输出的定制。

但也存在着这样的Java类对象的源码不受控制的情况:

1、Java类在第三方的类库中,你无法修改;

2、不想修改已有的类的代码,因当前业务和已有业务在不同的模块中。

Jackson为我们mixin来解决这个问题,在不修改已有的Java类库的情况下,定制Json的输出。Spring Boot 2.7为我们提供了“@JsonMixin”注解来快速注册mixin。

1、演示项目

打开https://start.spring.io,Spring Boot版本选择2.7.x依赖选择“Spring Web”和“Lombok”。

演示代码

需要定制输出的类:

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

演示用控制器:

@RestController
public class PersonController {
    @GetMapping("/getDemoPerson")
    Person getDemoPerson(){
        return new Person("wiselyman",18);
    }
}

运行访问:
http://localhost:8080/getDemoPerson

下面我们需要将“name”输出修改为“fullName”,我们先用最简单的常规实现,这意味着我们能直接修改“Person”类的源码。

可控时的实现

在可修改源码的情况下,定制输出是很简单的:

import com.fasterxml.jackson.annotation.JsonProperty;

@Data
@AllArgsConstructor
public class Person {
    @JsonProperty("fullName")
    private String name;
    private Integer age;
}

运行访问:
http://localhost:8080/getDemoPerson

@Data
@AllArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

不可控时mixin的实现

我们通过定义一下个抽象类来实现mixin的功能,然后通过Spring Boot的“@JsonMixin”注解将这个抽象类注册到自动配置的“ObjectMapper”。

首先我们的“Person”类恢复原样。

@Data
@AllArgsConstructor
public class Person {
    private String name;
    private Integer age;
}

定义一个叫抽象类“FullNameMixin”,将“FullNameMixin”附加到目标类“Person”:

import com.fasterxml.jackson.annotation.JsonProperty;
import org.springframework.boot.jackson.JsonMixin;

@JsonMixin(Person.class) //1
public abstract class FullNameMixin {
    @JsonProperty("fullName") //2
    String name; //3
}

1、Spring Boot的Jackson自动配置将扫描应用程序的包以查找带有“@JsonMixin”注释的类,并将它们注册到自动配置的“ObjectMapper”。 注册动作由Spring Boot的“JsonMixinModule”执行。

“Person.class”是被附加mixin的目标类。

2、被定制的新名称。

3、被定制的原属性。

运行访问:
http://localhost:8080/getDemoPerson

admin

这个人很懒,什么都没留下

文章评论

您需要 登录 之后才可以评论