之前有寫過一篇加密的文章《前後端API互動如何保證資料安全性》。

主要是在Spring Boot中如何對介面的資料進行自動加解密操作，透過註解的方式來指定是否需要加解密。

原理也很簡單，透過Spring提供的RequestBodyAdvice和ResponseBodyAdvice就可以對請求響應做處理。

本來也是打算更新一下的，因為在Spring Cloud Zuul中也需要加解密，我的那個封裝就用不了。

恰巧上週肥朝大佬跟我聊了下，提供了一些非常有用的建議，於是週六花了一天時間重構了一下加密的框架，不再以Spring Boot Starter的方式提供服務，直接是一個jar包，基於Servlet層面來對資料進行加解密處理。

相比之前的變化：

內建AES加密演算法，可以配置不同的加密key
不再繫結Spring Boot，透過配置Filter即可使用加解密
Spring Cloud Zuul框架也可以支援
支援使用者自定義加密演算法

GitHub地址：

示例程式碼：/tree/master/encrypt-springboot-example

monkey-api-encrypt沒有釋出到Maven中央倉庫，只發布到jitpack這個倉庫，大家也可以自行下載原始碼打包傳到自己公司的私服上。

自動加解密的好處

傳統做法如下：

// 客戶端傳來的資料就是加密好的字串public String add(String data) {   // 1. 透過工具類將資料解密，然後序列化成物件使用   // 2. 處理業務邏輯，資料返回的時候用工具類將資料加密返回給客戶端}

缺點是在每個業務方法中都要手動的去處理加解密的邏輯。

透過使用monkey-api-encrypt的話可以讓開發人員不需要關注加解密的邏輯，比如：

@PostMapping("/save")public UserResult add(@RequestBody User data) {    UserResult  result = new UserResult ();    result.setXXX....    return result;}

上面的程式碼跟平常寫的一模一樣，沒有加解密的邏輯，需要對資料做加解密邏輯的時候，只需要配置一個過濾器，然後指定哪些URI需要加解密即可。下面來學習下如何使用monkey-api-encrypt。

快速使用

下面以jitpack倉庫示列

第一步：pom.xml中增加倉庫地址

<repositories>  <repository>     <id>jitpack.io</id>     <url>

第二步：增加專案依賴

<dependency>    <groupId>com.github.yinjihuan</groupId>    <artifactId>monkey-api-encrypt</artifactId>    <version>1.1.1</version></dependency>

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

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean<EncryptionFilter> filterRegistration() {
        EncryptionConfig config = new EncryptionConfig();
        config.setKey("abcdef0123456789");
        config.setRequestDecyptUriList(Arrays.asList("/save", "/decryptEntityXml"));
        config.setResponseEncryptUriList(Arrays.asList("/encryptStr", "/encryptEntity", "/save", "/encryptEntityXml", "/decryptEntityXml"));
        FilterRegistrationBean<EncryptionFilter> registration = new FilterRegistrationBean<EncryptionFilter>();
        registration.setFilter(new EncryptionFilter(config));
        registration.addUrlPatterns("/*");
        registration.setName("EncryptionFilter");
        registration.setOrder(1);
        return registration;
    }

}

EncryptionConfig EncryptionConfig是加解密的配置類，配置專案定義如下：

public class EncryptionConfig {

    /**
     * AES加密Key，長度必須16
     */
    private String key = "d7b85f6e214abcda";

    /**
     * 需要對響應內容進行加密的介面URI<br>
     * 比如：/user/list<br>
     * 不支援@PathVariable格式的URI
     */
    private List<String> responseEncryptUriList = new ArrayList<String>();

    /**
     * 需要對請求內容進行解密的介面URI<br>
     * 比如：/user/list<br>
     * 不支援@PathVariable格式的URI
     */
    private List<String> requestDecyptUriList = new ArrayList<String>();

    /**
     * 響應資料編碼
     */
    private String responseCharset = "UTF-8";

    /**
     * 開啟除錯模式，除錯模式下不進行加解密操作，用於像Swagger這種線上API測試場景
     */
    private boolean debug = false;
}

自定義加密演算法

內建了AES加密演算法對資料進行加解密操作，同時使用者可以自定義演算法來代替內建的演算法。

自定義演算法需要實現EncryptAlgorithm介面：

/**
 * 自定義RSA演算法
 * 
 * @author yinjihuan
 * 
 * @date 2019-01-12
 * 
 * @about 
 *
 */
public class RsaEncryptAlgorithm implements EncryptAlgorithm {

    public String encrypt(String content, String encryptKey) throws Exception {
        return RSAUtils.encryptByPublicKey(content);
    }

    public String decrypt(String encryptStr, String decryptKey) throws Exception {
        return RSAUtils.decryptByPrivateKey(encryptStr);
    }

}

註冊Filter的時候指定演算法：

EncryptionConfig config = new EncryptionConfig();registration.setFilter(new EncryptionFilter(config, new RsaEncryptAlgorithm()));

常見問題

1. Spring Cloud Zuul中如何使用？

使用方式和Spring Boot中一樣，沒區別。

2. 如果需要所有請求都做加解密處理怎麼辦？

預設不配置RequestDecyptUriList和ResponseEncryptUriList的情況下，就會對所有請求進行處理（攔截器指定範圍內的請求）

3. Swagger測試介面的時候怎麼處理？

可以開啟除錯模式，就不對請求做加解密處理，透過配置debug=true

4. RequestDecyptUriList和ResponseEncryptUriList能否支援/user/*模式匹配？

過濾器本身就有這個功能了，所以框架中是完全匹配相等才可以，可以透過過濾器的 registration.addUrlPatterns("/user/","/order/");來指定需要處理的介面地址。

API資料加密框架monkey-api-encrypt