如何优雅的实现 Spring Boot 接口参数加密解密？

return cipher;

}

// AES加密

public static String encrypt(byte[] data, byte[] key) throws Exception {

Cipher cipher = getCipher(key, Cipher.ENCRYPT_MODE);

return Base64.getEncoder().encodeToString(cipher.doFinal(data));

}

// AES解密

public static byte[] decrypt(byte[] data, byte[] key) throws Exception {

Cipher cipher = getCipher(key, Cipher.DECRYPT_MODE);

return cipher.doFinal(Base64.getDecoder().decode(data));

}

}

这个工具类比较简单，不需要多解释。需要说明的是，加密后的数据可能不具备可读性，因此我们一般需要对加密后的数据再使用 Base64 算法进行编码，获取可读字符串。换言之，上面的 AES 加密方法的返回值是一个 Base64 编码之后的字符串，AES 解密方法的参数也是一个 Base64 编码之后的字符串，先对该字符串进行解码，然后再解密。

接下来我们封装一个响应工具类备用，这个大家如果经常看松哥视频已经很了解了：

public class RespBean {

private Integer status;

private String msg;

private Object obj;

public static RespBean build() {

return new RespBean();

}

public static RespBean ok(String msg) {

return new RespBean(200, msg, null);

}

public static RespBean ok(String msg, Object obj) {

return new RespBean(200, msg, obj);

}

public static RespBean error(String msg) {

return new RespBean(500, msg, null);

}

public static RespBean error(String msg, Object obj) {

return new RespBean(500, msg, obj);

}

private RespBean() {

}

private RespBean(Integer status, String msg, Object obj) {

this.status = status;

this.msg = msg;

this.obj = obj;

}

public Integer getStatus() {

return status;

}

public RespBean setStatus(Integer status) {

this.status = status;

return this;

}

public String getMsg() {

return msg;

}

public RespBean setMsg(String msg) {

this.msg = msg;

return this;

}

public Object getObj() {

return obj;

}

public RespBean setObj(Object obj) {

this.obj = obj;

return this;

}

}

接下来我们定义两个注解 @Decrypt 和 @Encrypt：

@Retention(RetentionPolicy.RUNTIME)

@Target({ElementType.METHOD,ElementType.PARAMETER})

public @interface Decrypt {

}

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

public @interface Encrypt {

}

这两个注解就是两个标记，在以后使用的过程中，哪个接口方法添加了 @Encrypt 注解就对哪个接口的数据加密返回，哪个接口/参数添加了 @Decrypt 注解就对哪个接口/参数进行解密。这个定义也比较简单，没啥好说的，需要注意的是 @Decrypt 比 @Encrypt 多了一个使用场景就是 @Decrypt 可以用在参数上。

考虑到用户可能会自己配置加密的 key，因此我们再来定义一个 EncryptProperties 类来读取用户配置的 key：

@ConfigurationProperties(prefix = “spring.encrypt”)

public class EncryptProperties {

private final static String DEFAULT_KEY = “www.itboyhub.com”;

private String key = DEFAULT_KEY;

public String getKey() {

return key;

}

public void setKey(String key) {

this.key = key;

}

}

这里我设置了默认的 key 是 www.itboyhub.com，key 是 16 位字符串，松哥这个网站地址刚好满足。以后如果用户想自己配置 key，只需要在 application.properties 中配置 spring.encrypt.key=xxx 即可。

所有准备工作做完了，接下来就该正式加解密了。

因为松哥这篇文章一个很重要的目的是想和大家分享 ResponseBodyAdvice 和 RequestBodyAdvice 的用法，RequestBodyAdvice 在做解密的时候倒是没啥问题，而 ResponseBodyAdvice 在做加密的时候则会有一些局限，不过影响不大，还是我前面说的，如果想非常灵活的掌控一切，那还是自定义过滤器吧。这里我就先用这两个工具来实现了。

另外还有一点需要注意，ResponseBodyAdvice 在你使用了 @ResponseBody 注解的时候才会生效，RequestBodyAdvice 在你使用了 @RequestBody 注解的时候才会生效，换言之，前后端都是 JSON 交互的时候，这两个才有用。不过一般来说接口加解密的场景也都是前后端分离的时候才可能有的事。

先来看接口加密：

@EnableConfigurationProperties(EncryptProperties.class)

@ControllerAdvice

