目录
什么是过滤器
- Filter过滤器是JavaWeb的三大组件之一,三大组件分别是:Servlet程序、Listener监听器、Filter过滤器
- Filter过滤器是JavaEE的规范,也就是接口
- 作用:拦截请求,过滤响应
拦截请求常用的应用场景:
- 权限检查
- 日记操作
- 事务管理
Filter初体验
要求在web工程下有一个admin目录,这个目录下的所有资源(html、jpg、jsp...)都必须是用户登录后才允许访问
创建项目Filter0728
新建a.html和a.jsp:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
我是a.html文件
</body>
</html>
<%--
Created by IntelliJ IDEA.
User: magic book
Date: 2024-07-28
Time: 16:37
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
我是a.jsp文件
</body>
</html>
启动:
用户登录之后会把用户登录的信息保存到Session域中,所以要检查用户是否登录,可以判断Seesion中是否包含用户登录的信息即可
在webapp下新建login.jsp:
<%--
Created by IntelliJ IDEA.
User: magic book
Date: 2024-07-28
Time: 16:48
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
这是登录页面login
</body>
</html>
启动访问:http://localhost:8080/Filter0728/admin/a.jsp
使用Filter:
新建AdminFilter类:
package com.qcby.filter0728;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.io.IOException;
public class AdminFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
//Filter.super.init(filterConfig);
}
/**
* doFilter方法,专门用于拦截请求,可以做权限检查
* @param servletRequest
* @param servletResponse
* @param filterChain
* @throws IOException
* @throws ServletException
*/
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
HttpSession session = httpServletRequest.getSession();
Object user = session.getAttribute("user");
//如果等于null,说明还没有登录
if(user == null){
//请求转发
servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
return;
}else{
//让程序继续往下访问用户的目标资源
filterChain.doFilter(servletRequest,servletResponse);
}
}
@Override
public void destroy() {
//Filter.super.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过滤器-->
<filter>
<!--给filter起一个别名-->
<filter-name>AdminFilter</filter-name>
<!--配置filter的全类名-->
<filter-class>com.qcby.filter0728.AdminFilter</filter-class>
</filter>
<!--filter-mapping标签用于配置Filter过滤器的拦截路径-->
<filter-mapping>
<!--当前的拦截路径给哪个filter使用-->
<filter-name>AdminFilter</filter-name>
<!--配置拦截路径-->
<url-pattern>/admin/*</url-pattern>
</filter-mapping>
</web-app>
启动:
总结-Filter过滤器的使用步骤:
- 编写一个类去实现Filter接口
- 实现过滤方法doFilter()
- 到web.xml中去配置Filter的拦截路径
完整实现登录:
login.jsp:
<%--
Created by IntelliJ IDEA.
User: magic book
Date: 2024-07-28
Time: 16:48
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
这是登录页面login
<form action="http://localhost:8081/Filter0728/loginServlet" method="get">
用户名:<input type="text" name="username"><br>
密码:<input type="password" name="password"><br>
<input type="submit">
</form>
</body>
</html>
LoginServlet :
package com.qcby.filter0728.servlet;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
public class LoginServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.setContentType("text/html;charset=UTF-8");
String username = req.getParameter("username");
String password = req.getParameter("password");
if("admin".equals(username) && "123456".equals(password)){
req.getSession().setAttribute("user",username);
resp.getWriter().write("登录成功");
}else{
req.getRequestDispatcher("/login.jsp").forward(req,resp);
}
}
}
启动:
Filter的生命周期
Filter的生命周期包含几个方法:
- 构造器方法
- init初始化方法
- doFilter过滤方法
- destroy销毁
第一、二步在web工程启动时执行(Filter已经创建)
第三步每次拦截到请求就会执行
第四步停止web工程时就会执行(停止web工程也会销毁Filter过滤器)
package com.qcby.filter0728;
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;
import java.io.IOException;
public class AdminFilter implements Filter {
public AdminFilter() {
System.out.println("1.构造器方法");
}
@Override
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println("2.init方法");
}
/**
* doFilter方法,专门用于拦截请求,可以做权限检查
* @param servletRequest
* @param servletResponse
* @param filterChain
* @throws IOException
* @throws ServletException
*/
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("3.doFilter方法");
HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
HttpSession session = httpServletRequest.getSession();
Object user = session.getAttribute("user");
//如果等于null,说明还没有登录
if(user == null){
//请求转发
servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest,servletResponse);
return;
}else{
//让程序继续往下访问用户的目标资源
filterChain.doFilter(servletRequest,servletResponse);
}
}
@Override
public void destroy() {
System.out.println("4.destroy方法");
}
}
FilterConfig类
FilterConfig类是Filter过滤器的配置文件类,tomcat每次创建Filter时,也会同时创建一个FilterConfig类,包含Filter配置文件的配置信息
FilterConfig类的作用是获取Filter过滤器的配置内容:
- 获取Filter的名称:filter-name的内容
- 获取在web.xml中配置的init-param初始化参数
- 获取ServletContext对象
启动输出为:
FilterChain过滤器链
FilterChain是过滤器链(多个过滤器如何一起工作)
在多个Filter过滤器执行时,它们执行的优先顺序是由它们在web.xml中从上到下配置的顺序决定
多个Filter过滤器执行的特点:
- 所有Fliter和目标资源默认都执行在同一个线程中
- 多个Filter共同执行时都使用同一个Request对象
Filter的拦截路径
精确匹配:
<url-pattern>/target.jsp</url-pattern>
以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/target.jsp
目录匹配:
<url-pattern>/admin/*</url-pattern>
以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/admin/*
后缀名匹配:
不能以/开头
<url-pattern>*.html</url-pattern>
以上配置的路径,表示请求地址必须以.html结尾才会拦截到
<url-pattern>*.do</url-pattern>
以上配置的路径,表示请求地址必须以.do结尾才会拦截到
说明:Filter过滤器只关心请求的地址是否匹配,不关心请求的资源是否存在