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

炭燒生蠔發表於2019-04-20
模式TomcatFilter過濾器

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

場景引入

  • 首先我們考慮這樣一個場景: 論壇上使用者要發帖子, 但是使用者的想法是豐富多變的, 他們可能正常地發帖, 可能會在網頁中淺入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個過濾器, 這三個過濾器就構成一條過濾器鏈.
由淺入深講解責任鏈模式,理解Tomcat的Filter過濾器
  • 下面我們考慮, 如果我們要在帖子處理過程中加入新的過濾器鏈條, 加在原鏈條的末尾或中間, 該怎麼辦呢?
  • 訊息經過過濾器鏈條的過程會得到處理, 我們可以把過濾器鏈條看成一個過濾器, 讓他也實現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);
}
複製程式碼

 

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

  • 在繼續優化之前, 我們考慮更現實的需求, 一個請求(發出一個帖子)作為資料包傳送給伺服器, 伺服器除了需要對請求進行過濾外, 還需要給出響應, 並且可能要對響應也進行處理. 如下圖所示
由淺入深講解責任鏈模式,理解Tomcat的Filter過濾器
  • 當一個訊息(包含請求體和響應體)發往伺服器時, 它將依次經過過濾器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過濾器原始碼, 加深理解.

  • 相信通過上面的講解, 你已經對整個責任鏈模式有了進一步的理解.
  • 下面我們通過閱讀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中的過濾器的可擴充套件性還沒有我們例子中的好呢^_^

 

相關文章