Filter過濾器02 5.Filter過濾器生命周期 Filter生命周期圖解 驗證-Tomcat來創建Filter實例,只會創建一個實例 package com.filter; import javax.servlet.*; import javax.servlet.http.HttpServl ...
Filter過濾器02
5.Filter過濾器生命周期
- Filter生命周期圖解
-
驗證-Tomcat來創建Filter實例,只會創建一個實例
package com.filter; import javax.servlet.*; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpSession; import java.io.IOException; /** * 1.filter在web項目啟動時,由Tomcat來創建Filter實例,只會創建一個實例 * 2.會調用filter的預設無參構造器,同時會調用init()方法,只會調用一次 * 3.在創建filter實例時,同時會創建FilterConfig對象,並通過init()方法傳入 * 4.通過FilterConfig對象,程式員可以獲取該filter的相關配置信息 * 5.當一個http請求和該filter的url-pattern匹配時,就會調用doFilter()方法 * 6.在調用doFilter()方法時,Tomcat會同時創建ServletRequest,ServletResponse和FilterChain三個對象 * 並通過doFilter方法傳入 * 7.如果後面的請求目標資源(jsp,servlet..)會使用到request,response,那麼會繼續傳遞, * 即request和後面的request是同一個,response和後面的也是同一個 */ public class ManageFilter implements Filter { private int count = 0; @Override public void init(FilterConfig filterConfig) throws ServletException { //當Tomcat創建filter後,會調用該方法,進行初始化 System.out.println("ManageFilter init方法被調用..."); } @Override public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,FilterChain filterChain) throws IOException, ServletException { System.out.println("doFilter被調用的次數=" + (++count)); } @Override public void destroy() { //當filter對像被銷毀時,就會調用該方法 System.out.println("ManageFilter destroy被調用..."); } }
redeployTomcat,在瀏覽器訪問資源,觸發過濾器,後臺輸出如下:
6.FilterConfig
6.1FilterConfig基本使用
-
FilterConfig介面圖
-
FilterConfig說明
- FilterConfig是Filter過濾器的配置類
- Tomcat每次創建Filter的時候,也會創建一個FilterConfig對象,這裡包含了Filter配置文件的配置信息。
- FilterConfig對象的作用是獲取filter過濾器的配置內容
FilterConfig的簡單使用:
DemoFilterConfig:
package com.filter;
import javax.servlet.*;
import java.io.IOException;
import java.util.Enumeration;
/**
* 演示FilterConfig使用
*/
public class DemoFilterConfig implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("DemoFilterConfig init方法被調用...");
//演示通過FilterConfig獲取相關的參數
//獲取filter在xml中配置的名字<filter-name>
String filterName = filterConfig.getFilterName();
//獲取指定參數
String ip = filterConfig.getInitParameter("ip");
//filterConfig可以獲取到ServletContext,
// 這意味著filter過濾器可以和任何Servlet進行通信
ServletContext servletContext = filterConfig.getServletContext();
//這裡可以獲取該filter所有的配置的參數名
// (也可以進一步使用getInitParameter獲取指定參數)
Enumeration<String> initParameterNames =
filterConfig.getInitParameterNames();
//遍歷枚舉
while (initParameterNames.hasMoreElements()) {
System.out.println("名字= " + initParameterNames.nextElement());
}
System.out.println("filterName= " + filterName);
System.out.println("ip= " + ip);
System.out.println("servletContext= " + servletContext);
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
}
@Override
public void destroy() {
}
}
在web.xml文件中配置filter:
<!--配置DemoFilterConfig-->
<filter>
<filter-name>DemoFilterConfig</filter-name>
<filter-class>com.filter.DemoFilterConfig</filter-class>
<!--這裡就是給filter配置的參數-由程式員根據業務邏輯來設置-->
<init-param>
<param-name>ip</param-name>
<param-value>166.66.66.66</param-value>
</init-param>
<init-param>
<param-name>port</param-name>
<param-value>8888</param-value>
</init-param>
<init-param>
<param-name>email</param-name>
<param-value>[email protected]</param-value>
</init-param>
<!---->
</filter>
<filter-mapping>
<filter-name>DemoFilterConfig</filter-name>
<url-pattern>/abc/*</url-pattern>
</filter-mapping>
redeployTomcat,後臺輸出如下:
可以看到FilterConfig對象可以獲取filter過濾器的配置內容。
6.2簡單應用-封殺ip
需求:只要某個網段(如以127.0開頭的ip)訪問我們的web應用,就將其返回登錄頁面,不允許訪問網站。
思路:在web.xml文件中,將要封殺的網段作為初始配置信息。filter實例創建的時候,在init方法中讀取配置的要封殺的網段信息,在filter使用的過程中,如果發現用戶的請求ip包含了配置的ip網段,就認為是被封殺的ip,進行處理。
細節補充:filter配置的初始化信息只能在init方法中通過FilterConfig對象來獲取。為了讓doFilter方法中也能使用到,我們在filter類中創建一個屬性,在init方法中將獲取的配置ip賦給屬性,讓其在doFilter方法中也能使用。
例子
DemoFilterConfig:
package com.filter;
import javax.servlet.*;
import java.io.IOException;
import java.util.Enumeration;
/**
* 演示FilterConfig使用
*/
public class DemoFilterConfig implements Filter {
private String ip;//從配置中獲取的ip
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("DemoFilterConfig init方法被調用...");
//獲取指定參數
ip = filterConfig.getInitParameter("ip");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
//通過forbidden ip來控制
//先獲取訪問ip
String remoteAddr = servletRequest.getRemoteAddr();
if (remoteAddr.contains(ip)) {//如果訪問ip包含了配置ip
//封殺該網段
System.out.println("當前訪問的ip為" + remoteAddr + "-封殺該網段...");
servletRequest.getRequestDispatcher("/login.jsp")
.forward(servletRequest, servletResponse);
return;//直接返回
}
//否則就繼續訪問目標資源
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
}
}
在web.xml中配置filter:
<!--配置DemoFilterConfig-->
<filter>
<filter-name>DemoFilterConfig</filter-name>
<filter-class>com.filter.DemoFilterConfig</filter-class>
<!--配置封殺網段-->
<init-param>
<param-name>ip</param-name>
<param-value>127.0</param-value>
</init-param>
<!---->
</filter>
<filter-mapping>
<filter-name>DemoFilterConfig</filter-name>
<url-pattern>/abc/*</url-pattern>
</filter-mapping>
redeployTomcat,在瀏覽器直接訪問web應用abc目錄下的資源,以觸發filter。
可以看到瀏覽器直接返回登錄頁面。因為當前訪問的ip為127.0.0.1,filter檢測到當前地址為封殺網段,將頁面直接轉發回登錄頁面。
後臺輸出:
7.FilterChain過濾器鏈
一句話FilterChain:在處理某些複雜業務時,一個過濾器不夠,可以設計多個過濾器共同完成過濾任務,形成過濾器鏈。
7.1基本原理示意圖
如上,伺服器接收請求,將請求中的url和過濾器的配置的url-pattern匹配,如果匹配成功,就會觸發過濾器。如果匹配多個過濾器的url-pattern,則執行多個過濾器。
-
第一個過濾器調用doFilter方法,走前置代碼(業務代碼),運行到chain.doFilter()時,若請求的url符合其他過濾器配置的url-pattern,就會在doFilter方法中執行下一個filter過濾器的doFilter方法。
多個filter過濾器的執行順序與web.xml文件中配置的順序一致。
-
下一個filter過濾器執行完前置代碼後,也在chain.doFilter()繼續判斷...依次類推,最後調用目標資源。
-
當目標資源調用完畢後,返回執行倒數第一個filter的後置代碼(業務代碼),然後返回執行倒數第二個filter後置代碼,依次類推....直到第一個filter的後置代碼執行完畢,然後伺服器向瀏覽器返迴響應。
這個返回調用的機制在事務提交上很有用
7.2過濾器鏈實例演示
需求:演示過濾器鏈的使用
AFilter:
package com.filter;
import javax.servlet.*;
import java.io.IOException;
public class AFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("AFilter doFilter 的前置代碼... ");
System.out.println("執行AFilter filterChain.doFilter()...");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("AFilter doFilter 的後置代碼... ");
}
@Override
public void destroy() {
}
}
BFilter:
package com.filter;
import javax.servlet.*;
import java.io.IOException;
public class BFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("BFilter doFilter 的前置代碼... ");
System.out.println("執行BFilter filterChain.doFilter()...");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("BFilter doFilter 的後置代碼... ");
}
@Override
public void destroy() {
}
}
在admin目錄下的hi.jsp:
<%--
Created by IntelliJ IDEA.
User: li
Date: 2022/11/29
Time: 17:55
Version: 1.0
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>admin 目錄下的 hi.jsp</title>
</head>
<body>
<h1>admin 目錄下的 hi.jsp</h1>
<h1>後臺管理</h1>
<a href="#">用戶列表</a>||<a href="#">添加用戶</a>||<a href="#">刪除用戶</a>
<hr/>
</body>
</html>
在web.xml中配置filter:
<!--配置AFilter和BFilter-->
<filter>
<filter-name>AFilter</filter-name>
<filter-class>com.filter.AFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>AFilter</filter-name>
<url-pattern>/admin/*</url-pattern>
</filter-mapping>
<filter>
<filter-name>BFilter</filter-name>
<filter-class>com.filter.BFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>BFilter</filter-name>
<url-pattern>/admin/*</url-pattern>
</filter-mapping>
redeployTomcat,在瀏覽器訪問http://localhost:8080/filter/admin/hi.jsp
。
後臺輸出如下:
7.3FilterChain註意事項和細節
-
多個filter和目標資源在一次http請求中,在同一線程中
-
當一個請求url和filter的url-pattern匹配時,才會被執行,如果有多個匹配上,就會順序執行,形成一個filter調用鏈
-
多個filter共同執行時,因為是一次http請求,使用的是同一個request對象
-
多個filter執行的順序和web.xml配置順序一致
-
chain.doFilter(req,resp)方法,將執行下一個過濾器的doFilter方法,如果後面沒有過濾器,則執行目標資源
-
小結:註意執行過濾器鏈時,順序是(以7.2的例子演示):
HTTP請求->A過濾器doFilter()->A過濾器前置代碼->A過濾器chain.doFilter()->B過濾器doFilter()->B過濾器前置代碼—>B過濾器chain.doFilter()->目標文件->B過濾器後置代碼->A過濾器後置代碼->返回給瀏覽器頁面/數據
8.Filter練習
需求:使用過濾器,完成如下要求
- 點擊發表評論頁面topic.jsp,可以在showTopic.jsp顯示評論內容
- 如果發表的評論內容中,有關鍵字比如“蘋果”,“香蕉”,就返回topic.jsp,並提示有禁用詞
- 要求發表評論到showTopic.jsp時,要經過過濾器的處理
- 禁用詞配置在過濾器,在啟動項目時動態獲取,註意中文的處理
練習
topic.jsp:
<%--
Created by IntelliJ IDEA.
User: li
Date: 2022/11/29
Time: 22:17
Version: 1.0
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>topic</title>
</head>
<body>
<form action="<%=request.getContextPath()%>/hw/showTopic.jsp" method="post">
<h1>發表對阿凡達電影的評論</h1>
過濾詞:蘋果,香蕉
<div style="color: red">${notice}</div>
用戶:<input type="text" name="username"/><br/>
評論:<textarea cols="15" rows="5" name="topic"></textarea><br/>
<input type="submit" value="發表評論">
</form>
</body>
</html>
showTopic.jsp:
<%--
Created by IntelliJ IDEA.
User: li
Date: 2022/11/29
Time: 22:18
Version: 1.0
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h3>用戶:<span style="color: #6799f3">
<%=request.getParameter("username")%></span></h3>
<h3>發表的評論是:<%=request.getParameter("topic")%>
</h3>
</body>
</html>
TopicFilter:
package com.filter.hw;
import javax.servlet.*;
import java.io.IOException;
public class TopicFilter implements Filter {
private String[] forbiddenWords;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//獲取配置信息(禁用詞)
String forbiddenWord = filterConfig.getInitParameter("forbiddenWord");
forbiddenWords = forbiddenWord.split(",");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
FilterChain filterChain) throws IOException, ServletException {
//註意中文亂碼問題!!!
servletRequest.setCharacterEncoding("utf-8");
//獲取用戶評論
String username = servletRequest.getParameter("username");
String topic = servletRequest.getParameter("topic");
//評論不能為空
if (topic == null || "".equals(topic)) {
servletRequest.setAttribute("notice", "評論不能為空!");
servletRequest.getRequestDispatcher("/hw/topic.jsp")
.forward(servletRequest, servletResponse);
return;
}
//判斷評論是否有禁用詞
for (String forbiddenWord : forbiddenWords) {
if (topic.contains(forbiddenWord)) {
servletRequest.setAttribute("notice", "含有敏感詞...");
servletRequest.getRequestDispatcher("/hw/topic.jsp")
.forward(servletRequest, servletResponse);
return;
}
}
//如果沒有禁用詞,且評論不為空
servletRequest.getRequestDispatcher("/hw/showTopic.jsp")
.forward(servletRequest, servletResponse);
}
@Override
public void destroy() {
}
}
在web.xml中配置filter:
<!--配置TopicFilter-->
<filter>
<filter-name>TopicFilter</filter-name>
<filter-class>com.filter.hw.TopicFilter</filter-class>
<!--配置禁用詞-->
<init-param>
<param-name>forbiddenWord</param-name>
<param-value>香蕉,蘋果</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>TopicFilter</filter-name>
<!--精準匹配-->
<url-pattern>/hw/showTopic.jsp</url-pattern>
</filter-mapping>
redeployTomcat,在瀏覽器訪問http://localhost:8080/filter/hw/topic.jsp
-
輸入不含敏感詞的評論:
-
輸入含敏感詞的評論: