背景
软件开发是一门实践性科学,对大多数人来说,学习一种新技术不是一开始就去深究其原理,而是先从做出一个可工作的DEMO入手。但在我个人学习和工作经历中,每次学习新技术总是要花费或多或少的时间、检索不止一篇资料才能得出一个可工作的DEMO,这占用了我大量的时间精力。因此本文旨在通过一篇文章即能还原出可工作的、甚至可用于生产的DEMO,期望初学者能尽快地迈过0到1的这一步骤,并在此基础上不断深化对相关知识的理解。
为达以上目的,本文会将开发环境、工程目录结构、开发步骤及源码尽量全面地展现出来,文字描述能简则简,能用代码注释的绝不在正文中再啰嗦一遍,正文仅对必要且关键的信息做重点描述。
介绍
本文介绍开发 Spring Boot Web 应用时如何使用 ResponseBodyAdvice
统一封装 HTTP 响应体(HTTP Response Body)。
ResponseBodyAdvice
拦截带有 @ResponseBody
注解或返回类型为 ResponseEntity
的 Controller 方法,在这些方法执行完成之后且 HttpMessageConverter
写入 HTTP Response Body 之前执行指定逻辑,以达到统一封装 HTTP 响应体的目的,包括:
- 将 HTTP Response Body 封装成统一数据格式;
- 对 HTTP Response Body 执行加密;
- 对 HTTP Response Body 执行编码。
开发环境
分类 | 名称 | 版本 |
---|---|---|
操作系统 | Windows | Windows 11 |
JDK | Oracle JDK | 21.0.1 |
IDE | IntelliJ IDEA | 2023.3.7 |
构建工具 | Apache Maven | 3.9.9 |
开发步骤及源码
1> 创建Maven工程,添加依赖。
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:sch