likes
comments
collection
share

Java 过滤器深入了解学习

作者站长头像
站长
· 阅读数 10

Java 过滤器深入了解学习

Java 过滤器深入了解学习

生活不能等待别人来安排,要自己去争取和奋斗;而不论其结果是喜是悲,但可以慰藉的是,你总不枉在这世界上活了一场。有了这样的认识,你就会珍重生活,而不会玩世不恭;同时,也会给人自身注入一种强大的内在力量。 ————路遥《平凡的世界》

什么是过滤器

在Java中,过滤器(Filter)是一种用于在Servlet容器中对请求和响应进行预处理和后处理的组件。过滤器可以用于执行一系列的任务,例如修改请求和响应的内容、验证用户身份、日志记录等。它们是Java EE(Enterprise Edition)中一种重要的组件,通常用于增强Web应用程序的功能和性能。

以下是一些关键的特点和用途:

  1. 生命周期: 过滤器具有生命周期,包括初始化、处理请求和销毁。这使得可以在不同的阶段执行特定的任务。

  2. 处理顺序: 多个过滤器可以按照配置的顺序依次处理请求。这样可以形成一个过滤器链,每个过滤器执行特定的操作。

  3. 过滤器链: 过滤器可以链接在一起,形成一个过滤器链。每个过滤器在请求被发送到目标资源之前或响应返回给客户端之前执行。

  4. 修改请求和响应: 过滤器可以修改请求的参数、请求头,以及响应的内容。这使得可以在不修改目标资源的情况下对请求和响应进行处理。

  5. 身份验证和授权: 过滤器可以用于身份验证和授权,以确保只有经过身份验证的用户能够访问特定的资源。

  6. 日志记录: 过滤器可以用于记录请求和响应的信息,帮助开发人员调试和监控应用程序的运行状况。

在Java中,过滤器通过实现javax.servlet.Filter接口来创建。它需要实现三个主要方法:init(初始化),doFilter(处理请求和响应),destroy(销毁)。通过配置在web.xml文件中指定过滤器的名称、类名和执行顺序,将过滤器与特定的URL模式或Servlet关联起来。

public class MyFilter implements Filter {
    public void init(FilterConfig config) throws ServletException {
        // 初始化代码
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 过滤逻辑

        // 继续执行过滤器链
        chain.doFilter(request, response);

        // 过滤后逻辑
    }

    public void destroy() {
        // 销毁代码
    }
}

过滤器(Filter)和切面(AOP)之间的区别

过滤器(Filter),拦截器(Interceptor),和切面(Aspect)是在软件开发中用于处理横切关注点(Cross-cutting Concerns)的不同机制。它们在实现上有一些关键的区别:

1. 使用场景和关注点的范围:

  • 过滤器: 主要用于对HTTP请求和响应进行预处理和后处理,通常在Web应用程序中工作。关注点通常涉及到与HTTP通信相关的任务,例如身份验证、日志记录、编码转换等。
  • 拦截器: 与过滤器类似,但更通用,可以用于拦截和处理方法调用。在Java中,拦截器通常与框架(如Spring)一起使用,用于处理方法调用的前后逻辑,如事务管理、权限验证等。
  • 切面: AOP的切面是更为通用的概念,可以用于处理系统中的各种关注点,不仅限于HTTP请求和方法调用。切面的关注点范围更广泛,可以包括任何跨足整个应用程序的关注点,如日志记录、性能监控、事务管理等。

2. 实现方式:

  • 过滤器: 在Java中,过滤器通过实现javax.servlet.Filter接口来创建,通常与Servlet容器紧密关联。
  • 拦截器: 拦截器通常是在框架层面实现的,例如在Spring框架中,可以使用HandlerInterceptor接口来定义拦截器。
  • 切面: AOP的切面是通过面向切面编程(AOP)的方式实现的,通常使用框架如Spring AOP。切面通过定义切点(Pointcut)和通知(Advice)来处理关注点。

