天天看点

Springboot 一个注解搞定返回参数key转换 【实用】

前言

平时在搬砖的时候,大家有没有遇到过这样的一个场景,由于各种不可描述因素导致,

一个接口返回的数据 里面的 key 是 A , 但是客户端(前端) 要求返回的key 不叫 A 叫 Aa 。

也就是返回的值不变,就是key 换了。

例如 :

Springboot 一个注解搞定返回参数key转换 【实用】

正文 

那么需要怎么做的 ? 

① 新写一个类,用于值的返回,拿到值,把属性 get set 一下。

Springboot 一个注解搞定返回参数key转换 【实用】

② 也就是本篇文章想提到的 ,使用注解, @JsonProperty

Springboot 一个注解搞定返回参数key转换 【实用】

这个很多人都知道, 绕半天原来是 炒冷饭 ? 且慢。

② 这种方式,其实是一种入侵时调整, 前提是你有权限能够改到 原来的 类的 属性的代码 。

但是也有情况是,这个返回的类,你用的是别人的jar引入的, 那就没办法直接改人家代码。

这时候,大多数的人可能也就只有使用 ① 情况了。

其实不然。

③ 也是这篇想提到的 ,非入侵式的 转换返回数据的key, 同样也是通过注解方式实现, 也就是 @JsonMixin  + @JsonProperty 

ps :  springboot 2.7版本以上 支持 @JsonMixin

<parent>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>2.7.2</version>

<relativePath/>

</parent>

Springboot 一个注解搞定返回参数key转换 【实用】

实操示例:

写个模拟的调用接口,拿到返回数据 Student:

@GetMapping("/queryById")

public Student queryById( Integer id){

Student student=new Student();

student.setId(id);

student.setName("JCccc");

student.setAge(20);

student.setMobile("136XXXXXXXX");

return student;

}

可以看到返回值: 

Springboot 一个注解搞定返回参数key转换 【实用】

先看 入侵式的, 也就是在原来的返回数据的类上面去使用  @JsonProperty  :

@JsonProperty

Springboot 一个注解搞定返回参数key转换 【实用】

 可以看到返回值: 

Springboot 一个注解搞定返回参数key转换 【实用】

再看非入侵式的, 创建一个 抽象类 PhoneKeyConvert , 可以指定单个或多个类, 在返回数据的时候,自动转换key:

@JsonMixin  + @JsonProperty

Springboot 一个注解搞定返回参数key转换 【实用】
Springboot 一个注解搞定返回参数key转换 【实用】

可以看下返回结果 :

继续阅读