public class EncryptResponse implements ResponseBodyAdvice {

private ObjectMapper om = new ObjectMapper();

@Autowired

EncryptProperties encryptProperties;

@Override

public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {

return returnType.hasMethodAnnotation(Encrypt.class);

}

@Override

public RespBean beforeBodyWrite(RespBean body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {

byte[] keyBytes = encryptProperties.getKey().getBytes();

try {

if (body.getMsg()!=null) {

body.setMsg(AESUtils.encrypt(body.getMsg().getBytes(),keyBytes));

}

if (body.getObj() != null) {

body.setObj(AESUtils.encrypt(om.writeValueAsBytes(body.getObj()), keyBytes));

}

} catch (Exception e) {

e.printStackTrace();

}

return body;

}

}

我们自定义 EncryptResponse 类实现 ResponseBodyAdvice 接口，泛型表示接口的返回类型，这里一共要实现两个方法：

1. supports：这个方法用来判断什么样的接口需要加密，参数 returnType 表示返回类型，我们这里的判断逻辑就是方法是否含有 @Encrypt 注解，如果有，表示该接口需要加密处理，如果没有，表示该接口不需要加密处理。

2. beforeBodyWrite：这个方法会在数据响应之前执行，也就是我们先对响应数据进行二次处理，处理完成后，才会转成 json 返回。我们这里的处理方式很简单，RespBean 中的 status 是状态码就不用加密了，另外两个字段重新加密后重新设置值即可。

3. 另外需要注意，自定义的 ResponseBodyAdvice 需要用 @ControllerAdvice 注解来标记。

再来看接口解密：

@EnableConfigurationProperties(EncryptProperties.class)

@ControllerAdvice

public class DecryptRequest extends RequestBodyAdviceAdapter {

@Autowired

EncryptProperties encryptProperties;

@Override

public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {

return methodParameter.hasMethodAnnotation(Decrypt.class) || methodParameter.hasParameterAnnotation(Decrypt.class);

}

@Override

public HttpInputMessage beforeBodyRead(final HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {

byte[] body = new byte[inputMessage.getBody().available()];

inputMessage.getBody().read(body);

try {

byte[] decrypt = AESUtils.decrypt(body, encryptProperties.getKey().getBytes());

final ByteArrayInputStream bais = new ByteArrayInputStream(decrypt);

return new HttpInputMessage() {

@Override

public InputStream getBody() throws IOException {

return bais;

}

@Override

public HttpHeaders getHeaders() {

return inputMessage.getHeaders();

}

};

} catch (Exception e) {

e.printStackTrace();

}

return super.beforeBodyRead(inputMessage, parameter, targetType, converterType);

}

}

1. 首先大家注意，DecryptRequest 类我们没有直接实现 RequestBodyAdvice 接口，而是继承自 RequestBodyAdviceAdapter 类，该类是 RequestBodyAdvice 接口的子类，并且实现了接口中的一些方法，这样当我们继承自 RequestBodyAdviceAdapter 时，就只需要根据自己实际需求实现某几个方法即可。

2. supports：该方法用来判断哪些接口需要处理接口解密，我们这里的判断逻辑是方法上或者参数上含有 @Decrypt 注解的接口，处理解密问题。

3. beforeBodyRead：这个方法会在参数转换成具体的对象之前执行，我们先从流中加载到数据，然后对数据进行解密，解密完成后再重新构造 HttpInputMessage 对象返回。

接下来，我们再来定义一个自动化配置类，如下：

@Configuration

@ComponentScan(“org.javaboy.encrypt.starter”)

public class EncryptAutoConfiguration {

}

这个也没啥好说的，比较简单。

最后，resources 目录下定义 META-INF，然后再定义 spring.factories 文件，内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.javaboy.encrypt.starter.autoconfig.EncryptAutoConfiguration

这样当项目启动时，就会自动加载该配置类。

至此，我们的 starter 就开发完成啦。

2.打包发布

---

我们可以将项目安装到本地仓库，也可以发布到线上供他人使用。

2.1 安装到本地仓库

安装到本地仓库比较简单，直接 mvn install，或者在 IDEA 中，点击右边的 Maven，然后双击 install，如下：

2.2 发布到线上

发不到线上我们可以使用 JitPack 来做。

首先我们在 GitHub 上创建一个仓库，将我们的代码上传上去，这个过程应该不用我多说吧。

上传成功后，点击右边的 Create a new release 按钮，发布一个正式版，如下：

发布成功后，打开 jitpack，输入仓库的完整路径，点击 lookup 按钮，查找到之后，再点击 Get it 按钮完成构建，如下：

构建成功后，JitPack 上会给出项目引用方式：

注意引用时将 tag 改成你具体的版本号。

至此，我们的工具就已经成功发布了！小伙伴们可以通过如下方式引用这个 starter：

com.github.lenve

encrypt-spring-boot-starter

0.0.3

jitpack.io

https://jitpack.io

3.应用

---

我们创建一个普通的 Spring Boot 项目，引入 web 依赖，再引入我们刚刚的 starter 依赖，如下：

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）

最后

在面试前我整理归纳了一些面试学习资料，文中结合我的朋友同学面试美团滴滴这类大厂的资料及案例

由于篇幅限制，文档的详解资料太全面，细节内容太多，所以只把部分知识点截图出来粗略的介绍，每个小节点里面都有更细化的内容！

大家看完有什么不懂的可以在下方留言讨论也可以关注。

觉得文章对你有帮助的话记得关注我点个赞支持一下！

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！**

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip1024b （备注Java）
[外链图片转存中…(img-4jROUkQd-1712903406382)]

最后

在面试前我整理归纳了一些面试学习资料，文中结合我的朋友同学面试美团滴滴这类大厂的资料及案例
[外链图片转存中…(img-SnslVJl8-1712903406382)]

[外链图片转存中…(img-ryzg7GqN-1712903406383)]
由于篇幅限制，文档的详解资料太全面，细节内容太多，所以只把部分知识点截图出来粗略的介绍，每个小节点里面都有更细化的内容！

大家看完有什么不懂的可以在下方留言讨论也可以关注。

觉得文章对你有帮助的话记得关注我点个赞支持一下！

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
[外链图片转存中…(img-uSt7bIFG-1712903406383)]