[轉]使用自定義HttpMessageConverter對返回內容進行加密
今天上午技術群裏的一個人問” 如何在 Spring MVC 中統一對返回的 Json 進行加密？”。
大部分人的第一反應是通過 Spring 攔截器（Interceptor）中的postHandler方法處理。實際這是行不通的，因為當程序運行到該方法，是在返回數據之後，渲染頁面之前，所以這時候 Response 中的輸出流已經關閉了，自然無法在對返回數據進行處理。
其實這個問題用幾行代碼就可以搞定，因為 Spring 提供了非常豐富的擴展支持，無論是之前提到的Interceptor和MethodArgumentResolver，還是接下來要提到的HttpMessageConverter
在 Spring MVC 的 Controller 層經常會用到@RequestBody和@ResponseBody，通過這兩個註解，可以在 Controller 中直接使用 Java 對象作為請求參數和返回內容，而完成這之間轉換作用的便是HttpMessageConverter。
HttpMessageConverter接口提供了 5 個方法：
canRead：判斷該轉換器是否能將請求內容轉換成 Java 對象canWrite：判斷該轉換器是否可以將 Java 對象轉換成返回內容getSupportedMediaTypes：獲得該轉換器支持的 MediaType 類型read：讀取請求內容並轉換成 Java 對象-
write：將 Java 對象轉換後寫入返回內容其中
read和write方法的參數分別有有HttpInputMessage和HttpOutputMessage對象，這兩個對象分別代表著一次 Http 通訊中的請求和響應部分，可以通過getBody方法獲得對應的輸入流和輸出流。這裏通過實現該接口自定義一個 Json 轉換器作為示例：
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 | class CustomJsonHttpMessageConverter implements HttpMessageConverter { //Jackson 的 Json 映射類 private ObjectMapper mapper = new ObjectMapper (); // 該轉換器的支持類型：application/json private List supportedMediaTypes = Arrays.asList (MediaType.APPLICATION_JSON); /** * 判斷轉換器是否可以將輸入內容轉換成 Java 類型 * @param clazz 需要轉換的 Java 類型 * @param mediaType 該請求的 MediaType * @return */ @Override public boolean canRead (Class clazz, MediaType mediaType) { if (mediaType == null) { return true; } for (MediaType supportedMediaType : getSupportedMediaTypes ()) { if (supportedMediaType.includes (mediaType)) { return true; } } return false; } /** * 判斷轉換器是否可以將 Java 類型轉換成指定輸出內容 * @param clazz 需要轉換的 Java 類型 * @param mediaType 該請求的 MediaType * @return */ @Override public boolean canWrite (Class clazz, MediaType mediaType) { if (mediaType == null || MediaType.ALL.equals (mediaType)) { return true; } for (MediaType supportedMediaType : getSupportedMediaTypes ()) { if (supportedMediaType.includes (mediaType)) { return true; } } return false; } /** * 獲得該轉換器支持的 MediaType * @return */ @Override public List getSupportedMediaTypes () { return supportedMediaTypes; } /** * 讀取請求內容，將其中的 Json 轉換成 Java 對象 * @param clazz 需要轉換的 Java 類型 * @param inputMessage 請求對象 * @return * @throws IOException * @throws HttpMessageNotReadableException */ @Override public Object read (Class clazz, HttpInputMessage inputMessage) throws IOException, HttpMessageNotReadableException { return mapper.readValue (inputMessage.getBody (), clazz); } /** * 將 Java 對象轉換成 Json 返回內容 * @param o 需要轉換的對象 * @param contentType 返回類型 * @param outputMessage 回執對象 * @throws IOException * @throws HttpMessageNotWritableException */ @Override public void write (Object o, MediaType contentType, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException { mapper.writeValue (outputMessage.getBody (), o); } } |
當前 Spring 中已經默認提供了相當多的轉換器，分別有：
| 名稱 | 作用 | 讀支持 MediaType | 寫支持 MediaType |
|---|---|---|---|
| ByteArrayHttpMessageConverter | 數據與字節數組的相互轉換 | \/\ | application/octet-stream |
| StringHttpMessageConverter | 數據與 String 類型的相互轉換 | text/\* | text/plain |
| FormHttpMessageConverter | 表單與 MultiValueMap的相互轉換 | application/x-www-form-urlencoded | application/x-www-form-urlencoded |
| SourceHttpMessageConverter | 數據與 javax.xml.transform.Source 的相互轉換 | text/xml 和 application/xml | text/xml 和 application/xml |
| MarshallingHttpMessageConverter | 使用 Spring 的 Marshaller/Unmarshaller 轉換 XML 數據 | text/xml 和 application/xml | text/xml 和 application/xml |
| MappingJackson2HttpMessageConverter | 使用 Jackson 的 ObjectMapper 轉換 Json 數據 | application/json | application/json |
| MappingJackson2XmlHttpMessageConverter | 使用 Jackson 的 XmlMapper 轉換 XML 數據 | application/xml | application/xml |
| BufferedImageHttpMessageConverter | 數據與 java.awt.image.BufferedImage 的相互轉換 | Java I/O API 支持的所有類型 | Java I/O API 支持的所有類型 |
回到最開始所提的需求，既然要對返回的 Json 內容進行加密，肯定是對MappingJackson2HttpMessageConverter進行改造，並且只需要重寫write方法。
從MappingJackson2HttpMessageConverter的父類AbstractHttpMessageConverter中的write方法可以看出，該方法通過writeInternal方法向返回結果的輸出流中寫入數據，所以只需要重寫該方法即可:
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 | @Bean public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter () { return new MappingJackson2HttpMessageConverter () { // 重寫 writeInternal 方法，在返回內容前首先進行加密 @Override protected void writeInternal (Object object, HttpOutputMessage outputMessage) throws IOException, HttpMessageNotWritableException { // 使用 Jackson 的 ObjectMapper 將 Java 對象轉換成 Json String ObjectMapper mapper = new ObjectMapper (); String json = mapper.writeValueAsString (object); LOGGER.error (json); // 加密 String result = json + "加密了！"; LOGGER.error (result); // 輸出 outputMessage.getBody ().write (result.getBytes ()); } }; } |
在這之後還需要將這個自定義的轉換器配置到 Spring 中，這裏通過重寫WebMvcConfigurer中的configureMessageConverters方法添加自定義轉換器：
| 1 2 3 4 5 6 | // 添加自定義轉換器 @Override public void configureMessageConverters (List> converters) { converters.add (mappingJackson2HttpMessageConverter ()); super.configureMessageConverters (converters); } |
測試一下：
如此便簡單的完成了對返回內容進行加密的功能。
（原文地址：http://www.scienjus.com/custom-http-message-converter/）
[轉]使用自定義HttpMessageConverter對返回內容進行加密