由淺入深講解責任鏈模式,理解Tomcat的Filter過濾器

時間  2019-11-07
標籤 由淺入深 講解 責任 模式 理解 tomcat filter 過濾器 欄目 Tomcat 简体版
原文   原文鏈接

本文將從簡單的場景引入, 逐步優化, 最後給出具體的責任鏈設計模式實現.html

場景引入

  • 首先咱們考慮這樣一個場景: 論壇上用戶要發帖子, 可是用戶的想法是豐富多變的, 他們可能正常地發帖, 可能會在網頁中淺入html代碼, 可能會使用錯誤的表情格式, 也可能發送一些敏感信息.
  • 做爲論壇的管理員必須對用戶的帖子進行過濾才能顯示出來, 不然論壇就經營不下去了. 如今咱們考慮一種最簡單處理方式.
public class Demo1 {
    public static void main(String[] args) {
        String msg = "你們好 :), <script>haha</script> 我要說超級敏感的話";//假設有一條這樣的貼子
        MsgProcessor mp = new MsgProcessor();
        mp.setMsg(msg);//處理帖子
        System.out.println(mp.process());
    }
}
//帖子處理器
class MsgProcessor{
    private String msg;

    public String process(){
        //對html標籤<>進行處理
        String str = msg.replace("<", "[").replace(">", "]");
        //對敏感字符盡心處理
        str = str.replace("敏感", "正常");
        //對錯誤的表情格式進行處理
        str = str.replace(":)", "^_^");
        return str;
    }
    //get() / set() 方法...
}
//輸出結果
你們好 ^_^, [script]haha[/script] 我要說超級正常的話
複製代碼

 

責任鏈模型初體現

  • 經過上面的代碼能夠看到帖子處理器會對帖子進行不一樣的過濾, 咱們能夠把一種過濾方法對應爲一個過濾器, 而且向上抽取出過濾器接口.
public class Demo2 {
    public static void main(String[] args) {
        String msg = "你們好 :), <script>haha</script> 我要說超級敏感的話";
        MsgProcessor mp = new MsgProcessor();
        mp.setMsg(msg);
        System.out.println(mp.process());
    }
}

class MsgProcessor{
    private String msg;
    private Filter[] filters = {new HtmlFilter(), new SensitiveFilter(), new ExpressionFilter()};
    public String process(){
        for(Filter f : filters){
            msg = f.doFilter(msg);
        }
        return msg;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }
}
//過濾器接口
interface Filter{
    public String doFilter(String s);
}
//處理html標籤
class HtmlFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace("<", "[").replace(">", "]");
    }
}
//處理敏感詞句
class SensitiveFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace("敏感", "正常");
    }
}
//處理表情
class ExpressionFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace(":)", "^_^");
    }
}
複製代碼

 

  • 上面的代碼已經具有了責任鏈的模型. 在帖子發送到服務器的過程當中, 它將依次通過3個過濾器, 這三個過濾器就構成一條過濾器鏈.
  • 下面咱們考慮, 若是咱們要在帖子處理過程當中加入新的過濾器鏈條, 加在原鏈條的末尾或中間, 該怎麼辦呢?
  • 消息通過過濾器鏈條的過程會獲得處理, 咱們能夠把過濾器鏈條當作一個過濾器, 讓他也實現Filter接口, 那麼就能夠在一條過濾鏈中任意加入其餘過濾器和過濾鏈了.
  • 下面的代碼實現了過濾鏈FilterChain, 用過濾鏈替代原來的MsgProcessor.
public class Demo3 {
    public static void main(String[] args) {
        String msg = "你們好 :), <script>haha</script> 我要說超級敏感的話";//待處理的帖子
        FilterChain fc1 = new FilterChain();//建立一條過濾器鏈1
        fc1.add(new HtmlFilter())
                .add(new SensitiveFilter());//往過濾器鏈1中添加過濾器

        FilterChain fc2 = new FilterChain();//建立一條過濾器鏈2
        fc2.add(new ExpressionFilter());//往過濾器鏈2中添加過濾器

        fc1.add(fc2);//把過濾器鏈2看成過濾器添加到過濾器鏈1中,(過濾器鏈實現了Filter接口)

        msg = fc1.doFilter(msg);//使用過濾器鏈1對帖子進行過濾
        System.out.println(msg);
    }
}

