1. Filter 过滤器
1、 Filter 过滤器它是 JavaWeb 的三大组件之一。三大组件分别是: Servlet 程序、 Listener 监听器、 Filter 过滤器2、 Filter 过滤器它是 JavaEE 的规范。也就是接口(javax包 )3、 Filter 过滤器它的作用是: 拦截请求 ,过滤响应。拦截请求常见的应用场景有:1、权限检查2、日记操作3、事务管理……等等
2. Filter 的初体验
要求:在你的 web 工程下,有一个 admin 目录。这个 admin 目录下的所有资源(
html 页面、jpg 图片、jsp 文件、等等)都必须是用户登录之后才允许访问。
思考:用户登录之后都会把用户登录的信息保存到
Session
域中。所以要检查用户是否登录,可以判断 Session
中否包含有用户登录的信息即可!!!
步骤:1. 编写Filter程序2. 编写登录系统(需有页面和servlet即可)
2.1 编写Filter程序
2.1.1 Filter 的工作流程图
2.1.2 Filter 过滤器的使用步骤
1、编写一个类去实现
Filter 接口
2、实现过滤方法 doFilter()
3、到 web.xml 中去配置 Filter 的拦截路径
2.1.3 示例代码
Filter 的代码:
public class AdminFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
// Filter.super.init(filterConfig);
}
@Override
/**
* doFilter 方法,专门用于拦截请求,过滤响应。可以用于权限检查
*/
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
HttpServletRequest req = (HttpServletRequest) request;
Object user = req.getSession().getAttribute("user");
if (user == null) {
// 如果为null 说明没有登录 则跳转登录界面
request.getRequestDispatcher("/login.html").forward(request,response);
response.getWriter().write("登录成功");
return;
}else{
// 让程序继续往下访问用户的目标资源
chain.doFilter(request,response);
}
}
@Override
public void destroy() {
// Filter.super.destroy();
}
}
web.xml 中的配置:
<filter>
<!-- 给 filter 起一个别名 -->
<filter-name>AdminFilter</filter-name>
<!-- 配置 filter 的全类名 -->
<filter-class>com.example._15_filter.AdminFilter</filter-class>
</filter>
<!-- filter-mapping 配置 Filter 过滤器的拦截路径 -->
<filter-mapping>
<!-- filter-name 表示当前的拦截路径给哪个 filter 使用 -->
<filter-name>AdminFilter</filter-name>
<!-- url-pattern 配置拦截路径
/ 表示请求地址为: http://ip:port/工程路径/ 映射到 IDEA 的 web 目录
/admin/* 表示请求地址为:http://ip:port/工程路径/admin/*
admin/* 表示admin 目录下的所有资源
-->
<url-pattern>/admin/*</url-pattern>
</filter-mapping>
2.2 编写登录系统(需有页面和servlet即可)
login.html
<html lang="en">
<head>
<meta charset="UTF-8">
<title>登录</title>
</head>
<body>
<form action="http://localhost:8080/15_filter/loginServlet" method="get">
用户名:<input type="text" name="username"/><br/>
密码:<input type="password" name="password"/><br/>
<input type="submit"/><br/>
</form>
</body>
</html>
LoginServlet:
public class LoginServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
response.setContentType("text/html;charset=UTF-8");
String username = request.getParameter("username");
String password = request.getParameter("password");
if ("admin".equals(username) && "admin".equals(password)) {
request.getSession().setAttribute("user", username);
response.getWriter().write("登录成功");
}else{
request.getRequestDispatcher("/login.html").forward(request,response);
}
}
}
3. Filter 的生命周期
Filter 的生命周期包含几个方法
1、构造器方法
2、init 初始化方法
第 1,2 步,在 web 工程启动的时候执行(Filter 已经创建)
3、doFilter 过滤方法
第 3 步,每次拦截到请求,就会执行
4、destroy 销毁
第 4 步,停止 web 工程的时候,就会执行(停止 web 工程,也会销毁 Filter 过滤器)
代码示例:
1.LiftFilter代码
public class LiftFilter implements Filter {
public LiftFilter() {
System.out.println("1. 构造方法");
}
public void init(FilterConfig config) throws ServletException {
System.out.println("2. init 初始化方法");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
System.out.println("3. doFilter 过滤方法");
chain.doFilter(request, response);
}
public void destroy() {
System.out.println("4. destroy 销毁方法");
}
}
2. web.xml代码:
<filter>
<filter-name>LiftFilter</filter-name>
<filter-class>com.example._15_filter.LiftFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>LiftFilter</filter-name>
<url-pattern>/abc.html</url-pattern>
</filter-mapping>
3. 打开abc.html页面
结果:
4. FilterConfig 类
FilterConfig 类见名知义,它是 Filter 过滤器的配置文件类。
Tomcat 每次创建 Filter 的时候,也会同时创建一个 FilterConfig 类,这里包含了 Filter 配置文件的配置信息。
FilterConfig 类的作用是获取 filter 过滤器的配置内容1、获取 Filter 的名称 filter-name 的内容2、获取在 Filter 中配置的 init-param 初始化参数3、获取 ServletContext 对象
java代码:
public void init(FilterConfig config) throws ServletException {
// System.out.println("2. init 初始化方法");
// 1、获取 Filter 的名称 filter-name 的内容
System.out.println("filter-name 的值是:" + config.getFilterName());
// 2、获取在 Filter 中配置的 init-param 初始化参数
System.out.println("初始化参数 username 的值是:" + config.getInitParameter("username"));
System.out.println("初始化参数 url 的值是:" + config.getInitParameter("url"));
// 3、获取 ServletContext 对象
System.out.println(config.getServletContext());
}
xml代码:
<filter>
<filter-name>LiftFilter</filter-name>
<filter-class>com.example._15_filter.LiftFilter</filter-class>
<init-param>
<param-name>username</param-name>
<param-value>root</param-value>
</init-param>
<init-param>
<param-name>url</param-name>
<param-value>jdbc:mysql:///test</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>LiftFilter</filter-name>
<url-pattern>/abc.html</url-pattern>
</filter-mapping>
结果:
5. FilterChain 过滤器链
Filter 过滤器
Chain 链,链条
FilterChain 就是过滤器链(多个过滤器如何一起工作)
代码演示:
1.Filter1代码:
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
request.setCharacterEncoding("UTF-8");
System.out.println("Filter1 的前置代码");
// 共用同一个线程
System.out.println("Filter1线程:"+Thread.currentThread().getName());
// 共用同一个Request 域
request.setAttribute("key","value");
System.out.println("从Filter1中获取Request域中的key:"+request.getAttribute("key"));
System.out.println();
chain.doFilter(request, response);
System.out.println("Filter1 的后置代码");
System.out.println();
}
2.Filter2代码:
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ServletException, IOException {
System.out.println("Filter2 的前置代码");
// 共用同一个线程
System.out.println("Filter2线程:"+Thread.currentThread().getName());
// 共用同一个Request 域
System.out.println("从Filter2中获取Request域中的key:"+request.getAttribute("key"));
System.out.println();
chain.doFilter(request, response);
System.out.println("Filter2 的后置代码");
System.out.println();
}
3.filterChain.jsp代码:
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<%
System.out.println("这里是 filterChain.jsp 页面");
System.out.println();
%>
<h1> 这里是 filterChain.jsp 页面</h1>
</body>
</html>
4.web.xml代码:
<filter>
<filter-name>Filter1</filter-name>
<filter-class>com.example._15_filter.Filter1</filter-class>
</filter>
<filter-mapping>
<filter-name>Filter1</filter-name>
<url-pattern>/filterChain.jsp</url-pattern>
</filter-mapping>
<filter>
<filter-name>Filter2</filter-name>
<filter-class>com.example._15_filter.Filter2</filter-class>
</filter>
<filter-mapping>
<filter-name>Filter2</filter-name>
<url-pattern>/filterChain.jsp</url-pattern>
</filter-mapping>
注意:过滤器执行顺序是按照xml中上到下的配置顺序
结果:
6. Filter 的拦截路径
6.1 精确匹配
< url-pattern >/target.jsp</ url-pattern >
以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/target.jsp
6.2 目录匹配
< url-pattern >/admin/*</ url-pattern >
以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/admin/*
6.3 后缀名匹配
<url-pattern>*.html</url-pattern>
以上配置的路径,表示请求地址必须以.html 结尾才会拦截到
<url-pattern>*.do</url-pattern>
以上配置的路径,表示请求地址必须以.do 结尾才会拦截到
<url-pattern>*.action</url-pattern>
以上配置的路径,表示请求地址必须以.action 结尾才会拦截到
Filter 过滤器它只关心请求的地址是否匹配,不关心请求的资源是否存在!!!