SpringBoot优雅地定制JSON响应数据

提示:文章若有错误,欢迎评论区指正🍭 

文章目录

前言

一、如何使用@JsonView这个注解?

二、应用场景

三、实战案例

注解方式

编程方式

总结 


前言

        最近在学习过程中发现了Jackson库的@JsonView也可以改变JSON的输出结构,并且可以更加精细的控制,我平时一般都会定义一些DTO去封装响应数据,使用这种方法可以不用创建DTO,更加优雅且高效的方式来实现。🌈


一、如何使用@JsonView这个注解?

        我们可以创建多个视图,每个视图代表了一组特定的字段。然后,在控制器的方法上,我们可以通过应用这些视图来指定应该使用哪些字段来序列化返回的实体对象。这种灵活性使得我们能够轻松应对各种复杂的业务需求。

二、应用场景

  • 数据暴露级别的控制

         假设你有一个用户实体(User),包含了一些基本信息(如姓名、年龄)和一些敏感信息(如密码、邮箱、身份证)。当你需要提供一个 API 来获取用户的基本信息时,你可能不希望暴露敏感信息。通过使用 @JsonView,你可以定义两个视图:一个包含基本信息,另一个包含所有信息。然后,在对应的 API 方法上,你可以使用相应的视图来控制输出的数据。

  • 根据用户角色定制数据

        在某些情况下,不同的用户角色可能需要看到不同级别的数据。例如,管理员可能需要看到用户的所有信息,而普通用户只能看到基本信息。通过使用 @JsonView 和 Spring Security,你可以根据用户的角色来动态地决定应该暴露哪些数据。

  • API 版本控制

        当你的 API 随时间发展并引入新功能时,可能会有多个版本的 API。在某些情况下,旧版本的 API 可能不需要包含新引入的字段。通过 @JsonView,你可以为每个 API 版本定义一个视图,并在需要时切换到相应的视图。

  • 数据聚合和拆分

       在某些情况下,你可能需要将多个实体的数据聚合到一个 JSON 响应中,或者将一个大实体的数据拆分成多个小实体。通过使用 @JsonView,你可以更轻松地实现这种数据的聚合和拆分。

三、实战案例

定义视图规则:

public interface UserView {// 展示基本信息interface Basic {}// 没有密码interface WithoutPassword extends Basic {}// 展示所有的信息interface Full extends Basic {}
}

定义一个User,在属性上面添加@JSsonView注解,并指定视图

@Data
@AllArgsConstructor
public class User {@JsonView(UserView.Basic.class)private Long id;@JsonView(UserView.Basic.class)private String username;@JsonView(UserView.Full.class)private String password;@JsonView(UserView.Basic.class)private String nickName;@JsonView(UserView.Basic.class)private String email;@JsonView({UserView.Basic.class,UserView.WithoutPassword.class})private String phone;
}

在控制器方法上指定视图,一共有两种方式:注解方式编程方式

注解方式

@RestController
public class testController {@GetMapping("/user/basic")@JsonView(UserView.Basic.class)public User userBasic(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");return user;}@GetMapping("/user/noPassword")@JsonView(UserView.WithoutPassword.class)public User userNoPassword(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");return user;}@GetMapping("/user/full")@JsonView(UserView.Full.class)public User userFull(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");return user;}
}

注意:@JsonView允许一个视图类的数组,但你只能为每个控制器方法指定一个。如果需要激活多个视图,可以使用复合接口。

对上面三个接口测试:

//   user/basic
{"id": 1,"username": "admin","nickName": "小杰不秃头","email": "123456@xx.com","phone": "188xxxxxxxx"
}//   user/noPassword
{"id": 1,"username": "admin","nickName": "小杰不秃头","email": "123456@xx.com","phone": "188xxxxxxxx"
}//   user/full
{"id": 1,"username": "admin","password": "123456","nickName": "小杰不秃头","email": "123456@xx.com","phone": "188xxxxxxxx"
}

编程方式

@RestController
public class testController {@GetMapping("/user/basic")//@JsonView(UserView.Basic.class)public MappingJacksonValue userBasic(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);mappingJacksonValue.setSerializationView(UserView.Basic.class);return mappingJacksonValue;}@GetMapping("/user/noPassword")//@JsonView(UserView.WithoutPassword.class)public MappingJacksonValue userNoPassword(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);mappingJacksonValue.setSerializationView(UserView.WithoutPassword.class);return mappingJacksonValue;}@GetMapping("/user/full")//@JsonView(UserView.Full.class)public MappingJacksonValue userFull(){User user = new User(1L,"admin","123456","小杰不秃头","123456@xx.com","188xxxxxxxx");MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);mappingJacksonValue.setSerializationView(UserView.Full.class);return mappingJacksonValue;}
}//测试结果跟上面一致

