API数据加密框架monkey-api-encrypt

 

• 内置AES加密算法，可以配置不同的加密key

• 不再绑定Spring Boot，通过配置Filter即可使用加解密

• Spring Cloud Zuul框架也可以支持

• 支持用户自定义加密算法

GitHub地址：https://github.com/yinjihuan/monkey-api-encrypt

示例代码：https://github.com/yinjihuan/monkey-api-encrypt/tree/master/encrypt-springboot-example

monkey-api-encrypt没有发布到Maven中央仓库，只发布到jitpack这个仓库，大家也可以自行下载源码打包传到自己公司的私服上。

自动加解密的好处

传统做法如下：

1. // 客户端传来的数据就是加密好的字符串

2. public String add(String data) {

3.   // 1. 通过工具类将数据解密，然后序列化成对象使用

4.   // 2. 处理业务逻辑，数据返回的时候用工具类将数据加密返回给客户端

5. }

缺点是在每个业务方法中都要手动的去处理加解密的逻辑。

通过使用monkey-api-encrypt的话可以让开发人员不需要关注加解密的逻辑，比如：

1. @PostMapping("/save")

2. public UserResult add(@RequestBody User data) {

3.    UserResult  result = new UserResult ();

4.    result.setXXX....

5.    return result;

6. }

上面的代码跟平常写的一模一样，没有加解密的逻辑，需要对数据做加解密逻辑的时候，只需要配置一个过滤器，然后指定哪些URI需要加解密即可。下面来学习下如何使用monkey-api-encrypt。

快速使用

下面以jitpack仓库示列

第一步：pom.xml中增加仓库地址

1. <repositories>

2.  <repository>

3.     <id>jitpack.io</id>

4.     <url>https://jitpack.io</url>

5.  </repository>

6. </repositories>

第二步：增加项目依赖

1. <dependency>

2.    <groupId>com.github.yinjihuan</groupId>

3.    <artifactId>monkey-api-encrypt</artifactId>

4.    <version>1.1.1</version>

5. </dependency>

第三步：配置加解密过滤器(Spring Boot中配置方式)

1. @Configuration

2. public class FilterConfig {

3.  

4.    @Bean

5.    public FilterRegistrationBean<EncryptionFilter> filterRegistration() {

6.        EncryptionConfig config = new EncryptionConfig();

7.        config.setKey("abcdef0123456789");

8.        config.setRequestDecyptUriList(Arrays.asList("/save", "/decryptEntityXml"));

9.        config.setResponseEncryptUriList(Arrays.asList("/encryptStr", "/encryptEntity", "/save", "/encryptEntityXml", "/decryptEntityXml"));

10.        FilterRegistrationBean<EncryptionFilter> registration = new FilterRegistrationBean<EncryptionFilter>();

11.        registration.setFilter(new EncryptionFilter(config));

12.        registration.addUrlPatterns("/*");

13.        registration.setName("EncryptionFilter");

14.        registration.setOrder(1);

15.        return registration;

16.    }

17.  

18. }

• EncryptionConfig EncryptionConfig是加解密的配置类，配置项目定义如下：

1. public class EncryptionConfig {

2.  

3.    /**

4.     * AES加密Key，长度必须16

5.     */

6.    private String key = "d7b85f6e214abcda";

7.  

8.    /**

9.     * 需要对响应内容进行加密的接口URI<br>

10.     * 比如：/user/list<br>

11.     * 不支持@PathVariable格式的URI

12.     */

13.    private List<String> responseEncryptUriList = new ArrayList<String>();

14.  

15.    /**

16.     * 需要对请求内容进行解密的接口URI<br>

17.     * 比如：/user/list<br>

18.     * 不支持@PathVariable格式的URI

19.     */

20.    private List<String> requestDecyptUriList = new ArrayList<String>();

21.  

22.    /**

23.     * 响应数据编码

24.     */

25.    private String responseCharset = "UTF-8";

26.  

27.    /**

28.     * 开启调试模式，调试模式下不进行加解密操作，用于像Swagger这种在线API测试场景

29.     */

30.    private boolean debug = false;

31. }

自定义加密算法

内置了AES加密算法对数据进行加解密操作，同时用户可以自定义算法来代替内置的算法。

自定义算法需要实现EncryptAlgorithm接口：

1. /**

2. * 自定义RSA算法

3. *

4. * @author yinjihuan

5. *

6. * @date 2019-01-12

7. *

8. * @about http://cxytiandi.com/about

9. *

10. */

11. public class RsaEncryptAlgorithm implements EncryptAlgorithm {

12.  

13.    public String encrypt(String content, String encryptKey) throws Exception {

14.        return RSAUtils.encryptByPublicKey(content);

15.    }

16.  

17.    public String decrypt(String encryptStr, String decryptKey) throws Exception {

18.        return RSAUtils.decryptByPrivateKey(encryptStr);

19.    }

20.  

21. }

注册Filter的时候指定算法：

1. EncryptionConfig config = new EncryptionConfig();

2. registration.setFilter(new EncryptionFilter(config, new RsaEncry