NoHttp之优雅的为参数签名和数据加密

NoHttp之优雅的为参数签名和数据加密

NoHttp作为一个通俗易懂，简单好用的网络框架，用的人越来越多，所以大家的需求也就越来越丰富，本文主要介绍关于参数签名和加密的优雅姿势。

由于大家业务不同，故本文讲述比较常规的token加密。

加密规则: 所有请求按照参数key按字典顺序排序之后拼成A=a&B=b之后用MD5加密得出签名值。

一，获取请求参数

NoHttp获取参数的方法是Request#getParamKeyValues()，NoHttp的作者-严振杰为我们封装了一个MultiValueMap用于存储一对多的key-list<value>，所有请求的参数最后都会添加到这个Map里面。

在我翻阅了NoHttp的源码后发现，细心的杰哥在NoHttp的Request中里面提供了一个方法，onPreExecute();

此方法在NoHttp的HttpConnection中被调用，翻出源码一看，原来是真正执行请求前调用的，那么我们得出这个方法是在子线程中调用，所以我们签名加密之类的操作相对耗时，放在这里再合适不过了：

/**
 * The connection is established, including the head and send the request body.
 *
 * @param request {@link IBasicRequest}.
 * @return {@link HttpURLConnection} Have been established and the server connection..
 * @throws Exception can happen when the connection is established and send data.
 */
private Network createNetwork(IBasicRequest request) throws Exception {
    //--------看这里看这里，在这里调用了onPreExecute()。
    request.onPreExecute();

    // Print url, method.
    String url = request.url();
    Logger.i("Request address: " + url);
    Logger.i("Request method: " + request.getRequestMethod());

    Headers headers = request.headers();
    headers.set(Headers.HEAD_KEY_CONTENT_TYPE, request.getContentType());

    // Connection.
    List<String> values = headers.getValues(Headers.HEAD_KEY_CONNECTION);
    if (values == null || values.size() == 0)
        headers.add(Headers.HEAD_KEY_CONNECTION, Headers.HEAD_VALUE_CONNECTION_KEEP_ALIVE);

    // Content-Length.
    RequestMethod requestMethod = request.getRequestMethod();
    if (requestMethod.allowRequestBody())
        headers.set(Headers.HEAD_KEY_CONTENT_LENGTH, Long.toString(request.getContentLength()));

    // Cookie.
    headers.addCookie(new URI(url), NoHttp.getCookieManager());
    return mExecutor.execute(request);
}

因此我们仿照NoHttp中的默认请求继承RestRequest类，重写onPreExecute()方法，在这里获取所有参数并做签名和加密：

public class DefineRequest extends RestRequest<String> {

    public DefineRequest(String url, RequestMethod method) {
        supper(url, method)
    }

    @Override
    public void onPreExecute() {
        MultiValueMap<String, Object> multiValueMap = getParamKeyValues();
        // TODO 解析来就是签名以及加密了，且往下看。
    }

    @Override
    public String parseResponse(Headers header, byte[] body) throws Throwable {
        // 这里把数据解析为String，直接用StringRequest的静态方法。
        return StringRequest.parseResponseString(header, body);

        // 这里如果你想自己解析：
        //1. 不指定编码： return new String(body);
        //2. 指定编码： return new String(body, "utf-8");
    }
}

二，请求参数加密

接下来的操作在代码中一步一步解释

/**
 * 参数加密
 */
@Override
public void onPreExecute() {
    //第一步:获取所有请求参数
    MultiValueMap<String, Object> multiValueMap = getParamKeyValues();

    //第二步,定义List用于存储所有请求参数的key
    List<String> keyList = new ArrayList<>();

    //第三步:定义Map用于存储所有请求参数的value
    Map<String, String> keyValueMap = new HashMap<>();

    //第四步:拿到所有具体请求参数
    for (Map.Entry<String, List<Object>> paramsEntry : multiValueMap.entrySet()) {
        String key = paramsEntry.getKey();
        List<Object> values = paramsEntry.getValue();
        for (Object value : values) {
            if (value instanceof String) {

                //第五步:将请求参数的key添加到list中用于排序
                keyList.add(key);

                //第六步:将请求参数的value添加到Map中
                keyValueMap.put(key, (String) value);
            }
        }
    }

    //第七步:对请求参数key进行排序
    Collections.sort(keyList);

    StringBuilder paramsBuilder = new StringBuilder();

    //第八步:依次取出排序之后的key-value,并拼接
    for (String key : keyList) {
        String value = keyValueMap.get(key);
        paramsBuilder.append(key).append("=").append(value).append("&");
    }

    String params = "";
    if(paramsBuilder.length() > 0) {
        //去掉最后一个&
        params = paramsBuilder.toString().substring(0, paramsBuilder.length() - 1);
    }

    //第九步:对拼接好的参数进行MD5加密
    String token =  EncryptionUtil.md5(params);

    //最后，添加到请求参数
    add("token", token);

    // 如果你们服务器要求添加到head，那么：
    // addHeader("token", token);
}

获取String的md5值的EncryptionUtil：

/**
 * 生成md5
 *
 * @param message
 * @return
 */
public static String md5(String message) {
    String md5str = "";
    try {
        //1 创建一个提供信息摘要算法的对象，初始化为md5算法对象
        MessageDigest md = MessageDigest.getInstance("MD5");

        //2 将消息变成byte数组
        byte[] input = message.getBytes();

        //3 计算后获得字节数组,这就是那128位了
        byte[] buff = md.digest(input);

        //4 把数组每一字节（一个字节占八位）换成16进制连成md5字符串
        md5str = bytesToHex(buff);

    } catch (Exception e) {
        e.printStackTrace();
    }
    return md5str;
}


    /**
     * 二进制转十六进制
     *
     * @param bytes
     * @return
     */
    public static String bytesToHex(byte[] bytes) {
        StringBuffer md5str = new StringBuffer();
        //把数组每一字节换成16进制连成md5字符串
        int digital;
        for (int i = 0; i < bytes.length; i++) {
            digital = bytes[i];

            if (digital < 0) {
                digital += 256;
            }
            if (digital < 16) {
                md5str.append("0");
            }
            md5str.append(Integer.toHexString(digital));
        }
        return md5str.toString().toLowerCase();
    }

好啦，到这里就写完啦，当然每个公司的签名方法不尽相同，所以大概都是这个姿势，这个姿势是不是很优雅呢。