注意:接口返回值必须为MappingJacksonValue。


总结 

@JsonView提供了一种灵活且强大的方式来控制序列化的 JSON 数据。通过定义视图和将它们应用到属性和控制器方法上,你可以根据需要暴露不同级别的数据,实现 API 的数据定制化。

@JsonView也可以结合其他的注解一起使用,可以更精细的控制,比如:@JsonInclude、@JsonIgnore等等

参考文章:

https://mp.weixin.qq.com/s/wtZP0DDoaijrnx7mK5Bs7g

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/pingmian/7886.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

QT截图程序,可多屏幕截图

截图程序&#xff0c;支持多屏幕时跨屏幕截图。截图使用setMask达到镂空效果&#xff0c;截图后会有预览和保存功能。截图时按下Esc可退出。 mainwindow.ui mainwindow.cpp #include "mainwindow.h" #include "ui_mainwindow.h" #include <QDebug> …

Ansible自动化运维工具 - playbook 剧本编写

一. inventory 主机清单 Inventory 支持对主机进行分组&#xff0c;每个组内可以定义多个主机&#xff0c;每个主机都可以定义在任何一个或多个主机组内。 1.1 inventory 中的变量含义 Inventory 变量名 含义ansible_hostansible连接节点时的IP地址ansible_port连接对方…

2024-05-07 商业分析-如何在社会层面做一个更好的工具人-记录

摘要: 2024-05-07 商业分析-如何成为一个靠谱的工具人 如何在社会层面做一个更好的工具人 那么今天讲的这个主题呢&#xff0c;对吧&#xff1f;你们一看啊&#xff0c;就觉得这个就不应该我讲是吧啊&#xff0c;但是呢这个逻辑呢我还得跟你们讲一下啊&#xff0c;就是如何成为…

虚幻引擎笔记

虚幻引擎笔记 一、蓝图类二、创建自定义Character蓝图三、操作映射和轴映射 一、蓝图类 Actor&#xff1a;可以放置在关卡中的物体Pawn&#xff1a;相当于游戏角色&#xff0c;可以通过玩家控制器来控制角色&#xff1a;在Pawn的基础上增加了四处走动的功能。创建游戏角色时使用…

Freeswitch-mod开发

文章目录 一、Freeswitch-mod开发1.1 介绍1.2 实战1.2.1 新建一个mymod.c或者mymod.cpp1.2.2 新建一个Makefile1.2.3 编译 二、Freeswitch-mod-自定义Dialplan模块2.1 介绍2.2 实战2.2.1 改造mymod.c&#xff08;代码是完整的&#xff0c;自己做区别看一下&#xff09;2.2.2 编…

python实验三 实现UDP协议、TCP协议进行服务器端与客户端的交互

实验三 实验题目 1、请利用生成器构造一下求阶乘的函数Factorial()&#xff0c;定义一个函数m()&#xff0c;在m()中调用生成器Factorial()生成小于100的阶乘序列存入集合s中&#xff0c;输出s。 【代码】 def factorial():n1f1while 1:​ f * n​ yield (f)​ n1…

XORM 框架的使用

1、xorm 1.1、xorm 简介 xorm 是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作非常简便。 特性 支持 struct 和数据库表之间的灵活映射&#xff0c;并支持自动同步事务支持同时支持原始SQL语句和ORM操作的混合执行使用连写来简化调用支持使用ID, In, Where, Limit,…

Java jar程序CPU异常高问题排查

文章目录 一、命令排查二、脚本排查方法一 curl脚本文件直接用bash运行方法二 下载脚本文件并运行一、命令排查 1.使用 top 定位到占用CPU高的进程PID top2.获取进程PID信息 ps aux | grep [PID]3.找到占用CPU高的线程 ps -mp [PID

Python批量计算多张遥感影像的NDVI

本文介绍基于Python中的gdal模块&#xff0c;批量基于大量多波段遥感影像文件&#xff0c;计算其每1景图像各自的NDVI数值&#xff0c;并将多景结果依次保存为栅格文件的方法。 如下图所示&#xff0c;现在有大量.tif格式的遥感影像文件&#xff0c;其中均含有红光波段与近红外…

JAVA基础jsp之富文本编辑器文件上传与下载

目录 一、富文本编辑器 二、SmartUpload插件 一、富文本编辑器 1.概述 富文本编辑器&#xff0c;Rich Text Editor, 简称 RTE, 是一种可内嵌于浏览器&#xff0c;所见即所得的文本编辑器&#xff0c;类似于 Microsoft Word 的编辑功能。 2.常用富文本编辑器 ①ckedi…

通过氧气退火增强β-Ga₂O₃二极管.中国科技大学和河北半导体研究所的研究人员在这一特定领域取得了最新重大进展

上图所示&#xff1a;&#xff08;a&#xff09;增加台面有助于提高β-Ga2O3肖特基势垒二极管的阻断电压&#xff08;b&#xff09;。 氧气退火和自对准台面终端使β-Ga2O3二极管进一步走向商业化。 虽然β-Ga2O3电力电子技术已经取得了长足的进步&#xff0c;但仍然存在挑战&…

安卓使用so库

最近需要给小伙伴扫盲一下如何使用Android Studio 生成一个SO文件&#xff0c;网上找了很多都没有合适的样例&#xff0c;那只能自己来写一个了。 原先生成SO是一个很麻烦的事情&#xff0c;现在Android Studio帮忙做了很多的事情&#xff0c;基本只要管好自己的C代码即可。 …

QT creator qt6.0 使用msvc2019 64bit编译报错

qt creator qt6.0报错&#xff1a; D:\Qt6\6.3.0\msvc2019_64\include\QtCore\qglobal.h:123: error: C1189: #error: "Qt requires a C17 compiler, and a suitable value for __cplusplus. On MSVC, you must pass the /Zc:__cplusplus option to the compiler."…

VTK —— 三、简单操作 - 示例3 - 将点投影到平面上(附完整源码)

代码效果 本代码编译运行均在如下链接文章生成的库执行成功&#xff0c;若无VTK库则请先参考如下链接编译vtk源码&#xff1a; VTK —— 一、Windows10下编译VTK源码&#xff0c;并用Vs2017代码测试&#xff08;附编译流程、附编译好的库、vtk测试源码&#xff09; 教程描述 本…

什么是视频号小店?为什么这么多人都在做?一文带你轻松入门!

大家好&#xff0c;我是电商花花。 现在电商的快速发展&#xff0c;电商行业在各大电商平台上不断发展&#xff0c;而视频号小店也被更多人看到和入驻&#xff0c;让更多创业者对视频号小店产生兴趣。 知道的人都觉得视频号小店是一个不可多得的创业项目&#xff0c;因为这里…

rust 使用记录

rust 使用记录 安装包管理镜像源 安装 参考 rust install sudo apt install -y curl # 安装 curl --proto https --tlsv1.2 -sSf https://sh.rustup.rs | sh # 加载环境变量 source $HOME/.cargo/env # 查看版本 rustc --version rustc -V# 更新Rust rustup update# 卸载 # r…

下一代Nginx? OpenNjet 的入门实践

何为 OpenNjet &#xff1f; OpenNJet 应用引擎是基于 NGINX 的面向互联网和云原生应用提供的运行时组态服务程序&#xff0c;作为底层引擎&#xff0c;OpenNJet 实现了NGINX 云原生功能增强、安全加固和代码重构&#xff0c;利用动态加载机制可以实现不同的产品形态&#xff0…

休斯《公共管理导论》第5版/考研真题解析/章节题库

第一部分 考研真题精选 一、概念题二、简答题三、论述题四、案例分析题第二部分 章节题库 第1章 一个变革的时代第2章 政府的角色第3章 传统的公共行政模式第4章 公共管理第5章 公共政策第6章 治 理第7章 问 责第8章 利害关系人和外部环境第9章 管制、外包和公共企…

【机器学习与实现】线性回归示例——波士顿房价分析

目录 一、创建Pandas对象并查看数据的基本情况二、使用皮尔逊相关系数分析特征之间的相关性三、可视化不同特征与因变量MEDV&#xff08;房价中值&#xff09;间的相关性四、划分训练集和测试集并进行回归分析 一、创建Pandas对象并查看数据的基本情况 boston.csv数据集下载&a…

Go 语言基础之面向对象编程

1、OOP 首先&#xff0c;Go 语言并不是面向对象的语言&#xff0c;只是可以通过一些方法来模拟面向对象。 1.1、封装 Go 语言是通过结构体&#xff08;struct&#xff09;来实现封装的。 1.2、继承 继承主要由下面这三种方式实现&#xff1a; 1.2.1、嵌套匿名字段 //Add…