第十四章:Filter过滤器
14.1Filter过滤器的介绍
1、Filter 过滤器它是 JavaWeb 的三大组件之一。三大组件分别是:Servlet 程序、Listener 监听器、Filter 过滤器;
2、Filter 过滤器它是 JavaEE 的规范,也就是接口;
3、Filter 过滤器它的作用是:拦截请求,过滤响应。
拦截请求常见的应用场景有:1、权限检查 2、日记操作 3、事务管理 ……等等
14.2Filter过滤器的简单实现
需求:在你的 web 工程下,有一个 admin 目录。这个 admin 目录下的所有资源(html 页面、jpg 图片、jsp 文件、等等)都必 须是用户登录之后才允许访问。
思考:根据之前我们学过内容。我们知道用户登录之后都会把用户登录的信息保存到 Session 域中。所以要检查用户是否登录,可以判断 Session 中否包含有用户登录的信息即可!
1. <%
2. Object user=session.getAttribute("user");
3. // 如果等于 null,说明还没有登录
4. if(user==null){
5. request.getRequestDispatcher("/login.jsp").forward(request,response);
6. return;
7. }
8. %>
Filter的工作流程图:
Filter实现代码:
9. import javax.servlet.ServletException;
10. import javax.servlet.ServletRequest;
11. import javax.servlet.ServletResponse;
12. import javax.servlet.http.HttpServletRequest;
13. import javax.servlet.http.HttpSession;
14. import java.io.IOException;
15.
16. public class AdminFilter implements Filter {
17. /**
18. * doFilter 方法,专门用于拦截请求。可以做权限检查
19. */
20. @Override
21. public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain
22. filterChain) throws IOException, ServletException {
23. HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
24. HttpSession session = httpServletRequest.getSession();
25. Object user = session.getAttribute("user");
26. // 如果等于 null,说明还没有登录
27. if (user == null) {
28. servletRequest.getRequestDispatcher("/login.jsp").forward(servletRequest, servletResponse);
29. return;
30. } else {
31. // 让程序继续往下访问用户的目标资源
32. filterChain.doFilter(servletRequest, servletResponse);
33. }
34. }
35. }
web.xml 中的配置:
1. <!--filter 标签用于配置一个 Filter 过滤器-->
2. <filter>
3. <!--给 filter 起一个别名-->
4. <filter-name>AdminFilter</filter-name>
5. <!--配置 filter 的全类名-->
6. <filter-class>com.atguigu.filter.AdminFilter</filter-class>
7. </filter>
8. <!--filter-mapping 配置 Filter 过滤器的拦截路径-->
9. <filter-mapping>
10. <!--filter-name 表示当前的拦截路径给哪个 filter 使用-->
11. <filter-name>AdminFilter</filter-name>
12. <!--url-pattern 配置拦截路径
13. / 表示请求地址为:http://ip:port/工程路径/ 映射到 IDEA 的 web 目录
14. /admin/* 表示请求地址为:http://ip:port/工程路径/admin/*
15. -->
16. <url-pattern>/admin/*</url-pattern>
17. </filter-mapping>
Filter 过滤器的使用步骤:
1、编写一个类去实现 Filter 接口;
2、实现过滤方法 doFilter();
3、到 web.xml 中去配置 Filter。
完整的用户登录:
login.jsp 页面 == 登录表单:
1. 这是登录页面。login.jsp 页面 <br>
2. <form action="http://localhost:8080/15_filter/loginServlet" method="get">
3. 用户名:<input type="text" name="username"/> <br>
4. 密 码:<input type="password" name="password"/> <br>
5. <input type="submit"/>
6. </form>
LoginServlet 程序:
7. import javax.servlet.ServletException;
8. import javax.servlet.http.HttpServlet;
9. import javax.servlet.http.HttpServletRequest;
10. import javax.servlet.http.HttpServletResponse;
11.
12. public class LoginServlet extends HttpServlet {
13. @Override
14. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException,
15. IOException {
16. resp.setContentType("text/html; charset=UTF-8");
17. String username = req.getParameter("username");
18. String password = req.getParameter("password");
19. if ("wzg168".equals(username) && "123456".equals(password)) {
20. req.getSession().setAttribute("user", username);
21. resp.getWriter().write("登录 成功!!!");
22. } else {
23. req.getRequestDispatcher("/login.jsp").forward(req, resp);
24. }
25. }
26. }
14.3Filter过滤器的生命周期
Filter 的生命周期包含几个方法 :
1、构造器方法
2、init 初始化方法
【第 1,2 步,在 web 工程启动的时候执行(Filter 已经创建)】
3、doFilter 过滤方法
【第 3 步,每次拦截到请求,就会执行 】
5、 destroy 销毁
【第 4 步,停止 web 工程的时候,就会执行(停止 web 工程,也会销毁 Filter 过滤器】
14.4FilterConfig 类
FilterConfig 类见名知义,它是 Filter 过滤器的配置文件类。 Tomcat 每次创建 Filter 的时候,也会同时创建一个 FilterConfig 类,这里包含了 Filter 配置文件的配置信息。
FilterConfig 类的作用是获取 filter 过滤器的配置内容
1、获取 Filter 的名称 filter-name 的内容;
2、获取在 Filter 中配置的 init-param 初始化参数;
3、获取 ServletContext 对象。
1. @Override
2. public void init(FilterConfig filterConfig)throws ServletException{
3. System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
4. // 1、获取 Filter 的名称 filter-name 的内容
5. System.out.println("filter-name 的值是:"+filterConfig.getFilterName());
6. // 2、获取在 web.xml 中配置的 init-param 初始化参数
7. System.out.println("初始化参数 username 的值是:"+filterConfig.getInitParameter("username"));
8. System.out.println("初始化参数 url 的值是:"+filterConfig.getInitParameter("url"));
9. // 3、获取 ServletContext 对象
10. System.out.println(filterConfig.getServletContext());
11. }
web.xml 配置:
1. <!--filter 标签用于配置一个 Filter 过滤器-->
2. <filter>
3. <!--给 filter 起一个别名-->
4. <filter-name>AdminFilter</filter-name>
5. <!--配置 filter 的全类名-->
6. <filter-class>com.atguigu.filter.AdminFilter</filter-class>
7. <init-param>
8. <param-name>username</param-name>
9. <param-value>root</param-value>
10. </init-param>
11. <init-param>
12. <param-name>url</param-name>
13. <param-value>jdbc:mysql://localhost3306/test</param-value>
14. </init-param>
15. </filter>
14.5FilterChain 过滤器链
Filter 过滤器
Chain 链,链条
FilterChain 就是过滤器链(多个过滤器如何一起工作)
14.6Filter过滤器的拦截路径
精确匹配:
1. <url-pattern>/target.jsp</url-pattern>
2. 以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/target.jsp
目录匹配:
1. <url-pattern>/admin/*</url-pattern>
2. 以上配置的路径,表示请求地址必须为:http://ip:port/工程路径/admin/*
后缀名匹配:
1. <url-pattern>*.html</url-pattern>
2. 以上配置的路径,表示请求地址必须以.html 结尾才会拦截到
3. <url-pattern>*.do</url-pattern>
4. 以上配置的路径,表示请求地址必须以.do 结尾才会拦截到
5. <url-pattern>*.action</url-pattern>
6. 以上配置的路径,表示请求地址必须以.action 结尾才会拦截到
【注意:Filter 过滤器它只关心请求的地址是否匹配,不关心请求的资源是否存在!!!】