2. 程式人生 > >SpringBoot中如何靈活的實現介面資料的加解密功能？

SpringBoot中如何靈活的實現介面資料的加解密功能？

阿新 • • 發佈：2019-10-28

資料是企業的第四張名片，企業級開發中少不了資料的加密傳輸，所以本文介紹下SpringBoot中介面資料加密、解密的方式。

本文目錄

一、加密方案介紹二、實現原理三、實戰四、測試五、踩到的坑

一、加密方案介紹

對介面的加密解密操作主要有下面兩種方式：

  1. 自定義訊息轉換器

優勢：僅需實現介面，配置簡單。
劣勢：僅能對同一型別的MediaType進行加解密操作，不靈活。

  1. 使用spring提供的介面RequestBodyAdvice和ResponseBodyAdvice

優勢：可以按照請求的Referrer、Header或url進行判斷，按照特定需要進行加密解密。

比如在一個專案升級的時候，新開發功能的介面需要加解密，老功能模組走之前的邏輯不加密，這時候就只能選擇上面的第二種方式了，下面主要介紹下第二種方式加密、解密的過程。

二、實現原理

RequestBodyAdvice可以理解為在@RequestBody之前需要進行的 操作，ResponseBodyAdvice可以理解為在@ResponseBody之後進行的操作，所以當介面需要加解密時，在使用@RequestBody接收前臺引數之前可以先在RequestBodyAdvice的實現類中進行引數的解密，當操作結束需要返回資料時，可以在@ResponseBody之後進入ResponseBodyAdvice的實現類中進行引數的加密。

RequestBodyAdvice處理請求的過程：

RequestBodyAdvice原始碼如下：

 public interface RequestBodyAdvice {

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


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


    Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
            Type targetType, Class<? extends HttpMessageConverter<?>> converterType);


    @Nullable
    Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage, MethodParameter parameter,
            Type targetType, Class<? extends HttpMessageConverter<?>> converterType);


}

呼叫RequestBodyAdvice實現類的部分程式碼如下：

 protected <T> Object readWithMessageConverters(HttpInputMessage inputMessage, MethodParameter parameter,
            Type targetType) throws IOException, HttpMediaTypeNotSupportedException, HttpMessageNotReadableException {

        MediaType contentType;
        boolean noContentType = false;
        try {
            contentType = inputMessage.getHeaders().getContentType();
        }
        catch (InvalidMediaTypeException ex) {
            throw new HttpMediaTypeNotSupportedException(ex.getMessage());
        }
        if (contentType == null) {
            noContentType = true;
            contentType = MediaType.APPLICATION_OCTET_STREAM;
        }

        Class<?> contextClass = parameter.getContainingClass();
        Class<T> targetClass = (targetType instanceof Class ? (Class<T>) targetType : null);
        if (targetClass == null) {
            ResolvableType resolvableType = ResolvableType.forMethodParameter(parameter);
            targetClass = (Class<T>) resolvableType.resolve();
        }

        HttpMethod httpMethod = (inputMessage instanceof HttpRequest ? ((HttpRequest) inputMessage).getMethod() : null);
        Object body = NO_VALUE;

        EmptyBodyCheckingHttpInputMessage message;
        try {
            message = new EmptyBodyCheckingHttpInputMessage(inputMessage);

            for (HttpMessageConverter<?> converter : this.messageConverters) {
                Class<HttpMessageConverter<?>> converterType = (Class<HttpMessageConverter<?>>) converter.getClass();
                GenericHttpMessageConverter<?> genericConverter =
                        (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
                if (genericConverter != null ? genericConverter.canRead(targetType, contextClass, contentType) :
                        (targetClass != null && converter.canRead(targetClass, contentType))) {
                    if (logger.isDebugEnabled()) {
                        logger.debug("Read [" + targetType + "] as \"" + contentType + "\" with [" + converter + "]");
                    }
                    if (message.hasBody()) {
                        HttpInputMessage msgToUse =
                                getAdvice().beforeBodyRead(message, parameter, targetType, converterType);
                        body = (genericConverter != null ? genericConverter.read(targetType, contextClass, msgToUse) :
                                ((HttpMessageConverter<T>) converter).read(targetClass, msgToUse));
                        body = getAdvice().afterBodyRead(body, msgToUse, parameter, targetType, converterType);
                    }
                    else {
                        body = getAdvice().handleEmptyBody(null, message, parameter, targetType, converterType);
                    }
                    break;
                }
            }
        }
        catch (IOException ex) {
            throw new HttpMessageNotReadableException("I/O error while reading input message", ex);
        }

        if (body == NO_VALUE) {
            if (httpMethod == null || !SUPPORTED_METHODS.contains(httpMethod) ||
                    (noContentType && !message.hasBody())) {
                return null;
            }
            throw new HttpMediaTypeNotSupportedException(contentType, this.allSupportedMediaTypes);
        }

        return body;
    }

從上面原始碼可以到當converter.canRead()和message.hasBody()都為true的時候，會呼叫beforeBodyRead()和afterBodyRead()方法，所以我們在實現類的afterBodyRead()中新增解密程式碼即可。

ResponseBodyAdvice處理響應的過程：

ResponseBodyAdvice原始碼如下：

public interface ResponseBodyAdvice<T> {


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


    @Nullable
    T beforeBodyWrite(@Nullable T body, MethodParameter returnType, MediaType selectedContentType,
            Class<? extends HttpMessageConverter<?>> selectedConverterType,
            ServerHttpRequest request, ServerHttpResponse response);

}

呼叫ResponseBodyAdvice實現類的部分程式碼如下：

if (selectedMediaType != null) {
            selectedMediaType = selectedMediaType.removeQualityValue();
            for (HttpMessageConverter<?> converter : this.messageConverters) {
                GenericHttpMessageConverter genericConverter =
                        (converter instanceof GenericHttpMessageConverter ? (GenericHttpMessageConverter<?>) converter : null);
                if (genericConverter != null ?
                        ((GenericHttpMessageConverter) converter).canWrite(declaredType, valueType, selectedMediaType) :
                        converter.canWrite(valueType, selectedMediaType)) {
                    outputValue = (T) getAdvice().beforeBodyWrite(outputValue, returnType, selectedMediaType,
                            (Class<? extends HttpMessageConverter<?>>) converter.getClass(),
                            inputMessage, outputMessage);
                    if (outputValue != null) {
                        addContentDispositionHeader(inputMessage, outputMessage);
                        if (genericConverter != null) {
                            genericConverter.write(outputValue, declaredType, selectedMediaType, outputMessage);
                        }
                        else {
                            ((HttpMessageConverter) converter).write(outputValue, selectedMediaType, outputMessage);
                        }
                        if (logger.isDebugEnabled()) {
                            logger.debug("Written [" + outputValue + "] as \"" + selectedMediaType +
                                    "\" using [" + converter + "]");
                        }
                    }
                    return;
                }
            }
        }

從上面原始碼可以到當converter.canWrite()為true的時候，會呼叫beforeBodyWrite()方法，所以我們在實現類的beforeBodyWrite()中新增解密程式碼即可。

三、實戰

新建一個spring boot專案spring-boot-encry，按照下面步驟操作。

  1. pom.xml中引入jar
  <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.60</version>
        </dependency>
    </dependencies>
  1. 請求引數解密攔截類

DecryptRequestBodyAdvice程式碼如下：

/**
 * 請求引數 解密操作
 *
 * @Author: Java碎碎念
 * @Date: 2019/10/24 21:31
 *
 */
@Component
@ControllerAdvice(basePackages = "com.example.springbootencry.controller")
@Slf4j
public class DecryptRequestBodyAdvice implements RequestBodyAdvice {


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

    @Override
    public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> selectedConverterType) throws IOException {
        return inputMessage;
    }

    @Override
    public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
        String dealData = null;
        try {
            //解密操作
            Map<String,String> dataMap = (Map)body;
            String srcData = dataMap.get("data");
            dealData = DesUtil.decrypt(srcData);
        } catch (Exception e) {
            log.error("異常！", e);
        }
        return dealData;
    }


    @Override
    public Object handleEmptyBody(@Nullable Object var1, HttpInputMessage var2, MethodParameter var3, Type var4, Class<? extends HttpMessageConverter<?>> var5) {
        log.info("3333");
        return var1;
    }


}
  1. 響應引數加密攔截類

EncryResponseBodyAdvice程式碼如下：

/**
 * 請求引數 解密操作
 *
 * @Author: Java碎碎念
 * @Date: 2019/10/24 21:31
 *
 */
@Component
@ControllerAdvice(basePackages = "com.example.springbootencry.controller")
@Slf4j
public class EncryResponseBodyAdvice implements ResponseBodyAdvice<Object> {


    @Override
    public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object obj, MethodParameter returnType, MediaType selectedContentType,
                                  Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest serverHttpRequest,
                                  ServerHttpResponse serverHttpResponse) {
        //通過 ServerHttpRequest的實現類ServletServerHttpRequest 獲得HttpServletRequest
        ServletServerHttpRequest sshr = (ServletServerHttpRequest) serverHttpRequest;
        //此處獲取到request 是為了取到在攔截器裡面設定的一個物件 是我專案需要,可以忽略
        HttpServletRequest request = sshr.getServletRequest();

        String returnStr = "";

        try {
            //新增encry header，告訴前端資料已加密
            serverHttpResponse.getHeaders().add("encry", "true");
            String srcData = JSON.toJSONString(obj);
            //加密
            returnStr = DesUtil.encrypt(srcData);
            log.info("介面={},原始資料={},加密後資料={}", request.getRequestURI(), srcData, returnStr);

        } catch (Exception e) {
            log.error("異常！", e);
        }
        return returnStr;
    }
  1. 新建controller類

TestController程式碼如下：

/**
 * @Author: Java碎碎念
 * @Date: 2019/10/24 21:40
 */
@RestController
public class TestController {

    Logger log = LoggerFactory.getLogger(getClass());

    /**
     * 響應資料 加密
     */
    @RequestMapping(value = "/sendResponseEncryData")
    public Result sendResponseEncryData() {
        Result result = Result.createResult().setSuccess(true);
        result.setDataValue("name", "Java碎碎念");
        result.setDataValue("encry", true);
        return result;
    }

    /**
     * 獲取 解密後的 請求引數
     */
    @RequestMapping(value = "/getRequestData")
    public Result getRequestData(@RequestBody Object object) {
        log.info("controller接收的引數object={}", object.toString());
        Result result = Result.createResult().setSuccess(true);
        return result;
    }
}
  1. 其他類在原始碼中，後面有github地址

四、測試

  1. 訪問響應資料加密介面

使用postman發請求http://localhost:8888/sendResponseEncryData，可以看到返回資料已加密，請求截圖如下：


響應資料加密截圖

後臺也列印相關的日誌，內容如下：

介面=/sendResponseEncryData

原始資料={"data":{"encry":true,"name":"Java碎碎念"},"success":true}

加密後資料=vJc26g3SQRU9gAJdG7rhnAx6Ky/IhgioAgdwi6aLMMtyynAB4nEbMxvDsKEPNIa5bQaT7ZAImAL7
3VeicCuSTA==
  1. 訪問請求資料解密介面

使用postman發請求http://localhost:8888/getRequestData，可以看到請求資料已解密，請求截圖如下：


請求資料解密截圖

後臺也列印相關的日誌，內容如下：

接收到原始請求資料={"data":"VwLvdE8N6FuSxn/jRrJavATopaBA3M1QEN+9bkuf2jPwC1eSofgahQ=="}

解密後資料={"name":"Java碎碎念","des":"請求引數"}

五、踩到的坑

  1. 測試解密請求引數時候，請求體一定要有資料，否則不會呼叫實現類觸發解密操作。

到此SpringBoot中如何靈活的實現介面資料的加解密功能的功能已經全部實現，有問題歡迎留言溝通哦！

完整原始碼地址： https://github.com/suisui2019/springboot-study

點選文章底部”閱讀原文“可以直達原始碼地址。

推薦閱讀

1.SpringBoot中神奇的@Enable*註解？
2.Java中Integer.parseInt和Integer.valueOf，你還傻傻分不清嗎？
3.SpringCloud系列-整合Hystrix的兩種方式
4.SpringCloud系列-利用Feign實現宣告式服務呼叫
5.手把手帶你利用Ribbon實現客戶端的負載均衡

限時領取免費Java相關資料，涵蓋了Java、Redis、MongoDB、MySQL、Zookeeper、Spring Cloud、Dubbo/Kafka、Hadoop、Hbase、Flink等高併發分散式、大資料、機器學習等技術。
關注下方公眾號即可免費領取：

Java碎碎念公眾號

 

相關推薦

Spring 介面資料加解密---全域性加解密篇

Spring 介面資料加解密—全域性加解密篇 資料加密傳輸 加解密處理 自定義message-converters 小結 資料加密傳輸 企業級開發，是缺少不了資料的加密傳輸。如若不是，請自重。微信公共號的開發便提供AES加密處理，提高公共號的安全性

SpringBoot中如何靈活的實現介面資料的加解密功能？

資料是企業的第四張名片，企業級開發中少不了資料的加密傳輸，所以本文介紹下SpringBoot中介面資料加密、解密的方式。 本文目錄 一、加密方案介紹二、實現原理三、實戰四、測試五、踩到的坑 一、加密方案介紹 對介面的加密解密操作主要有下面兩種方式： 自定義訊息轉換器 優勢：僅需

Springboot框架，實現請求資料解密，響應資料加密的功能。

一、簡要說明： 　　在做這個功能的時候，參考了很多文章，也試了用過濾器解決。但總體來說還是很麻煩，所以換了另一種解決方案。直接實現RequestBodyAdvice和ResponseBodyAdvice兩個介面 ，進行加密解密處理。 　　關於RequestBodyAdvice和ResponseBodyAd

資料加解密基礎知識介紹，及Java實現Base64加密

加密流程涉及的一些關鍵詞： 明文：準備加密的資訊 加密：把明文處理為密文的過程 加密演算法：具體實現明文轉為密文的演算法 加密金鑰：通過加密演算法進行加密操作需要的金鑰 密文：被加密的明文 解密：將密文轉為明文的過程 解密演算法：具體實現密文轉為明文的演算法 解

Java中使用OpenSSL RSA公私鑰進行資料加解密儲存

使用openSSL 生成公私鑰可以參考作者 JackCousins 的文章 @http://blog.csdn.net/chaijunkun/article/details/7275632 寫的非常好，鼓掌 但在使用的過程中發現 ，例如 我在手機中可以使用公鑰簽名，伺服器

js實現對url引數中數字字母的簡單加解密

function compile(code) { var c=String.fromCharCode(code.charCodeAt(0)+code.length); for

Java中使用OpenSSL生成的RSA公私鑰進行資料加解密

RSA是什麼：RSA公鑰加密演算法是1977年由Ron Rivest、Adi Shamirh和LenAdleman在（美國麻省理工學院）開發的。RSA取名來自開發他們三者的名字。RSA是目前最有影響力的公鑰加密演算法，它能夠抵抗到目前為止已知的所有密碼攻擊，已被ISO推薦為公

Springboot中Aspect實現切面（以記錄日誌為例）

前言今天我們來說說spring中的切面Aspect，這是Spring的一大優勢。面向切面程式設計往往讓我們的開發更加低耦合，也大大減少了程式碼量，同時呢讓我們更專注於業務模組的開發，把那些與業務無關的東西提取出去，便於後期的維護和迭代。 好了，廢話少說！我們直接步入正題 以系統日誌為例首先，我們先做一些準

JAVA中如何實現日期的加減運算

JAVA中實現日期的加減運算方法 一、用java.util.Calender來實現 Calendar calendar=Calendar.getInstance(); calendar.setTime(new Date()); System.out.printl

軟實現非對稱加解密，公鑰證書與公鑰值區別，包含提取公約值程式碼

目前有部分未採購簽名驗籤伺服器的企業，採用軟實現做非對稱、對稱加解密，本文簡略說明一下工作過程中遇到的問題。 本交易涉及傳送方，接收方 問題背景： 對方即接收方採用的是軟實現，並且只提供了公鑰值（未經CA簽發） 我方即傳送方，採用的是硬體簽名驗籤服務。伺服器中存有我方的私鑰，

SpringBoot中利用MyBatis進行資料操作

本例所用環境： SpringBoot MySQL MyBatis jdk1.8 Maven 首先我們先建立一個SpringBoot 專案。 資料庫連線配置 ##資料庫連線配置(部署到哪臺，對應的ip需修改) spring.datasource.url=jdbc

研究基於spring通過對http請求資料的預處理（資料加解密、校驗、日誌）（2）過攔截器篇

上文已經詳細講解了如何對request進行處理，本文主要是案例演示 spring MVC 的寫法 新增攔截器 定義一個攔截器 public class AppRequestIntercept

SpringMVC中EhCache實現快取資料

       EhCache 是一個純Java的程序內快取框架，具有快速、精幹等特點，是Hibernate中預設CacheProvider。Ehcache是一種廣泛使用的開源Java分散式快取。主要面向通用快取,Java EE和輕量級容器。它具有記憶體和磁碟儲存，快取載入器,

C/C++ 實現檔案透明加解密

                 今日遇見一個開超市的朋友，真沒想到在高校開超市一個月可以達到月淨利潤50K，相比起我們程式設計師的工資，真是不可同日而語，這個世道啊，真是做程式設計師不如經商開超市，我們高科技的從業者，真是造原子彈不如賣茶葉蛋。請見程式碼詳細註釋//  修復涉及後視列表的Win2K相容性//

go實現橢圓曲線加解密、簽名驗證演算法（go ecdsa庫的運用），及生成比特幣地址過程講解、base58實現

go實現橢圓曲線加解密、簽名驗證演算法（go ecdsa庫的運用），及生成比特幣地址過程講解、BASE58實現 前言 本文主要講解使用Go的ecdsa庫實現橢圓曲線加解密、簽名、驗證演算法，同時通過公鑰生成比特幣地址，具體程式碼邏輯參考bitcoin0

前端傳輸安全，資料加解密

在前後端資料傳輸過程中，我們經常會面臨資料被竊取的風險，我們的資訊在每個轉發的路由都有檢視和獲得我們資訊的能力，尤其是當我們是http連線時，一切都是明文傳輸，沒有了一點隱私，那麼我們要如何儘可能保證我們資料傳輸的私密性，安全性呢，下面我們介紹一種加密方式，開發環境為node.js; 私

js中double型別的資料加減的時候出錯

今天在寫js中的簡單演算法的時候遇到一個奇怪的現象: 在資料相減的時候出現小數,且小數點後面還有一串的數; 想到使用的是double型別,可能是這個原因,百度了下果然是這個原因 連線如下 https://www.cnblogs.com/yanweidie/p/35610

python中如何實現將資料分成訓練集與測試集

接下來，直接給出大家響應的程式碼，並對每一行進行標註，希望能夠幫到大家。 需要用到的是庫是。numpy 、sklearn。 #匯入相應的庫（對資料庫進行切分需要用到的庫是sklearn.model

Extjs4中combobox控制元件-資料加載出來，但一直在loading.

Extjs4中combobox控制元件---資料加載出來，但一直在loading....      今天在做combo級聯的時候碰到這個問題，很令人頭疼，反覆檢查程式碼，並沒發現有什麼問題；而且更令人詫異的是，在我同事的機器上執行卻是好好地，而且他用的ie版本跟我的版本一樣

idea基於maven搭建springBoot專案並實現介面呼叫

本來這篇部落格早就應該寫了但是最近找工作有些忙就落下了 今天閒來無事就來補上了,SpringBoot就是將SpringMVC替換成SpringBoot依舊是SSM框架 建立依舊由idea+maven來進行 好了接下來我們首先new一個新的project 然後直接next 依照我的習慣