class FilterChain implements Filter{

    private List<Filter> list = new ArrayList<>();

    public FilterChain add(Filter filter){
        this.list.add(filter);
        return this;
    }

    @Override
    public String doFilter(String s) {
        for(Filter f : list){
            s = f.doFilter(s);
        }
        return s;
    }
}

class HtmlFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace("<", "[").replace(">", "]");
    }
}

class SensitiveFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace("敏感", "正常");
    }
}

class ExpressionFilter implements Filter{
    @Override
    public String doFilter(String s) {
        return s.replace(":)", "^_^");
    }
}

interface Filter{
    public String doFilter(String s);
}
複製代碼

 

更精巧設計, 展示責任鏈模式

  • 在繼續優化以前, 咱們考慮更現實的需求, 一個請求(發出一個帖子)做爲數據報發送給服務器, 服務器除了須要對請求進行過濾外, 還須要給出響應, 而且可能要對響應也進行處理. 以下圖所示
  • 當一個消息(包含請求體和響應體)發往服務器時, 它將依次通過過濾器1, 2, 3. 而當處理完成後, 封裝好響應發出服務器時, 它也將依次通過過濾器3, 2, 1.
  • 你們可能會以爲有點像棧結構, 可是像歸像, 這一邏輯應該如何實現呢?
  • 首先咱們可讓過濾器持有過濾器鏈的引用, 經過調用過濾器鏈依次執行每一個過濾器. 爲了能讓過濾器依次執行每一個過濾器, 過濾器會持有一個index序號, 經過序號控制執行順序. 至於後面對response的倒序請求, 則經過方法返回實現. 這部分設計純用文字難以講清, 請務必看下面的代碼和代碼後的分析, 配圖.
  • 這個部分是責任鏈的精髓了, 懂了這部分代碼, 看Web開發中的過濾器源碼就沒壓力了.
public class Demo4 {
    public static void main(String[] args) {
        String msg = "你們好 :), <script>haha</script> 我要說超級敏感的話";//如下三行模擬一個請求
        Request request = new Request();
        request.setRequestStr(msg);

        Response response = new Response();//響應

        FilterChain fc = new FilterChain();//過濾器鏈
        HtmlFilter f1 = new HtmlFilter();//建立過濾器
        SensitiveFilter f2 = new SensitiveFilter();
        ExpressionFilter f3 = new ExpressionFilter();
        fc.add(f1);//把過濾器添加到過濾器鏈中
        fc.add(f2);
        fc.add(f3);

        fc.doFilter(request, response, fc);//直接調用過濾器鏈的doFilter()方法進行處理
        System.out.println(request.getRequestStr());
    }
}

interface Filter{
    public void doFilter(Request request, Response response, FilterChain fc);
}

class FilterChain implements Filter{

    private List<Filter> list = new ArrayList<>();

    private int index = 0;

    public FilterChain add(Filter filter){
        this.list.add(filter);
        return this;
    }

    @Override
    public void doFilter(Request request, Response response, FilterChain fc) {
        if(index == list.size()){
            return;//這裏是逆序處理響應的關鍵, 當index爲容器大小時, 證實對request的處理已經完成, 下面進入對response的處理.
        }
        Filter f = list.get(index);//過濾器鏈按index的順序拿到filter
        index++;
        f.doFilter(request, response, fc);
    }

}

class HtmlFilter implements Filter{
    @Override
    public void doFilter(Request request, Response response, FilterChain fc) {
        request.setRequestStr(request.getRequestStr().replace("<", "[").replace(">","]"));
        System.out.println("在HtmlFilter中處理request");//先處理request
        fc.doFilter(request, response, fc);//調用過濾器鏈的doFilter方法, 讓它去執行下一個Filter的doFilter方法, 處理response的代碼將被掛起
        System.out.println("在HtmlFilter中處理response");
    }
}

class SensitiveFilter implements Filter{
    @Override
    public void doFilter(Request request, Response response, FilterChain fc) {
        request.setRequestStr(request.getRequestStr().replace("敏感", "正常"));
        System.out.println("在SensitiveFilter中處理request");
        fc.doFilter(request, response, fc);
        System.out.println("在SensitiveFilter中處理response");
    }
}