3. 定位和触发时机:

  • 过滤器: 过滤器通常通过URL模式或Servlet的映射来定位,并在HTTP请求和响应的处理过程中触发。
  • 拦截器: 拦截器可以在方法调用前后触发,在框架中配置了拦截器后,它们会拦截方法的执行。
  • 切面: 切面通过切点定位关注点的位置,并在满足切点条件时触发通知,这通常发生在方法调用前后、异常抛出时等时机。

4. 耦合性:

  • 过滤器: 过滤器与Servlet容器紧密关联,有一定的耦合性,因为它们主要用于处理HTTP请求和响应。
  • 拦截器: 拦截器通常在框架中使用,具有一定的耦合性,但相对于过滤器,它们更灵活,可以应用于更广泛的场景。
  • 切面: AOP的设计目标是减少代码的耦合性,切面的应用使得关注点的处理更为灵活和可维护。

5. 适用范围:

  • 过滤器: 主要用于Web应用程序中处理HTTP请求和响应。
  • 拦截器: 主要用于框架中,处理方法调用前后的逻辑。
  • 切面: 更为通用,可以用于处理系统中各种关注点,不限于HTTP请求和方法调用。

在实际应用中,通常会根据具体需求和场景来选择使用过滤器、拦截器或切面,或者将它们结合使用以实现更灵活、可维护的代码。

过滤器(Filter)的使用

一个常见的编码处理过滤器是用于字符编码的处理,特别是在Web应用程序中。这种过滤器通常用于确保请求和响应的数据以正确的字符编码进行处理。以下是一个简单的Java过滤器示例,用于处理字符编码:

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import java.io.IOException;

public class EncodingFilter implements Filter {
    private String encoding;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 从web.xml配置中获取字符编码参数
        encoding = filterConfig.getInitParameter("encoding");

        // 如果未配置编码,默认使用UTF-8
        if (encoding == null || encoding.isEmpty()) {
            encoding = "UTF-8";
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 设置请求和响应的字符编码
        request.setCharacterEncoding(encoding);
        response.setCharacterEncoding(encoding);

        // 继续执行过滤器链
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        // 过滤器销毁时的清理工作
    }
}

在上述例子中,过滤器的作用是在处理请求时将请求和响应的字符编码都设置为指定的编码。它在doFilter方法中设置了请求和响应的字符编码,然后继续执行过滤器链。在init方法中,从FilterConfig中获取了初始化参数,允许在web.xml中配置字符编码。如果没有配置,则默认使用UTF-8。

要在web.xml中配置这个过滤器,可以像下面这样做:

<filter>
    <filter-name>EncodingFilter</filter-name>
    <filter-class>com.example.EncodingFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
</filter>
<filter-mapping>
    <filter-name>EncodingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

这样,所有进入应用程序的请求都会通过这个过滤器,并在请求和响应中设置正确的字符编码。

除了在web.xml中配置过滤器,还可以使用注解(Annotation)的方式在Servlet 3.0+环境中配置过滤器。在Servlet 3.0及以上版本中,可以使用@WebFilter注解来替代在web.xml中的配置。

以下是将字符编码过滤器改为使用注解配置的示例:

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import java.io.IOException;

@WebFilter(
    filterName = "EncodingFilter",
    urlPatterns = {"/*"},
    initParams = {
        @WebInitParam(name = "encoding", value = "UTF-8")
    }
)
public class EncodingFilter implements Filter {
    private String encoding;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 从注解中获取字符编码参数
        encoding = filterConfig.getInitParameter("encoding");

        // 如果未配置编码,默认使用UTF-8
        if (encoding == null || encoding.isEmpty()) {
            encoding = "UTF-8";
        }
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 设置请求和响应的字符编码
        request.setCharacterEncoding(encoding);
        response.setCharacterEncoding(encoding);

        // 继续执行过滤器链
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
        // 过滤器销毁时的清理工作
    }
}

在上述例子中,使用了@WebFilter注解来替代web.xml中的配置。urlPatterns属性用于指定过滤器拦截的URL模式,initParams属性用于设置初始化参数,即字符编码。

转载自:https://juejin.cn/post/7339364757386215460
评论
请登录