一文详解JavaWeb过滤器(Filter)

什么是JavaWeb过滤器？

JavaWeb过滤器(Filter)是一个可以拦截客户端与服务器之间的请求和响应的组件，它的作用就像一个保镖，协助我们控制和管理请求和响应。

过滤器的作用

过滤器可以用来完成以下功能：

• 认证用户访问权限
• 过滤违禁词汇和表情等内容
• 对请求或响应进行加密、压缩、解压
• 记录请求和响应信息
• 其他

过滤器的分类

过滤器分为两类：

• Servlet过滤器（按请求URL、Servlet或JSP名称等来匹配和拦截请求）
• 监听器（监听Servlet、Session、Request、Context、Attribute等的变化并采取相应的处理措施）

过滤器的使用

一个典型的过滤器使用分为三个步骤：

1. 实现javax.servlet.Filter接口，并实现其中的doFilter方法，doFilter方法中定义过滤器逻辑，并使用FilterChain将请求和响应传递下去。

2. 配置过滤器，可以在web.xml中配置过滤器，也可以使用注解来配置。

3. 部署应用程序并启动Tomcat服务器。

示例1：过滤器统计访问次数

@WebFilter(urlPatterns = "/hello/*")
public class VisitFilter implements Filter {

    private int count = 0;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("VisitFilter init");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        count++;
        System.out.println("Visit count:" + count);
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        System.out.println("VisitFilter destory");
    }
}

上面的代码实现了一个统计请求次数的过滤器。当请求的URL以“/hello/”开头时，就会触发该过滤器进行拦截。

示例2：过滤器实现权限验证

@WebFilter(urlPatterns = "/*")
public class AuthenticationFilter implements Filter {

    private List<String> whitelist = Arrays.asList("/login.jsp", "/login");
    private String loginURI = "/login.jsp";

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("AuthenticationFilter init");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest req = (HttpServletRequest) request;
        HttpServletResponse res = (HttpServletResponse) response;
        String uri = req.getRequestURI();
        boolean requestRestricted = true;
        if (whitelist.contains(uri) || uri.startsWith("/css/") || uri.startsWith("/js/")) {
            requestRestricted = false;
        }
        HttpSession session = req.getSession();
        boolean loggedIn = session != null && session.getAttribute("user") != null;
        if (requestRestricted && !loggedIn) {
            res.sendRedirect(loginURI);
            return;
        }
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        System.out.println("AuthenticationFilter destory");
    }
}

上面的代码实现了一个权限验证的过滤器。当请求任何URL时，都会触发该过滤器进行拦截。如果用户未登录，则跳转到登录页面。需要注意的是，登录页面本身也需要在白名单中，否则就会出现死循环。

总结

JavaWeb过滤器是非常重要和有用的组件，可以帮助我们控制和管理请求和响应。合理使用过滤器，可以提高应用程序的可靠性、安全性和性能。