JavaWeb学习——过滤器

一、Filter 什么是过滤器

• Filter 过滤器它是 JavaWeb 的三大组件之一。

三大组件分别是：Servlet 程序、Listener 监听器、Filter 过滤器

• Filter 过滤器它是 JavaEE 的规范。也就是接口
• Filter 过滤器它的作用是：拦截请求，过滤响应
• 拦截请求常见的应用场景有： 1、权限检查 2、日记操作 3、事务管理 ……等等

---

二、Filter的初体验

要求：在web 工程下，有一个 admin 目录。这个 admin 目录下的所有资源（html 页面、jpg 图片、jsp 文件、等等）都必须是用户登录之后才允许访问。

思考：我们知道，用户登录之后都会把用户登录的信息保存到 Session 域中。所以要检查用户是否 登录，可以判断 Session 中否包含有用户登录的信息即可

<%
Object user = session.getAttribute("user");
// 如果等于 null，说明还没有登录
if (user == null) {
request.getRequestDispatcher("/login.jsp").forward(request,response);
return;
}
%>

1、Filter 的工作流程：

Filter:

public class AdminFilter implements Filter {
/**
* doFilter 方法，专门用于拦截请求。可以做权限检查
*/
@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);
}
}
}

web.xml 中的配置：

<!--filter标签用于配置一个Filter过滤器    -->
    <filter>
       <!--给filter起一个别名        -->
        <filter-name>AdminFilter</filter-name>
       <!--配置filter的全类名        -->
        <filter-class>filter.AdminFilter</filter-class>
    </filter>
<!--filter-mapping配置filter过滤器的拦截路径    -->
    <filter-mapping>
        <!--表示当前的拦截路径给哪个filter使用使用        -->
        <filter-name>AdminFilter</filter-name>
        <!--url-patter配置拦截路径
             /  表示请求地址未：http://ip:port/工程路径/   映射到IDEA的web目录下
             /admin/*  表示请求地址未 表示请求地址未：http://ip:port/工程路径/admin/*
                -->
        <url-pattern>/admin/*</url-pattern>
    </filter-mapping>

2、Filter过滤器的使用步骤：

1. 编写一个类去实现Filter接口
2. 实现过滤方法doFilter()
3. 到web.xml中去配置Filter的拦截路径

3、完整的用户登录:

login.jsp 页面 == 登录表单

这是登录页面。login.jsp 页面 <br>
<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" />
</form>

LoginServlet 程序：

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 ("wzg168".equals(username) && "123456".equals(password)) {
req.getSession().setAttribute("user",username);
resp.getWriter().write("登录 成功！！！");
} else {
req.getRequestDispatcher("/login.jsp").forward(req,resp);
}
}
}

---

 

三、Filter的生命周期

Filter 的生命周期包含几个方法：

    1、构造器方法

    2、init初始化方法

              第1、2步，在web工程启动时执行（Filter已经创建）

    3、doFilter过滤方法

              第3步，每次拦截到请求，就会执行（Filter已经创建）

    4、destroy销毁方法 

              第4步，停止web工程时，就会执行（停止web工程，也会销毁Filter过滤器）

---

四、FilterConfig类

• FilterConfig 类见名知义，它是 Filter 过滤器的配置文件类。
• Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类，这里包含了 Filter 配置文件的配置信息
• FilterConfig 类的作用是获取 filter 过滤器的配置内容

1. 获取 Filter 的名称 filter-name 的内容
2. 获取在web.xml中配置的 init-param 初始化参数
3. 获取 ServletContext 对象

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("2、Filter方法A初始化方法init（）");
        //1、获取 Filter 的名称 filter-name 的内容
        System.out.println("filter-name:"+filterConfig.getFilterName());
        //2、获取在 web.xml 中配置的 init-param 初始化参数
        System.out.println("初始化参数username的值:"+filterConfig.getInitParameter("username"));
        System.out.println("初始化参数url的值:"+filterConfig.getInitParameter("url"));
        //3、获取 ServletContext 对象
        System.out.println(filterConfig.getServletContext());
    }

web.xml 配置： 

        <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://localhost3306/test</param-value>
        </init-param>

五、FilterChain过滤链类（多个过滤器一起工作）

1、FilterChian.doFilter() 方法的作用

1. 执行下一个filter过滤器（如果有filter）
2. 执行目标资源（如果没有filter）

 2、多个Filter过滤器执行的特点：

1. 所有filter和目标资源默认都执行在同一个线程中。
2. 多个filer共同执行的时候，它们都使用同一个request对象。

注意：在多个filter过滤器执行的时候，它们执行的优先顺序是由它们在web.xml中从上到下配置里的顺序决定

---

六、Filter 的拦截路径

1、精确匹配

<url-pattern>/target.jsp</url-pattern>

以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/target.jsp

2、目录匹配

<url-pattern>/admin/*</url-pattern>

以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/admin/

3、后缀名匹配

• <url-pattern>*.html</url-pattern>

*.html 以上配置的路径，表示请求地址必须以.html 结尾才会拦截到

• <url-pattern>*.do</url-pattern>

*.do 以上配置的路径，表示请求地址必须以.do 结尾才会拦截到

•    <url-pattern>*.action </url-pattern>

*.action 以上配置的路径，表示请求地址必须以.action 结尾才会拦截到