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

来源:https://www.cnblogs.com/tanshaoshenghao/archive/2019/04/20/10741160.html
-Advertisement-
Play Games

本文將從簡單的場景引入, 逐步優化, 最後給出具體的責任鏈設計模式實現. 場景引入 首先我們考慮這樣一個場景: 論壇上用戶要發帖子, 但是用戶的想法是豐富多變的, 他們可能正常地發帖, 可能會在網頁中淺入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中的過濾器的可擴展性還沒有我們例子中的好呢^_^

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 前端筆記之NodeJS（三）Express&ejs模板引擎&請求識別
    一、Express框架 1.1基本使用 創建http伺服器特別麻煩，express框架解決了這個的問題。 Express在node界的地位，就相當於jQuery在DOM界的地位。jQuery的核心就是“批量”，1個jQuery對象中可以封裝多個原生對象。Express的核心就是中間件，Express ...
  • Vue.js + Nuxt.js 項目中使用 Vee-validate 表單校驗
    介紹 Vue.js + Nuxt.js 項目中如何使用、自定義錯誤信息、自定義規則 Vee-validate 校驗表單 ...
  • vue 單文件組件中樣式載入
    在寫單文件組件時，一般都是把標簽、腳本、樣式寫到一起，這樣寫個人感覺有點不夠簡潔，所以就想著把樣式分離出去。 採用import載入樣式 在局部作用域（scoped）採用@import載入進來的樣式文件，想法是美好的。以為這樣載入進來的樣式文件也只對當前組件有效；可現實是殘酷的，這樣載入進來的樣式無法 ...
  • 前端筆記之NodeJS（二）路由&REPL&模塊系統&npm
    一、路由機制（靜態資源文件處理） 1.1 Nodejs沒有根目錄 MIME類型：http://www.w3school.com.cn/media/media_mimeref.asp 在Apache中，它會自動將htdocs文件夾提供靜態化路由服務。 但是Nodejs沒有這個機制。 在文件夾中創建這樣 ...
  • vue-router 頁面佈局
    在單頁面應用程式（SPA）中，有些頁面的佈局結構是上下兩塊是固定，中間內容是變化的。這時在入口處固定上下部分就可以很好的解決這一問題。有少部分頁面沒有上下部分或不需要（如：用戶註冊、登陸頁面），針對這一情況怎麼解決 相容這兩種情況解決方案： App.vue 在入口處單個路由輸出 Frame.vue ...
  • 自研後端HTTP請求參數驗證器服務ParamertValidateService
    好處：方便了後端對HTTP請求中參數進行核驗，只需一次編寫效驗器，一行代碼便可對所有參數的pojo進行參數核驗！而且更改效驗邏輯時只需要更改效驗器類即可，實現瞭解耦合。 只需要程式員按照規範開發一個ParameterValidator類（如下圖1），將所有效驗方法寫在該類中即可在任意地方使用一行代碼 ...
  • 原型模式(Prototype Pattern)
    原型模式概述 定義：使用原型實例指定待創建對象的類型，並且通過複製這個原型來創建新的對象。簡單的來說就是克隆(Clone),通過已經存在的，將其複製而產生新的。原型模式屬於創建型模式，將一個原型對象傳給要發動創建的對象(客戶端對象)，該對象通過請求原型對象複製自己來實現創建過程。 既然是通過Clon ...
  • Spring Boot 2.0 升級指南
    Spring Boot 2.0 升級指南 前言 Spring Boot已經發佈2.0有5個月多，多了很多新特性，一些坑也慢慢被填上，最近有空，就把項目中Spring Boot 版本做了升級，順便整理下升級的時候遇到的一些坑，做個記錄。後續的教程就以最新的2.03版本為主。參考官方文檔翻譯 在你開始之 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類