1.基本的な考え方
実生活では、お茶のろ過、下水のろ過、砂のろ過などに携わっていますが
、JavaWebではろ過も行っています。現時点ではフィルターを使用する必要があり、フィルターはもともと「フィルター」を意味します"。、その役割は、一部のコンテンツとデータをフィルタリングすることです。
専門用語:JavaWebの3つの主要コンポーネントの1つであり、3つの主要コンポーネントは、サーブレット、フィルター、リスナーです。
2.働き方
このフィルターは、ブラウザーとWebリソース間のフィルターと同等であることがわかります。リソースにアクセスする前に、一連のフィルターを介して要求が変更、判断、および傍受され、応答も変更、判断、および傍受されました。待ってください。
3.使用方法
最初にログインの例を見てみましょう。この例には、ログインページ(login.jsp)とホームページ(main.jsp)があります。ログインに成功したら、main.jspにジャンプしてユーザー名を表示する必要があります。
プロジェクト構造:
login.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>登录页面</title>
</head>
<body>
<form action="login" method="post">
用户名: <input type="text" name="userName"/><br/>
密 码:<input type="password" name="password"/><br/>
<input type="submit" value="登录"/>
</form>
</body>
</html>
main.jsp:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>主页面</title>
</head>
<body>
<h1>登录成功,欢迎${sessionScope.userName}使用!</h1>
</body>
</html>
LoginServlet.java
@WebServlet(name = "LoginServlet", urlPatterns = "/login")
public class LoginServlet extends HttpServlet {
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 1.接收前端页面输入的用户名和密码信息并打印
String userName = request.getParameter("userName");
System.out.println("接收到的用户名为:" + userName);
String password = request.getParameter("password");
System.out.println("接收到的密码为:" + password);
// 2.使用固定的用户名和密码信息来进行登录的校验
if ("admin".equals(userName) && "123456".equals(password)) {
System.out.println("登录成功,欢迎使用!");
// 存储用户名信息
request.getSession().setAttribute("userName", userName);
response.sendRedirect("main.jsp");
} else {
System.out.println("用户名或密码错误,请重新输入!");
request.getRequestDispatcher("login.jsp").forward(request, response);
}
}
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
this.doPost(request, response);
}
}
ログインに成功すると、ホームページにジャンプします。効果は次のとおりです。
ただし、main.jspのパスをコピーすると、ブラウザの別のページからアクセスすることもできますが、現時点ではログインユーザー名は表示されていません。
そして、私たちが今しなければならないことは、彼がログインしていない場合に彼がホームページにアクセスできないようにすることです。このときフィルターが必要です。実装は次のとおりです。
- カスタムクラスはFilterインターフェイスを実装し、doFilterメソッドをオーバーライドします
public class LoginFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
// 1.实现对用户访问主页面的过滤操作,也就是只有用户登录后才能访问主页面,否则一律拦截
// 判断session中是否已有用户名信息,若没有则进行拦截,否则放行
HttpServletRequest httpServletRequest = (HttpServletRequest)servletRequest;
HttpSession session = httpServletRequest.getSession();
Object userName = session.getAttribute("userName");
// 获取Servlet的请求路径
String servletPath = httpServletRequest.getServletPath();
// 若没有登录,则回到登录页面
if (null == userName && !servletPath.contains("login")) {
servletRequest.getRequestDispatcher("login.jsp").forward(servletRequest, servletResponse);
} else {
// 若已经登录,则放行
filterChain.doFilter(servletRequest, servletResponse);
}
}
@Override
public void destroy() {
}
}
- web.xmlファイルでフィルターを構成します
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<filter>
<filter-name>LoginFilter</filter-name>
<filter-class>com.example.demo01.LoginFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>LoginFilter</filter-name>
<url-pattern>/main.jsp</url-pattern>
</filter-mapping>
</web-app>
このように、コピーパスから直接ホームページにアクセスすると、アクセスできなくなり、傍受されてログインページにジャンプし、ホームページのセキュリティを確保します。
ps:リリースが必要な場合は、メソッドchain.doFilter(request、response)を呼び出す必要があることに注意してください。これは固定ステートメントです。
4.フィルターインターフェース
(1)javax.servlet.Filterインターフェース。フィルター・オブジェクトを記述するために使用されます。他のクラスがFilterインターフェースを実装している限り、それらはfilter関数を実装できます。
(2)Filterインターフェースには、主に3つのメソッドがあり、フィルターのライフサイクルを表します。3つの方法は次のとおりです。
public class LifeFilter implements Filter {
public LifeFilter() {
System.out.println("构造方法执行!");
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("初始化操作正在火热进行中...");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("阻拦一切不合理的访问哦!");
}
@Override
public void destroy() {
System.out.println("销毁操作执行完毕了!");
}
}
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<filter>
<filter-name>LifeFilter</filter-name>
<filter-class>com.lagou.demo02.LifeFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>LifeFilter</filter-name>
<url-pattern>*.html</url-pattern>
</filter-mapping>
</web-app>
実行効果
ご覧のとおり、構築メソッドはinitメソッドの前に実行されます。
構築メソッドとinitメソッドはどちらも、サーバーの起動時またはサービスのデプロイ
時に呼び出されます。doFilterメソッドは、ブラウザーがパスを要求したときに呼び出されます。destroyメソッドは
、サービスが再デプロイまたは停止されたときに呼び出されます。
5.FilterConfigインターフェース
(1)javax.servlet.FilterConfigインターフェース。フィルターの構成情報を記述するために使用されます。
(2)FilterConfigインターフェイスには主に4つのメソッドがあります。4つのメソッドは次のとおりです。
(3)Filterのinitメソッドのパラメーター参照がFilterConfigインターフェイスであるため、FilterConfigインターフェイスをinitメソッドで実行できることに気づきましたか。関連するメソッド呼び出しの例は次のとおりです
。web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<filter>
<filter-name>LifeFilter</filter-name>
<filter-class>com.example.demo02.LifeFilter</filter-class>
<init-param>
<param-name>userName</param-name>
<param-value>admin</param-value>
</init-param>
<init-param>
<param-name>password</param-name>
<param-value>123456</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>LifeFilter</filter-name>
<url-pattern>*.html</url-pattern>
</filter-mapping>
</web-app>
LifeFilter.java:
public class LifeFilter implements Filter {
public LifeFilter() {
System.out.println("构造方法执行!");
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("初始化操作正在火热进行中...");
System.out.println("获取到的过滤器名称为:" + filterConfig.getFilterName());
String userName = filterConfig.getInitParameter("userName");
System.out.println("获取到指定初始化参数的数值为:" + userName); // admin
Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
while (initParameterNames.hasMoreElements()) {
// userName password
System.out.println("获取到的初始化参数名为:" + initParameterNames.nextElement());
}
ServletContext servletContext = filterConfig.getServletContext();
System.out.println("获取到的上下文对象是:" + servletContext);
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("阻拦一切不合理的访问哦!");
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
System.out.println("销毁操作执行完毕了!");
}
}
運転結果
6.複数のフィルターの使用
上図によると、
要求時の実行順序は、フィルター1->フィルター2->フィルター3です。
戻る場合の実行順序は、フィルター3->フィルター2->フィルター1です。
複数のフィルターで多層フィルタリングを実現できます。実装は、Filterインターフェースを継承する複数のJavaクラスを作成し、それらをweb.xmlで構成することです。
複数のフィルターの実行順序は、URLマッピング構成のどちらか最初に実行された構成に関連しています。
web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<filter>
<filter-name>BFilter</filter-name>
<filter-class>com.example.demo02.BFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>BFilter</filter-name>
<url-pattern>*.avi</url-pattern>
</filter-mapping>
<filter>
<filter-name>AFilter</filter-name>
<filter-class>com.example.demo02.AFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>AFilter</filter-name>
<url-pattern>*.avi</url-pattern>
</filter-mapping>
</web-app>
フィルタ:
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("这是第一道防线!");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("第一道防线返回!");
}
@Override
public void destroy() {
}
}
Bフィルター:
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("这是第二道防线!");
filterChain.doFilter(servletRequest, servletResponse);
System.out.println("第二道防线返回!");
}
@Override
public void destroy() {
}
}
演算結果:
ご覧のとおり、フィルタBのフィルタマッピング構成が前面に記述されているため、要求時にフィルタBが先に実行されます。
7.フィルターの利点
- コードの「プラグ可能性」を実現する、つまり特定の機能モジュールを追加または削減しても、プログラムの通常の実行には影響しません(たとえば、ログイン機能はフィルターなしで通常どおりログインできます)。
- 同じ処理ロジックを持つ複数のモジュールをフィルターに記述して、コードの再利用(各要求の認証など)を実現できます。