动手写个java快速开发框架－（3）统一网络请求和加解密

一般的开发框架都会对网络的报文格式进行统一的设计，这样可以把一些公共的内容放在报文的公共区域，这样就可以在框架中设计一些公共模块进行统一处理。例如统一的报文加解密、签名验签、权限校验等动作都可以将这些内容设计在报文头和报文体的公共部分，然后通过过滤器或拦截器进行统一处理。今天的文章我们就介绍下设计一个统一的请求和返回报文，然后再定义一个方法处理器进行网络报文的统一加解密处理。当然要实现这样的方法还有很多办法可以实现，文章最后会介绍下还有哪些方法可以实现一样的效果。

定义统一请求和返回报文实体类

首先我们先定义统一请求类为MkRequest，可以看到这个请求类数据结构中定义了sign表示报文签名，还有一个Map类型的data，里面保存的是报文请求参数，这里的统一报文格式，大家可以根据自己公司或项目的要求进行自定义，这里笔者只是抛砖引玉。

public class MkRequest implements Serializable {
    private String sign;
    private Map data;
    //...getter\setter
}

再来定义个统一返回类MkResponse，MkResponse类继承自HashMap，所以主体其实还是一个Map类型，可以在类中定义返回报文的公共字段，正确、错误时候的公共字段都可以在这里定义，这样设计的好处就是在任何的controller中可以直接定义出格式一样的返回报文，如果格式修改也可以只需要修改一个地方就可以完成整体格式的变动。

public class MkResponse extends HashMap {
    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 map) {
        MkResponse r = new MkResponse();
        r.putAll(map);
        return r;
    }
    
    @Override
    public MkResponse put(String key, Object value) {
        super.put(key, value);
        return this;
    }
}

定义加密参数注解

在现在对网络安全越来越重视的今天，我们的框架中也增加了报文加密的功能，这里为了保证侵入性最小是通过对controller输入使用自定义注解，并对方法参数进行处理的方式来完成解密动作。

@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");
}

要想得到正确的返回，需要上送的报文也是经过加密的，这里我们使用的是AES对称加密。

定义解密方法处理器

对于需要对函数方法入参注解进行处理的话，需要定义个Resolver，这个处理器必须实现HandlerMethodArgumentResolver的的两个方法：

public boolean supportsParameter(MethodParameter methodParameter)；
public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer modelAndViewContainer,
            NativeWebRequest nativeWebRequest, WebDataBinderFactory webDataBinderFactory)；

supportsParameter方法需要重写对哪些参数进行处理，可以处理的参数返回true，其他不支持的类型返回false。

resolveArgument方法就是实际的对入参进行处理的方法了，返回的是处理后的结果，这里实现解密的动作，方法先从httprequest中获取到http报文的body，然后根据参数配置的加密方法去选择加密算法是3des还是aes，参数可以在yml配置文件中配置，可以通过3个参数控制，可以控制是否加密、用哪个加密算法、加密秘钥，大家也可以根据自己的需要添加加密算法，只要在这个实现方法中加上就可以了。这里加密我们用的是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;
    }
}

如何使用

下面我们来看看如何使用，服务端做了参数的解密，当然就需要在client调用的时候进行加密了，加密同样可以使用hutool封装好的加密库进行操作。下面我在测试类中实现了将明文加密为密文的过程，在实际的客户端中同样可以使用这段代码进行加密后放入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中定义一个方法如下,并在入参里加上@MkParams注解，之前定义的Resolver类会将MkRequest对象中的字段解密为明文对象：

@PostMapping("/des")
    public String testDesController(@MkParams MkRequest data){

        return data.getSign() + data.getData().get("name");
    }

最后就是测试有没有作用了，大家可以用类似postman这样的发包工具，将上面的加密后的密文作为http的body进行请求，如果是用github上源码直接跑的朋友，将工程启动起来以后可以在发包工具中输入http://localhost:8090/mk/des，在body中输入上面用test方法输出的密文跑下，看看是不是输出了明文内容。

总结

上面我们框架中对加解密的处理是通过在controller方法的入参使用注解处理器来处理请求报文的解密操作，当然如果要做到完全无感还可以通过定义Filter来实现，在httprequest进入controller或servlet之前进行加解密处理，将解密后的明文放到报文体中替换原来的密文，这里需要注意到的是httprequest中的内容是无法修改的，并且调用了getInputStream、getReader这些方法后就无法再次获取到报文体的内容，那么怎么去修改httprequest报文体的内容呢？我们可以定义一个HttpRequestWrapper这样的装饰器，然后在Filter类中修改装饰器中的报文体，将解密后的报文体赋值给装饰器对象的报文体，再通过Filter的dochain方法传递下去，那么在controller的方法或者servlet中获取到的就是修改过报文体的装饰器对象，也就同样可以实现报文的解密操作，大家如果觉得笔者这种使用注解方法不太好实现，那么也可以使用在filter中httprequest装饰器的方式来实现报文的统一加解密操作。

本文对应的github tag为v0.3，可以通过连接下载https://github.com/feiweiwei/MkFramework4java/releases/tag/v0.3，也可以通过git clone -b v0.3 https://github.com/feiweiwei/MkFramework4java.git