Springboot一个注解搞定返回参数key转换功能

 更新时间:2022年10月12日 15:11:02   作者:小目标青年  
平时在搬砖的时候,大家有没有遇到过这样场景,由于各种因素导致,一个接口返回的数据里面的key是A, 但是客户端(前端)要求返回的key不叫A叫Aa 。也就是返回的值不变,就是key换了。本文将通过一个注解搞定返回参数key转换,需要的可以了解一下

前言

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

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

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

例如 :

正文

那么需要怎么做的 ? 

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

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

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

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

但是也有情况是,这个返回的类,你用的是别人的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>

实操示例:

写个模拟的调用接口,拿到返回数据 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;
}

可以看到返回值:

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

@JsonProperty

可以看到返回值:

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

@JsonMixin  + @JsonProperty

可以看下返回结果 :

OK,该篇就到这。

合适的业务场景,合适的技术方案。

到此这篇关于Springboot一个注解搞定返回参数key转换功能的文章就介绍到这了,更多相关Springboot参数key转换内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringBoot使用Spring-Data-Jpa实现CRUD操作

    SpringBoot使用Spring-Data-Jpa实现CRUD操作

    这篇文章主要为大家详细介绍了SpringBoot使用Spring-Data-Jpa实现CRUD操作,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-08-08
  • Java实现将导出带格式的Excel数据到Word表格

    Java实现将导出带格式的Excel数据到Word表格

    在Word中制作报表时,我们经常需要将Excel中的数据复制粘贴到Word中,这样则可以直接在Word文档中查看数据而无需打开另一个Excel文件。本文将通过Java应用程序详细介绍如何把带格式的Excel数据导入Word表格。希望这篇文章能对大家有所帮助
    2022-11-11
  • Springboot整合logback多节点日志文件加端口号区分的操作方法

    Springboot整合logback多节点日志文件加端口号区分的操作方法

    这篇文章主要介绍了Springboot整合logback多节点日志文件加端口号区分的操作方法,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-09-09
  • java读取大文件简单实例

    java读取大文件简单实例

    这篇文章主要介绍了java读取大文件简单实例,有需要的朋友可以参考一下
    2013-12-12
  • Javaweb使用Maven工具与Tomcat的方法详解

    Javaweb使用Maven工具与Tomcat的方法详解

    这篇文章主要为大家详细介绍了Javaweb使用Maven工具与Tomcat的方法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java 判断实体对象及所有属性是否为空的操作

    Java 判断实体对象及所有属性是否为空的操作

    这篇文章主要介绍了Java 判断实体对象及所有属性是否为空的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • Java实现部门员工管理

    Java实现部门员工管理

    这篇文章主要为大家详细介绍了Java实现部门员工管理,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-08-08
  • 关于Mybatis的mapper接口函数重载问题

    关于Mybatis的mapper接口函数重载问题

    这篇文章主要介绍了关于Mybatis的mapper接口函数重载问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • 简单了解SpringCloud运行原理

    简单了解SpringCloud运行原理

    这篇文章主要介绍了简单了解SpringCloud运行原理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 详解SpringBoot获得Maven-pom中版本号和编译时间戳

    详解SpringBoot获得Maven-pom中版本号和编译时间戳

    这篇文章主要介绍了详解SpringBoot获得Maven-pom中版本号和编译时间戳,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01

最新评论