class ExpressionFilter implements Filter{
    @Override
    public void doFilter(Request request, Response response, FilterChain fc) {
        request.setRequestStr(request.getRequestStr().replace(":)", "^_^"));
        System.out.println("在ExpressionFilter中處理request");
        fc.doFilter(request, response, fc);
        System.out.println("在ExpressionFilter中處理response");
    }
}

class Request{
    private String requestStr;//真正的Request對象中是包含不少信息的, 這裏僅用一個字符串做模擬

    public String getRequestStr() {
        return requestStr;
    }

    public void setRequestStr(String requestStr) {
        this.requestStr = requestStr;
    }
}

class Response{
    private String responseStr;

    public String getResponseStr() {
        return responseStr;
    }

    public void setResponseStr(String responseStr) {
        this.responseStr = responseStr;
    }
}
複製代碼

 

  • 下面我描述一次整個過程, 你能夠根據文字找到相應的代碼進行理解.
  • 首先咱們分別建立一個Request和Response對象. Request在傳入進後端時須要依次被過濾器1, 2, 3進行處理, Response對象在輸出時要依次被過濾器3, 2, 1處理.
  • 建立好請求和響應對象後咱們建立過濾器鏈, 並依次加入過濾器1, 2, 3. 整個處理流程將交給過濾器鏈決定.
  • 接着咱們調用過濾器鏈的doFilter()方法對request對象進行處理
  • 這時過濾器鏈中的index值爲0, 經過index咱們找到第一個過濾器並調用它的doFilter()方法, 咱們觀察這段代碼
class HtmlFilter implements Filter{
    @Override
    public void doFilter(Request request, Response response, FilterChain fc) {
        request.setRequestStr(request.getRequestStr().replace("<", "[").replace(">","]"));
        System.out.println("在HtmlFilter中處理request");//先處理request
        
        fc.doFilter(request, response, fc);//調用過濾器鏈的doFilter方法, 讓它去執行下一個Filter的doFilter方法, 處理response的代碼將被掛起
        
        //在返回的過程當中執行response
        System.out.println("在HtmlFilter中處理response");
    }
}
複製代碼
  • 進入doFilter()方法後, 首先會對request請求進行處理, 而後又調用了過濾器鏈的doFilter()方法. 這就是整個責任鏈模式的精妙之處, 它解釋了爲何要給doFilter()加上一個過濾器鏈參數, 就是爲了讓每一個過濾器能夠調用過濾器鏈自己執行下一個過濾器.
  • 爲何要調用過濾器鏈自己? 由於當調用過濾器自己後, 程序將跳轉回到過濾器鏈的doFilter方法執行, 這時index爲1, 也就是拿到第二個過濾器, 而後繼續處理.
  • 正是因爲這個跳轉, 使得過濾器中對response的處理暫時沒法執行, 它必須等待上面的對過濾器鏈的方法返回才能被執行.
  • 因此最後咱們將看到response響應被過濾器3, 2, 1(和請求倒序)執行.
  • 放大招了, 若是看了上面的圖仍是不懂, 歡迎給我留言.
  • 整個責任鏈模式已經從無到有展示出來了

 

閱讀Tomcat中的Filter過濾器源碼, 加深理解.

  • 相信經過上面的講解, 你已經對整個責任鏈模式有了進一步的理解.
  • 下面咱們經過閱讀Tomcat裏Filter的源碼感覺一下.
public interface Filter {
    void init(FilterConfig var1) throws ServletException;
    //熟悉的doFilter(), 熟悉的3個參數request, reponse, filterChain.
    void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;

    void destroy();
}
複製代碼
  • 咱們能夠看到Filter接口的定義和咱們的講解的差很少, 只是多了初始化和銷燬的方法.
public interface FilterChain {
    void doFilter(ServletRequest var1, ServletResponse var2) throws IOException, ServletException;
}
複製代碼
  • 同時咱們也看到它把FilterChain也向上抽取成接口, 不過這裏的FilterChain沒有實現Filter接口, 也就是說咱們不能把兩條FilterChain拼接在一塊兒, 換個角度想Tomcat中的過濾器的可擴展性尚未咱們例子中的好呢^_^

 

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程