利用责任链模式设计一个拦截器

dreamans 发布于2019-08-16 13:28 / 546人阅读

摘要：前言近期在做的拦截器功能，正好用到了责任链模式。通过官方图就可以非常清楚的看出是一个责任链模式用责任链模式设计一个拦截器对于拦截器来说使用责任链模式再好不过了。设置拦截器到责任链中时通过反射将的值保存到各个拦截器中。

前言

近期在做 Cicada 的拦截器功能，正好用到了责任链模式。

这个设计模式在日常使用中频率还是挺高的，借此机会来分析分析。

责任链模式

先来看看什么是责任链模式。

引用一段维基百科对其的解释：

责任链模式在面向对象程式设计里是一种软件设计模式，它包含了一些命令对象和一系列的处理对象。每一个处理对象决定它能处理哪些命令对象，它也知道如何将它不能处理的命令对象传递给该链中的下一个处理对象。该模式还描述了往该处理链的末尾添加新的处理对象的方法。

光看这段描述可能大家会觉得懵，简单来说就是该设计模式用于对某个对象或者请求进行一系列的处理，这些处理逻辑正好组成一个链条。

下面来简单演示使用与不使用责任链模式有什么区别和优势。

责任链模式的应用 传统实现

假设这样的场景：传入了一段内容，需要对这段文本进行加工；比如过滤敏感词、错别字修改、最后署上版权等操作。

常见的写法如下：

public class Main {
    public static void main(String[] args) {
        String msg = "内容内容内容" ;

        String result = Process.sensitiveWord()
                .typo()
                .copyright();
    }
}

这样看似没啥问题也能解决需求，但如果我还需要为为内容加上一个统一的标题呢？在现有的方式下就不得不新增处理方法，并且是在这个客户端（Process）的基础上进行新增。

显然这样的扩展性不好。

责任链模式实现

这时候就到了责任链模式发挥作用了。

该需求非常的符合对某一个对象、请求进行一系列处理的特征。

于是我们将代码修改：

这时 Process 就是一个接口了，用于定义真正的处理函数。

public interface Process {

    /**
     * 执行处理
     * @param msg
     */
    void doProcess(String msg) ;
}

同时之前对内容的各种处理只需要实现该接口即可：

public class SensitiveWordProcess implements Process {
    @Override
    public void doProcess(String msg) {
        System.out.println(msg + "敏感词处理");
    }
}

public class CopyrightProcess implements Process {

    @Override
    public void doProcess(String msg) {
        System.out.println(msg + "版权处理");
    }
}

public class CopyrightProcess implements Process {

    @Override
    public void doProcess(String msg) {
        System.out.println(msg + "版权处理");
    }
}

然后只需要给客户端提供一个执行入口以及添加责任链的入口即可：

public class MsgProcessChain {

    private List chains = new ArrayList<>() ;

    /**
     * 添加责任链
     * @param process
     * @return
     */
    public MsgProcessChain addChain(Process process){
        chains.add(process) ;
        return this ;
    }

    /**
     * 执行处理
     * @param msg
     */
    public void process(String msg){
        for (Process chain : chains) {
            chain.doProcess(msg);
        }
    }
}

这样使用起来就非常简单：

public class Main {
    public static void main(String[] args) {
        String msg = "内容内容内容==" ;

        MsgProcessChain chain = new MsgProcessChain()
                .addChain(new SensitiveWordProcess())
                .addChain(new TypoProcess())
                .addChain(new CopyrightProcess()) ;

        chain.process(msg) ;
    }
}

当我需要再增加一个处理逻辑时只需要添加一个处理单元即可（addChain(Process process)），并对客户端 chain.process(msg) 是无感知的，不需要做任何的改动。

可能大家没有直接写过责任链模式的相关代码，但不经意间使用到的却不少。

比如 Netty 中的 pipeline 就是一个典型的责任链模式，它可以让一个请求在整个管道中进行流转。

通过官方图就可以非常清楚的看出是一个责任链模式：

用责任链模式设计一个拦截器

对于拦截器来说使用责任链模式再好不过了。

下面来看看在 Cicada 中的实现：

首先是定义了和上文 Process 接口类似的 CicadaInterceptor 抽象类：

public abstract class CicadaInterceptor {

    public boolean before(CicadaContext context,Param param) throws Exception{
        return true;
    }

    public void after(CicadaContext context,Param param) throws Exception{}
}

同时定义了一个 InterceptProcess 的客户端：

其中的 loadInterceptors() 会将所有的拦截器加入到责任链中。

再提供了两个函数分别对应了拦截前和拦截后的入口：

实际应用

现在来看看具体是怎么使用的吧。

在请求的 handle 中首先进行加载（loadInterceptors(AppConfig appConfig)），也就是初始化责任链。

接下来则是客户端的入口；调用拦截前后的入口方法即可。

由于是拦截器，那么在 before 函数中是可以对请求进行拦截的。只要返回 false 就不会继续向后处理。所以这里做了一个返回值的判断。

同时对于使用者来说只需要创建拦截器类继承 CicadaInterceptor 类即可。

这里做了一个演示，分别有两个拦截器：

记录一个业务 handle 的执行时间。

在 after 里打印了请求参数。

同时可在第一个拦截器中返回 false 让请求被拦截。

先来做前两个试验：

这样当我请求其中一个接口时会将刚才的日志打印出来：

接下来我让打印执行时间的拦截器中拦截请求，同时输入向前端输入一段文本：

请求接口可以看到如下内容：

同时后面的请求参数也没有打印出来，说明请求确实被拦截下来。

同时我也可以调整拦截顺序，只需要在 @Interceptor(order = 1) 注解中定义这个 order 属性即可（默认值是 0，越小越先执行）。

之前是打印请求参数的拦截器先执行，这次我手动将它的 order 调整为 2，而打印时间的 order 为 1 。

再次请求接口观察后台日志：

发现打印执行时间的拦截器先执行。

那这个执行执行顺序如何实现自定义配置的呢？

其实也比较简单，有以下几步：

在加载拦截器时将注解里的 order 保存起来。

设置拦截器到责任链中时通过反射将 order 的值保存到各个拦截器中。

最终通过排序重新排列这个责任链的顺序。

贴一些核心代码。

扫描拦截器时保存 order 值：

保存 order 值到拦截器中：

重新对责任链排序：

总结

整个责任链模式已经讲完，希望对这个设计模式还不了解的朋友带来些帮助。

上文中的源码如下：

https://github.com/TogetherOS/cicada:一个高性能、轻量 HTTP 框架

https://git.io/fxKid

欢迎关注公众号一起交流：

专线服务混合云责任链模式 java责任链模式如何利用区块链赚钱利用服务器设计图

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/71791.html

不得不知的责任链设计模式

世界上最遥远的距离，不是生与死，而是它从你的世界路过无数次，你却选择视而不见，你无情，你冷酷啊...... showImg(https://segmentfault.com/img/remote/1460000019550563); 被你忽略的就是责任链设计模式，希望它再次经过你身旁你会猛的发现，并对它微微一笑...... 责任链设计模式介绍抽象介绍初次见面，了解表象，深入交流之后（看完文中的...

raise_yang 2019-08-19 11:47 评论0 收藏0
忘了再看设计模式-行为型

摘要：推文用设计模式解构三国是一种什么体验行为型设计模式一策略模式工厂模式优化结构状态模式随着状态改变而改变行为。推文状态机与状态模式责任链模式多个对象依次处理请求前者指定后者。代理模式代理针对一个对象，为了增加控制等中介双方都是多个，为了解耦。策略模式选择使用封装好的一系列算法，可相互替换。类比：商店[Context]买完衣服买单[Stratege]（现金[Concrete Stra...

ShevaKuilin 2019-08-15 12:03 评论0 收藏0
慕课网_《探秘Spring AOP》学习总结

时间：2017年09月03日星期日说明：本文部分内容均来自慕课网。@慕课网：http://www.imooc.com 教学源码：https://github.com/zccodere/s...学习源码：https://github.com/zccodere/s... 第一章：课程介绍 1-1 面向切面课程章节概览 AOP使用 AOP原理 AOP开源运用课程实战课程总结面向切面编程是一种...

Tony_Zby 2019-08-16 10:47 评论0 收藏0
Android八门神器(一): OkHttp框架源码解析

摘要：控制最大请求并发数和单个主机的最大并发数，并持有一个线程池负责执行异步请求，对同步的请求只是用作统计。在每个分离器使用一个内部调用请求内部主要并不涉及执行的具体。HTTP是我们交换数据和媒体流的现代应用网络，有效利用HTTP可以使我们节省带宽和更快地加载数据，Square公司开源的OkHttp网络请求是有效率的HTTP客户端。之前的知识面仅限于框架API的调用，接触到实际的工作之后深知自己知...

番茄西红柿 2019-04-23 15:20 评论0 收藏0
通熟易懂的设计模式（二）

摘要：提供酒店相关的接口返回该时间段有效的酒店提供航班相关的接口返回该时间段有效的航班提供一个旅行对外的接口，一次返回酒店和航班信息调用旅行外观模式享元模式享元模式主要用于减少创建对象的数量，以减少内存占用和提高性能。组合模式（Composite pattern）组合模式看起来就像对象组的树形结构，一个对象里面包含一个或一组其他的对象。它是属于结构型模式。例如，一个公司包括很多个部门，每...

daydream 2019-08-16 18:05 评论0 收藏0