Filter

文章目录

Tips

凡是要对多个Servlet进行统一处理的代码，都可以写在Filter中

作用：

1. 记录消息日志： 需要记录哪个IP，什么时间访问了什么请求，传入了哪些参数…
2. 记录异常日志: 对全局异常进行处理
3. 控制访问权限： 系统某些功能或者所有功能都需要登录后才能使用。
4. 字符集设置

示例

这是登录页面 login.jsp  <br>
<form action="/loginServlet" method="get">
	用户名：<input type="text" name="username"/> <br>
	密 码：<input type="password" name="password"/> <br>
	<input type="submit" />
</form>

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);
		}
	}
}

@WebFilter("/*")
public class AdminFilter implements Filter {
    
	@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>com.atguigu.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/* -->
	<url-pattern>/admin/*</url-pattern>
</filter-mapping>

生命周期

@WebFilter("/*")
public class MyFilter implements Filter {
    

    public MyFilter() {
    
        System.out.println("1.构造方法，启动服务器的时候执行");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    
        System.out.println("2.初始化方法，启动服务器的时候执行");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    
        System.out.println("3.doFilter,访问任何经过该过滤器的页面都会执行一次");
        // 执行后续
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
    
        System.out.println("4.destroy，关闭服务器的时候执行");
    }
}

FilterConfig 类

Tips

Filter 过滤器的配置文件类，Tomcat 每次创建 Filter 的时候，也会同时创建一个 FilterConfig 类

拦截路径设置同 Servlet 中的 url-pattern 设置

Filter 作用：

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

示例

@Override
public void init(FilterConfig filterConfig) throws ServletException {
    
    System.out.println("2.Filter 的 init(FilterConfig filterConfig)初始化");
    
    // 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 对象
    //org.apache.catalina.core.ApplicationContextFacade@d359b2b
    System.out.println(filterConfig.getServletContext());
}

<!--filter 标签用于配置一个 Filter 过滤器-->
<filter>
	<!--给 filter 起一个别名-->
	<filter-name>AdminFilter</filter-name>
	<!--配置 filter 的全类名-->
	<filter-class>com.atguigu.filter.AdminFilter</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://localhost3306/test</param-value>
    </init-param>
</filter>

FilterChain 过滤器链

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

2. 所有filter和目标资源默认都执行在同一个线程中

3. 多个Filter共同执行的时候，它们都使用同一个Request对象

4. 如果某 Filter 内没有写 doFilter，那么从该Filter开始返回，不再继续往下执行

   即服务器认为执行到底了