使用Filter以及RequestWrapper实现参数的动态添加以及对数据的解密

熟悉java web开发的人都知道,当我们发起了一个http请求后,我们在服务端就很难动态的修改请求的数据了,因为HttpServletRequest是一个接口,而其实现类又因不同的web服务器不同,而实现不同,所以我们修改其实不同服务器的实现类也是一个不明智的想法。
但是最近我遇到一个业务场景,就是对每一个Http请求,都需要一个特定的参数,这个参数是用来追溯日志用的,于是团队刚开始的想法就是每次请求让前端传入一个uuid到后台,但是这样的做法让我感觉很费劲,于是我就想到了HttpServletWrapper。
HttpServletWrapper是HttpServletRequest的一个实现类(装饰器),由于多态的原因,我们可以使用该类,实现对父类方法的重写,使用该类可以在请求下发的时候,动态修改请求的内容。因此我便通过此类实现了对请求参数的扩展。
当然在这里,我们要熟悉如何通过HttpServletRequest获取我们的请求参数,如果我们获取get请求参数,我们一般通过request.getParameter(String name)的方法,如果获取post请求参数,我们就要区分post的请求方式了,如果使用form-data以及x-www-form-urlencoded,我们也可以通过上面的方法获取到,因为这些请求参数都会放入到request的一个请求参数Map中。但是如果我们把请求放入@Requestbody中呢,那请求参数就是会以json的形式存在stream流中了。而且ServletInputStream以及BufferedReader只能读取一次,读取一次后内容就会置空导致异常,因此我们要对这些流进行处理。相信看以下代码吧

(1)实现对请求的过滤

public class ParamServletFilter extends AbstractLogger implements Filter {

@Override
public void init(FilterConfig filterConfig) {
}

@Override
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
        throws IOException, ServletException {
    HttpServletRequest request = (HttpServletRequest) req;
    String uuid = GlobalUtils.generateUUID();
    logger.info("请求路径: [{}], 请求的全局id: [{}]", request.getServletPath(), uuid);
    chain.doFilter(new ParamServletRequestWrapper(request, uuid), resp);
}

@Override
public void destroy() {
}

}

(2) 实现对参数的扩展

