【spring mvc】全局处理请求体和响应体

说明

由于项目中需要进行加密传输数据提高项目安全性，前端调用接口时，请求体中的数据全部加密成密文传输到后端接口，后端接口接收之后解密回明文。本例中使用的RSA非对称加解密方式处理。

如果后端接口参数使用字符串String 接收密文参数，则需要在每个接口方法中进行解密操做，代码会产生冗余。

如下伪代码：

@Slf4j
@RestController
@RequestMapping(value = "user")
public class TUserController {
   
    /**
    * 说明: 添加
    * @author   zhangxiaosan
    * @create   2024/12/3
    * @param
    * @return
    */
    @PostMapping(value = "add")
    public String add(@RequestBody String user){
   
    	// user 参数为前端传递过来的 密文
    	// 使用RSA 解密方法，传入密文和密钥解密得到明文
    	String data = RSA.decryption(user,key); // 此部分为冗余代码。
		
		// todo 业务操做逻辑
				
        return user.toString();
    }
}

现在，有个需求是，接口方法中正常使用实体类来作为参数类型接收。前端依旧是传递加密后的密文。后端接收到密文之后，解密得到明文后，将明文数据转成接口参数所需要的数据类型。

业务处理完成之后，将返回的数据再进行加密传给前端。前端解密后才能得到明文展示 。

实现效果

逻辑图

实现步骤

创建公共处理的请求和响应的类

此类主要是公共处理api接收前端请求的密文参数，解密。处理方法返回数据的加密。

import com.alibaba.fastjson2.JSON;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
import www.three.common.response.Response;
import www.three.common.security.rsa.RSAUtil;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
import java.util.Objects;

/**
 * 说明：
 * 对请求体和响应体进行加密解密
 * 此类用于全局处理请求和响应的功能类
 * RequestBodyAdvice 接口
 * RequestBodyAdvice 接口用于在请求的请求体被反序列化（即转化为 Java 对象）之前对其进行处理。你可以使用它来解密请求体中的数据。
 * <p>
 * ResponseBodyAdvice<Response> 接口
 * ResponseBodyAdvice 接口用于在响应体被序列化（即将 Java 对象转化为响应内容）之前对其进行处理。你可以使用它来加密响应体中的数据。Response 为自定义的响应格式实体类。
 *
 * @author 张小三
 * @create 2024-12-04 10:00
 * @verson 1.0.0
 */
@Slf4j
@ControllerAdvice
public class EncryptRequestResponseBodyAdvice implements ResponseBodyAdvice<Response>, RequestBodyAdvice {
   
	// 前端 RSA算法的私钥，用于解密前端传递过来的密文。前端需要于此私钥对应的公钥进行加密数据。
    private static final String privateKey = "";// 此处填写为前端的RSA私钥
	
	// 后端Api RSA 算法的公钥，用于加密响应体的数据。前端需要使用此公钥对应的私钥才能进行数据解密。
    private static final String publicKey = ""; // 此处填写为后端api的RSA公钥

    /**
     * 此方法判断当前处理器是否支持给定的方法参数、目标类型和HTTP消息转换器类型
     * @param methodParameter 方法参数
     * @param targetType      目标类型
     * @param converterType   HTTP消息转换器类型
     * @return 总是返回false，表示不支持
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
   
        return true;//返回 true 表示我们想要处理所有请求的请求体
    }

    /**
     * 在读取请求体之前调用此方法进行预处理
     * @param inputMessage  输入消息
     * @param parameter     方法参数
     * @param targetType    目标类型
     * @param converterType HTTP消息转换器类型
     * @return 返回null，表示不需要进行特殊处理
     * @throws IOException 如果处理过程中发生I/O错误
     */
    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
   
        return new HttpInputMessage() {
   
            @Override
            public InputStream getBody() throws IOException {
   
            	// 读取响应体的流
                InputStream inputStream = inputMessage.getBody();
                byte[] bytes = new byte[inputStream.available()];
                inputStream.read(bytes);
                // 转成字符串
                String data = JSON.parseObject(bytes).getString("data");
                log.info("RequestBody 密文:" + data);
                // 使用RSA工具方法解密
                data = RSAUtil.decryption(data,privateKey);
                log.info("RequestBody 明文:" + data);
                return new ByteArrayInputStream(data.getBytes());
            }

            @Override
            public HttpHeaders getHeaders() {
   
                return inputMessage.getHeaders();
            }
        };
    }

    /**
     * 在读取请求体之后调用此方法进行后处理
     *
     * @param body          请求体内容
     * @param inputMessage  输入消息
     * @param parameter     方法参数
     * @param targetType    目标类型
     * @param converterType HTTP消息转换器类型
     * @return 返回null，表示不需要进行特殊处理
     */
    @Override
    public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter