一般的開發(fā)框架都會對網(wǎng)絡(luò)的報文格式進行統(tǒng)一的設(shè)計航背，這樣可以把一些公共的內(nèi)容放在報文的公共區(qū)域喉悴，這樣就可以在框架中設(shè)計一些公共模塊進行統(tǒng)一處理。例如統(tǒng)一的報文加解密玖媚、簽名驗簽箕肃、權(quán)限校驗等動作都可以將這些內(nèi)容設(shè)計在報文頭和報文體的公共部分，然后通過過濾器或攔截器進行統(tǒng)一處理今魔。今天的文章我們就介紹下設(shè)計一個統(tǒng)一的請求和返回報文勺像，然后再定義一個方法處理器進行網(wǎng)絡(luò)報文的統(tǒng)一加解密處理。當然要實現(xiàn)這樣的方法還有很多辦法可以實現(xiàn)错森，文章最后會介紹下還有哪些方法可以實現(xiàn)一樣的效果咏删。
定義統(tǒng)一請求和返回報文實體類
首先我們先定義統(tǒng)一請求類為MkRequest，可以看到這個請求類數(shù)據(jù)結(jié)構(gòu)中定義了sign表示報文簽名问词，還有一個Map類型的data，里面保存的是報文請求參數(shù)嘀粱，這里的統(tǒng)一報文格式激挪，大家可以根據(jù)自己公司或項目的要求進行自定義辰狡，這里筆者只是拋磚引玉。
public class MkRequest implements Serializable {
private String sign;
private Map data;
//...getter\setter
}
再來定義個統(tǒng)一返回類MkResponse垄分，MkResponse類繼承自HashMap宛篇，所以主體其實還是一個Map類型，可以在類中定義返回報文的公共字段薄湿，正確叫倍、錯誤時候的公共字段都可以在這里定義，這樣設(shè)計的好處就是在任何的controller中可以直接定義出格式一樣的返回報文豺瘤，如果格式修改也可以只需要修改一個地方就可以完成整體格式的變動吆倦。
public class MkResponse extends HashMap<String, Object> {
private static final long serialVersionUID = 1L;
public MkResponse() {
put("returnCode", ResultCode.SUCCESS.getCode());
put("returnMsg", ResultCode.SUCCESS.getMessage());
}
//...這里的代碼省略了很多error和ok方法的重載，大家可以在源碼中查看全部代碼
public static MkResponse error(String returnCode, String returnMsg, String errorCode, String errorMsg) {
MkResponse r = new MkResponse();
r.put("returnCode", returnCode);
r.put("returnMsg", returnMsg);
r.put("errorCode", errorCode);
r.put("errorMsg", errorMsg);
return r;
}
public static MkResponse ok(String msg) {
MkResponse r = new MkResponse();
r.put("msg", msg);
return r;
}
public static MkResponse ok(Map<String, Object> map) {
MkResponse r = new MkResponse();
r.putAll(map);
return r;
}
@Override
public MkResponse put(String key, Object value) {
super.put(key, value);
return this;
}
}
定義加密參數(shù)注解
在現(xiàn)在對網(wǎng)絡(luò)安全越來越重視的今天坐求，我們的框架中也增加了報文加密的功能蚕泽，這里為了保證侵入性最小是通過對controller輸入使用自定義注解，并對方法參數(shù)進行處理的方式來完成解密動作桥嗤。
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface MkParams {
}
看下在controller中怎么使用MkParams注解须妻。
@PostMapping("/des")
public String testDesController(@MkParams MkRequest data){
return data.getSign() + data.getData().get("name");
}
要想得到正確的返回，需要上送的報文也是經(jīng)過加密的泛领，這里我們使用的是AES對稱加密荒吏。
定義解密方法處理器
對于需要對函數(shù)方法入?yún)⒆⒔膺M行處理的話，需要定義個Resolver渊鞋，這個處理器必須實現(xiàn)HandlerMethodArgumentResolver的的兩個方法：
public boolean supportsParameter(MethodParameter methodParameter)绰更；
public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer,
NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory)；
supportsParameter方法需要重寫對哪些參數(shù)進行處理篓像，可以處理的參數(shù)返回true动知，其他不支持的類型返回false。
resolveArgument方法就是實際的對入?yún)⑦M行處理的方法了员辩，返回的是處理后的結(jié)果盒粮，這里實現(xiàn)解密的動作，方法先從httprequest中獲取到http報文的body奠滑，然后根據(jù)參數(shù)配置的加密方法去選擇加密算法是3des還是aes丹皱，參數(shù)可以在yml配置文件中配置，可以通過3個參數(shù)控制宋税，可以控制是否加密摊崭、用哪個加密算法、加密秘鑰杰赛，大家也可以根據(jù)自己的需要添加加密算法呢簸，只要在這個實現(xiàn)方法中加上就可以了。這里加密我們用的是hutool封裝好的對稱加解密類，使用起來還是很方便的根时。
@Component
public class DesParamsHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
private Logger logger = LoggerFactory.getLogger(getClass());
@Value("${mk.encrypt}")
private boolean isEncrypt;
@Value("${mk.key}")
private String key;
@Value("${mk.encryptAlgo}")
private String encryptAlgo;
@Override
public boolean supportsParameter(MethodParameter methodParameter) {
return isAssignAbleFrom(methodParameter) && methodParameter.hasParameterAnnotation(MkParams.class);
}
private boolean isAssignAbleFrom(MethodParameter parameter) {
return parameter.getParameterType().isAssignableFrom(String.class) || parameter.getParameterType().isAssignableFrom(JSONObject.class)
||parameter.getParameterType().isAssignableFrom(MkRequest.class);
}
@Override
public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer,
NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory) throws Exception {
HttpServletRequest httpRequest = nativeWebRequest.getNativeRequest(HttpServletRequest.class);
String data = HttpUtil.getString(httpRequest.getInputStream(), null, true);
if(isEncrypt == false){
//未配置加密則直接返回
return data;
}
logger.debug("上送未加密報文：" + data);
SymmetricCrypto crypto;
if(encryptAlgo.equalsIgnoreCase("des")) {
crypto = new SymmetricCrypto(SymmetricAlgorithm.DES, key.getBytes());
}else{
crypto = new SymmetricCrypto(SymmetricAlgorithm.AES, key.getBytes());
}
data = crypto.decryptStr(data, CharsetUtil.CHARSET_UTF_8);
logger.debug("上送解密報文：" + data);
MkRequest mkRequest = JSONObject.parseObject(data, MkRequest.class);
return mkRequest;
}
}
如何使用
下面我們來看看如何使用瘦赫，服務(wù)端做了參數(shù)的解密，當然就需要在client調(diào)用的時候進行加密了蛤迎，加密同樣可以使用hutool封裝好的加密庫進行操作确虱。下面我在測試類中實現(xiàn)了將明文加密為密文的過程，在實際的客戶端中同樣可以使用這段代碼進行加密后放入http body中進行傳輸替裆。
@RunWith(SpringRunner.class)
public class DESTest {
private String key = "6B@5b7a8434";
@Test
public void testDes(){
String content = "{\"sign\":\"23213424234324\",\"data\":{\"id\":\"1\",\"name\":\"monkey01\"}}";
String keyStr = key.toString();
System.out.println("===" + keyStr);
SymmetricCrypto des = new SymmetricCrypto(SymmetricAlgorithm.DES, keyStr.getBytes());
//加密為16進制表示
String encryptHex = des.encryptHex(content);
System.out.println(encryptHex);
//6b0c49d4766817df4609b986fd232c0a005cb83004f11fa1ebcf711400d670736417b40279b4bc1f062028642db0a75014435a11dedd748c3c10f40eb512ab6d
}
}
上面在最后一行System.out輸出的就是上面content變量加密后的密文校辩，我們可以將這段密文作為下面測試的輸入。
接下來我們在TestController中定義一個方法如下,并在入?yún)⒗锛由螥MkParams注解辆童，之前定義的Resolver類會將MkRequest對象中的字段解密為明文對象：
@PostMapping("/des")
public String testDesController(@MkParams MkRequest data){
return data.getSign() + data.getData().get("name");
}
最后就是測試有沒有作用了宜咒，大家可以用類似postman這樣的發(fā)包工具，將上面的加密后的密文作為http的body進行請求胸遇，如果是用github上源碼直接跑的朋友荧呐，將工程啟動起來以后可以在發(fā)包工具中輸入http://localhost:8090/mk/des，在body中輸入上面用test方法輸出的密文跑下纸镊，看看是不是輸出了明文內(nèi)容倍阐。
總結(jié)
上面我們框架中對加解密的處理是通過在controller方法的入?yún)⑹褂米⒔馓幚砥鱽硖幚碚埱髨笪牡慕饷懿僮鳎斎蝗绻龅酵耆珶o感還可以通過定義Filter來實現(xiàn)逗威，在httprequest進入controller或servlet之前進行加解密處理峰搪，將解密后的明文放到報文體中替換原來的密文，這里需要注意到的是httprequest中的內(nèi)容是無法修改的凯旭，并且調(diào)用了getInputStream概耻、getReader這些方法后就無法再次獲取到報文體的內(nèi)容，那么怎么去修改httprequest報文體的內(nèi)容呢罐呼？我們可以定義一個HttpRequestWrapper這樣的裝飾器鞠柄，然后在Filter類中修改裝飾器中的報文體，將解密后的報文體賦值給裝飾器對象的報文體嫉柴，再通過Filter的dochain方法傳遞下去厌杜，那么在controller的方法或者servlet中獲取到的就是修改過報文體的裝飾器對象，也就同樣可以實現(xiàn)報文的解密操作计螺，大家如果覺得筆者這種使用注解方法不太好實現(xiàn)夯尽，那么也可以使用在filter中httprequest裝飾器的方式來實現(xiàn)報文的統(tǒng)一加解密操作。
本文對應(yīng)的github tag為v0.3登馒，可以通過連接下載https://github.com/feiweiwei/MkFramework4java/releases/tag/v0.3匙握，也可以通過git clone -b v0.3 https://github.com/feiweiwei/MkFramework4java.git