public class ParamServletRequestWrapper extends HttpServletRequestWrapper {

private static final Logger LOGGER = LoggerFactory.getLogger(ParamServletRequestWrapper.class);

private Map<String , String[]> params = new HashMap<>();
private InputStream inputStream;

private ParamServletRequestWrapper(HttpServletRequest request) {
    super(request);
}

ParamServletRequestWrapper(HttpServletRequest request, String correlationId) {
    this(request);
    if (!CollectionUtils.isEmpty(request.getParameterMap())) {
        this.params.putAll(request.getParameterMap());
    }
    addParameter(correlationId);
    dealRequestBody(request, correlationId);
}

/**
 * 获取所有的参数名
 *
 * @return Map的key -> 参数名
 */
@Override
public Enumeration<String> getParameterNames() {
    LOGGER.debug("getParameterNames: [{}]", JsonUtils.serialize(Collections.enumeration(params.keySet())));
    return Collections.enumeration(params.keySet());
}

/**
 * 根据参数名获取参数值
 *
 * @param name 参数名
 * @return 参数传入值
 */
@Override
public String getParameter(String name) {
    String[]values = params.get(name);
    if (values == null || values.length == 0) {
        return null;
    }
    LOGGER.debug("getParameter, name: [{}], value: [{}]", name, values[0]);
    return values[0];
}

/**
 * 根据参数名获取所有的参数值
 *
 * @param name 参数名
 * @return 参数所有的值
 */
@Override
public String[] getParameterValues(String name) {
    LOGGER.debug("getParameterValues, name: [{}], value: [{}]", name, params.get(name));
    return params.get(name);
}

/**
 * 获取所有的请求参数
 *
 * @return 请求参数
 */
@Override
public Map<String, String[]> getParameterMap() {
    LOGGER.debug("getParameterMap, parameterMap: [{}]", JsonUtils.serialize(params));
    return this.params;
}

/**
 * 获取body的数据流
 *
 * @return {@link DefaultServletInputStream}
 * @throws IOException io异常
 */
@Override
public ServletInputStream getInputStream() throws IOException {
    return Objects.isNull(inputStream) ? null : new DefaultServletInputStream(inputStream);
}

/**
 * 获取body内容的数据流
 *
 * @return {@link BufferedReader}
 * @throws IOException io异常
 */
@Override
public BufferedReader getReader() throws IOException {
    return Objects.isNull(inputStream) ? null : new BufferedReader(new InputStreamReader(inputStream));
}

/**
 * 处理请求body的内容
 *
 * @param request 请求
 * @param correlationId 全局id
 */
private void dealRequestBody(HttpServletRequest request, String correlationId) {
    try {
        ServletInputStream inputStream = request.getInputStream();
        if (Objects.isNull(inputStream)) {
            return;
        }

        String inputStr = IOUtils.toString(inputStream, Constants.UTF_8);
        if (StringUtils.isEmpty(inputStr)) {
            return;
        }

        LOGGER.debug("getInputStream, inputString: [{}]", inputStr);

        JSONObject inputJson = JSONObject.parseObject(inputStr);
        if (Objects.isNull(inputJson)) {
            return;
        }

        //String encryptJson = inputJson.getString(Constants.ENCRYPT_CONTENT);
        //String decryptJson = EncryptionUtils.decrypt(encryptJson);
        //inputJson = JSONObject.parseObject(decryptJson);

        if (!inputJson.containsKey(Constants.CORRELATION_ID)) {
            inputJson.put(Constants.CORRELATION_ID, correlationId);
        }
        LOGGER.debug("getInputStream, inputJson: [{}]", inputJson.toJSONString());
        this.inputStream = IOUtils.toInputStream(inputJson.toJSONString(), Constants.UTF_8);
    } catch (Exception e) {
        LOGGER.error("getInputStream failed, cause: [{}]", ExceptionUtils.getFullStackTrace(e));
    }
}

/**
 * 对map中加密字段进行解析
 *
 * 加密规则将所有的字段通过AES加密到encryptContent字段中
 * 然后后端进行解密
 */
private void analysisMap() {
    String[] contents = this.params.get(Constants.ENCRYPT_CONTENT);
    if (GlobalUtils.isNull(contents)) {
        return;
    }

    String content = contents[0];
    String decrypt = EncryptionUtils.decrypt(content);
    if (StringUtils.isEmpty(decrypt)) {
        return;
    }

    String[] split = decrypt.split("&");
    if (GlobalUtils.isNull(split)) {
        return;
    }

    for (String query : split) {
        String[] queryString = query.split("=");
        if (!GlobalUtils.isNull(queryString) && queryString.length == 2) {
            params.put(queryString[0], new String[] {queryString[1]});
        }
    }
}

/**
 * 对map的值赋予新的值
 *
 * @param value 添加新的值
 */
private void addParameter(Object value) {
    //analysisMap();
    if (params.containsKey(Constants.CORRELATION_ID)) {
        return;
    }

    if (value != null) {
        if (value instanceof String[]) {
            params.put(Constants.CORRELATION_ID, (String[]) value);
        } else if (value instanceof String) {
            params.put(Constants.CORRELATION_ID, new String[] {(String) value});
        } else {
            params.put(Constants.CORRELATION_ID, new String[] {String.valueOf(value)});
        }
    }
}

public class DefaultServletInputStream extends ServletInputStream {
    private final InputStream sourceStream;
    private boolean finished = false;

    DefaultServletInputStream(InputStream sourceStream) {
        ParamUtils.assertNotNull(sourceStream, "inputStream must not be null");
        this.sourceStream = sourceStream;
    }

    public int read() throws IOException {
        int data = this.sourceStream.read();
        if (data == -1) {
            this.finished = true;
        }

        return data;
    }

    public int available() throws IOException {
        return this.sourceStream.available();
    }

    public void close() throws IOException {
        super.close();
        this.sourceStream.close();
    }

    public boolean isFinished() {
        return this.finished;
    }

    public boolean isReady() {
        return true;
    }

    public void setReadListener(ReadListener readListener) {
        throw new UnsupportedOperationException();
    }
}

}

注意 !!!
Enumeration<String> getParameterNames 此方法必须实现,不然添加的map的参数无法获取,以及本例中IOUtils使用了apache的common-io,以及json处理使用了fastJson,如果你的HttpMessageConverters不兼容,请替换成对应的Json处理器

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,132评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,802评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,566评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,858评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,867评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,695评论 1 282
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,064评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,705评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,915评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,677评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,796评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,432评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,041评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,992评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,223评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,185评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,535评论 2 343

推荐阅读更多精彩内容