18.SpringMVC系列第18篇：RequestBodyAdvice：对@ReuqestBody进行增强-Java充电社【公众号：Java充电社】

**文末可以领取所有系列高清pdf。**

大家好，我是路人，这是SpringMVC系列第18篇。

## 1、前言

在实际项目中，有时候我们需要在请求之前或之后做一些操作，比如：对参数进行解密，对所有的返回值进行加密等。这些与业务无关的操作，我们没有必要在每个 controller 方法中都写一遍，这里我们就可以使用 springmvc 中的@ControllerAdvice 和 RequestBodyAdvice、ResponseBodyAdvice 来对请求前后进行处理，本质上就是 aop 的思想。

**RequestBodyAdvice**：对@RquestBody进行增强处理，比如所有请求的数据都加密之后放在body中，在到达controller的方法之前，需要先进行解密，那么就可以通过RequestBodyAdvice来进行统一的解密处理，无需在 controller 方法中去做这些通用的操作。

ResponseBodyAdvice：通过名称就可以知道，这玩意是对@ResponseBody进行增强处理的，可以对Controller中@ResponseBody类型返回值进行增强处理，也就是说可以拦截@ResponseBody类型的返回值，进行再次处理，比如加密、包装等操作。

本文主要介绍RequestBodyAdvice的用法，下一篇介绍RequestBodyAdvice的用法。

## 2、这个需求如何实现？

比如咱们的项目中对数据的安全性要求比较高，那么可以对所有请求的数据进行加密，后端需要解密之后再进行处理。

怎么实现呢？可以在controller中的每个方法中先进行解密，然后在进行处理，这也太low了吧，需要修改的代码太多了。

这个需求可以通过@ControllerAdvice和RequestBodyAdvice来实现，特别的简单，两三下的功夫就搞定了，下面上代码。

## 3、案例代码

### 3.1、git代码位置

```http
https://gitee.com/javacode2018/springmvc-series
```

![](https://itsoku.oss-cn-hangzhou.aliyuncs.com/itsoku/blog/article/229/536d70e5-cd8f-4844-ae8f-a89b7975f48f.png)

### 3.2、自定义一个RequestBodyAdvice

```java
package com.javacode2018.springmvc.chat13.config;

import com.javacode2018.springmvc.chat13.util.EncryptionUtils;
import org.apache.commons.io.IOUtils;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdviceAdapter;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;

@ControllerAdvice
public class DecryptRequestBodyAdvice extends RequestBodyAdviceAdapter {
    @Override
    public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

@Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
        String encoding = "UTF-8";
        //①：获取http请求中原始的body
        String body = IOUtils.toString(inputMessage.getBody(), encoding);
        //②：解密body，EncryptionUtils源码在后面
        String decryptBody = EncryptionUtils.desEncrypt(body);
        //将解密之后的body数据重新封装为HttpInputMessage作为当前方法的返回值
        InputStream inputStream = IOUtils.toInputStream(decryptBody, encoding);
        return new HttpInputMessage() {
            @Override
            public InputStream getBody() throws IOException {
                return inputStream;
            }

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

}
```

> - 自定义的类需要实现RequestBodyAdvice接口，这个接口有个默认的实现类RequestBodyAdviceAdapter，相当于一个适配器，方法体都是空的，所以我们自定义的类可以直接继承这个类，更方便一些
> - 这个类上面一定要加上`@ControllerAdvice`注解，有了这个注解，springmvc才能够识别这个类是对controller的增强类
> - supports方法：返回一个boolean值，若为true，则表示参数需要这个类处理，否则，跳过这个类的处理
> - beforeBodyRead：在body中的数据读取之前可以做一些处理，我们在这个方法中来做解密的操作。

### 3.3、来个controller测试效果

> 下面这个controller中搞了2个方法，稍后我们传递密文进来，最后这两个方法会将结果返回，返回的结果是经过`DecryptRequestBodyAdvice`类处理之后的明文，稍后验证。

```java
package com.javacode2018.springmvc.chat13.controller;

import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {
    @RequestMapping("/user/add")
    public User add(@RequestBody User user) {
        System.out.println("user:" + user);
        return user;
    }

@RequestMapping("/user/adds")
    public List<User> adds(@RequestBody List<User> userList) {
        System.out.println("userList:" + userList);
        return userList;
    }

public static class User {
        private String name;
        private Integer age;

public String getName() {
            return name;
        }

public void setName(String name) {
            this.name = name;
        }

public Integer getAge() {
            return age;
        }

public void setAge(Integer age) {
            this.age = age;
        }

@Override
        public String toString() {
            return "User{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    }
}
```

### 3.4、加密工具类EncryptionUtils

> 可以运行main方法，得到2个测试的密文。

```java
package com.javacode2018.springmvc.chat13.util;

import javax.crypto.Cipher;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
import java.util.Base64;

/**
 * 加密工具类
 */
public class EncryptionUtils {

private static String key = "abcdef0123456789";

public static void main(String[] args) throws Exception {
        m1();
        m2();
    }

private static void m1(){
        String body = "{\"name\":\"路人\",\"age\":30}";
        String encryptBody = EncryptionUtils.encrypt(body);
        System.out.println(encryptBody);
        String desEncryptBody = EncryptionUtils.desEncrypt(encryptBody);
        System.out.println(desEncryptBody);
    }
    private static void m2(){
        String body = "[{\"name\":\"路人\",\"age\":30},{\"name\":\"springmvc高手系列\",\"age\":30}]";
        String encryptBody = EncryptionUtils.encrypt(body);
        System.out.println(encryptBody);
        String desEncryptBody = EncryptionUtils.desEncrypt(encryptBody);
        System.out.println(desEncryptBody);
    }

private static String AESTYPE = "AES/CBC/PKCS5Padding";

/**
     * 加密明文
     *
     * @param plainText 明文
     * @return
     * @throws Exception
     */
    public static String encrypt(String plainText) {
        try {
            Cipher cipher = Cipher.getInstance(AESTYPE);
            byte[] dataBytes = plainText.getBytes("utf-8");
            byte[] plaintext = new byte[dataBytes.length];
            System.arraycopy(dataBytes, 0, plaintext, 0, dataBytes.length);
            SecretKeySpec keyspec = new SecretKeySpec(key.getBytes(), "AES");
            IvParameterSpec ivspec = new IvParameterSpec(key.getBytes());
            cipher.init(Cipher.ENCRYPT_MODE, keyspec, ivspec);
            byte[] encrypted = cipher.doFinal(plaintext);
            return new String(Base64.getEncoder().encode(encrypted), "UTF-8");
        } catch (Exception e) {
            throw new RuntimeException(e);
        }
    }

/**
     * 解密密文
     *
     * @param encryptData 密文
     * @return
     * @throws Exception
     */
    public static String desEncrypt(String encryptData) {
        try {
            Cipher cipher = Cipher.getInstance(AESTYPE);
            SecretKeySpec keyspec = new SecretKeySpec(key.getBytes(), "AES");
            IvParameterSpec ivspec = new IvParameterSpec(key.getBytes());
            cipher.init(Cipher.DECRYPT_MODE, keyspec, ivspec);
            byte[] original = cipher.doFinal(Base64.getDecoder().decode(encryptData.getBytes("UTF-8")));
            return new String(original, "utf-8");
        } catch (Exception e) {
            throw new RuntimeException(e);
        }

}

}
```

### 3.5、验证效果

验证效果

| 接口       | 明文                                                         | 密文                                                         |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| /user/add  | {"name":"路人","age":30}                                     | 0A10mig46aZI76jwpgmeeuqDHc7h4Zq/adoY6d5r2mY=                 |
| /user/adds | [{"name":"路人","age":30},{"name":"springmvc高手系列","age":30}] | UzWvCsrqt7ljXVI18XBXU3B9S4P2bMB72vH0HNst1GhMt5HTAiodbJwr7r8PuWWs1gM5iAYY4DZWfLgsTbizAEwEtqw8VuCuk2hYBjoCtCc= |

将项目发布到tomcat，然后使用idea中的HTTP client跑下这2个测试用例

```java
POST http://localhost:8080/chat13/user/add
Content-Type: application/json

0A10mig46aZI76jwpgmeeuqDHc7h4Zq/adoY6d5r2mY=

###
POST http://localhost:8080/chat13/user/adds
Content-Type: application/json

UzWvCsrqt7ljXVI18XBXU3B9S4P2bMB72vH0HNst1GhMt5HTAiodbJwr7r8PuWWs1gM5iAYY4DZWfLgsTbizAEwEtqw8VuCuk2hYBjoCtCc=
```

![](https://itsoku.oss-cn-hangzhou.aliyuncs.com/itsoku/blog/article/229/ffdb114a-aba2-4a12-8615-5a251fbeef72.png)

输出如下，变成明文了

```json
用例1输出
{
  "name": "路人",
  "age": 30
}

用例2输出
[
  {
    "name": "路人",
    "age": 30
  },
  {
    "name": "springmvc高手系列",
    "age": 30
  }
]
```

是不是特别的爽，无需在controller中进行解密，将解密统一放在`RequestBodyAdvice`中做了。

## 4、多个RequestBodyAdvice指定顺序

当程序中定义了多个`RequestBodyAdvice`，可以通过下面2种方式来指定顺序。

**方式1**：使用`@org.springframework.core.annotation.Order`注解指定顺序，顺序按照value的值从小到大，如：

```java
@Order(2)
@ControllerAdvice
public class RequestBodyAdvice1 extends RequestBodyAdviceAdapter{}

@Order(1)
@ControllerAdvice
public class RequestBodyAdvice2 extends RequestBodyAdviceAdapter{}
```

**方式1**：实现`org.springframework.core.Ordered`接口，顺序从小到大，如：

```java
@ControllerAdvice
public class RequestBodyAdvice1 extends RequestBodyAdviceAdapter implements Ordered{
	int getOrder(){
        return 1;
    }
}

@Order(1)
@ControllerAdvice
public class RequestBodyAdvice2 extends RequestBodyAdviceAdapter implements Ordered{
	int getOrder(){
        return 2;
    }
}
```

## 5、@ControllerAdvice指定增强的范围

@ControllerAdvice注解相当于对Controller的功能进行了增强，目前来看，对所有的controller方法都增强了。

那么，能否控制一下增强的范围呢？比如对某些包中的controller进行增强，或者通过其他更细的条件来控制呢？

确实可以，可以通过@ControllerAdvice中的属性来指定增强的范围，需要满足这些条件的才会被@ControllerAdvice注解标注的bean增强，每个属性都是数组类型的，所有的条件是或者的关系，满足一个即可。

```java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {

/**
	 * 用来指定controller所在的包，满足一个就可以
	 */
	@AliasFor("basePackages")
	String[] value() default {};

/**
	 * 用来指定controller所在的包，满足一个就可以
	 */
	@AliasFor("value")
	String[] basePackages() default {};

/**
	 * controller所在的包必须为basePackageClasses中同等级或者子包中，满足一个就可以
	 */
	Class<?>[] basePackageClasses() default {};

/**
	 * 用来指定Controller需要满足的类型，满足assignableTypes中指定的任意一个就可以
	 */
	Class<?>[] assignableTypes() default {};

/**
	 * 用来指定Controller上需要有的注解，满足annotations中指定的任意一个就可以
	 */
	Class<? extends Annotation>[] annotations() default {};

}
```

**扩展知识**：这块的判断对应的源码如下，有兴趣的可以看看。

```
org.springframework.web.method.HandlerTypePredicate#test
```

![](https://itsoku.oss-cn-hangzhou.aliyuncs.com/itsoku/blog/article/229/2bf2629b-fcdc-488c-83ba-38bf12765204.png)

## 6、RequestBodyAdvice原理

有些朋友可能对`@ControllerAdvice和RequestBodyAdvice`的原理比较感兴趣，想研究一下他们的源码，关键代码在下面这个方法中，比较简单，有兴趣的可以去翻阅一下，这里就不展开说了。

```java
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#afterPropertiesSet
org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter#initControllerAdviceCache
```

## 7、总结

- @ControllerAdvice和RequestBodyAdvice一起使用可以拦截@RequestBody标注的参数，对参数进行增强处理
- 建议：案例中RequestBodyAdvice#supports方法咱们直接返回的是true，会对所有@RequestBody标注的参数进行处理，有些参数可能不需要处理，对于这种情况的，supports方法需要返回false，这种问题留给大家自己试试了，挺简单的，比如可以自定义一个注解标注在无需处理的参数上，检测到参数上有这个注解的时候（supprts方法中的methodParameter参数可以获取参数的所有信息），supports返回false。

## 8、留个问题

若body中是xml格式的数据，后端接口通过java对象接收，怎么实现呢？欢迎留言讨论。

有问题欢迎加我微信：itsoku，交流。

<a style="display:none" target="_blank" href="https://mp.weixin.qq.com/s/_S1DD2JADnXvpexxaBwLLg" style="color:red; font-size:20px; font-weight:bold">继续收门徒，亲手带，月薪 4W 以下的可以来找我</a>

## 最新资料

1. <a href="https://mp.weixin.qq.com/s?__biz=MzkzOTI3Nzc0Mg==&mid=2247484964&idx=2&sn=c81bce2f26015ee0f9632ddc6c67df03&scene=21#wechat_redirect" target="_blank">尚硅谷 Java 学科全套教程（总 207.77GB）</a>
2. <a href="https://mp.weixin.qq.com/s?__biz=MzkwOTAyMTY2NA==&mid=2247484192&idx=1&sn=505f2faaa4cc911f553850667749bcbb&scene=21#wechat_redirect" target="_blank">2021 最新版 Java 微服务学习线路图 + 视频</a>
3. <a href="https://mp.weixin.qq.com/s?__biz=MzkwOTAyMTY2NA==&mid=2247484573&idx=1&sn=7f3d83892186c16c57bc0b99f03f1ffd&scene=21#wechat_redirect" target="_blank">阿里技术大佬整理的《Spring 学习笔记.pdf》</a>
4. <a href="https://mp.weixin.qq.com/s?__biz=MzkwOTAyMTY2NA==&mid=2247484544&idx=2&sn=c1dfe907cfaa5b9ae8e66fc247ccbe84&scene=21#wechat_redirect" target="_blank">阿里大佬的《MySQL 学习笔记高清.pdf》</a>
5. <a href="https://mp.weixin.qq.com/s?__biz=MzkwOTAyMTY2NA==&mid=2247485167&idx=1&sn=48d75c8e93e748235a3547f34921dfb7&scene=21#wechat_redirect" target="_blank">2021 版 java 高并发常见面试题汇总.pdf</a>
6. <a href="https://mp.weixin.qq.com/s?__biz=MzkwOTAyMTY2NA==&mid=2247485664&idx=1&sn=435f9f515a8f881642820d7790ad20ce&scene=21#wechat_redirect" target="_blank">Idea 快捷键大全.pdf</a>

![](https://itsoku.oss-cn-hangzhou.aliyuncs.com/itsoku/blog/article/1/2883e86e-3eff-404a-8943-0066e5e2b454.png)