@Compont与@WebFilter问题

Question

我的springboot项目正常使用

此时我想注册Filter,我发现我需要同时使用@Component和@WebFilter, 请求才会被这个过滤器拦截

@Component
@WebFilter(urlPatterns = "/*", filterName = "xssFilter")
public class XssFilter implements Filter {


    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
                         FilterChain filterChain) throws IOException, ServletException {
        filterChain.doFilter(servletRequest, servletResponse);
    }



    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

但是我发现网上的一些博客的springboot有些都是只写了@WebFilter,也可以注册成filter，有点不解

然后我又写了个普通的SSM项目,不用Springboot,发现加不加@Component都一样可以走用@WebFilter注解注册的过滤器

然后我又试了重新写Springboot的项目,但是跟之前不一样,我排除了Springboot内置的tomcat,使用外置tomcat运行

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

此时我同时加上@Component与@WebFilter, 发生报错

多次注册filter?

Failed to register 'filter xssFilter' on the servlet context. Possibly already registered?

然后此时我把@Component去掉,只是用@WebFilter,程序正常运行，而且请求也走了过滤器

我看了网上的很多帖子，都还是理解不了
求解惑

Answer 1

以下回复参考：皆我百晓生、券券喵儿等免费微信小程序作答:

这个问题的答案涉及到了Spring Framework的一些特性和细节。对于你所遇到的问题，我会尝试详细解释并给出答案。

首先，关于Spring Boot项目中为何需要同时使用@Component和@WebFilter注解的问题。在Spring Boot中，通过自动配置机制来配置Spring应用程序。如果你只是使用@WebFilter注解来注册过滤器，而没有通过Spring的组件扫描（通常由@ComponentScan注解或通过Spring Boot的自动配置机制实现）来发现这个过滤器，那么Spring可能无法自动管理这个过滤器实例，因此也就不会注册它。所以，当你同时使用@Component和@WebFilter注解时，Spring可以自动发现并管理这个过滤器实例，从而确保它能正常工作。这种方式下，你可以享受Spring带来的诸如依赖注入等特性。如果只使用@WebFilter而不使用@Component，你可能需要自己手动配置过滤器实例的创建和管理。

其次，关于在SSM项目中为何只使用@WebFilter就可以注册过滤器的问题。在传统的SSM项目中，你可能手动配置了Servlet容器（如Tomcat），并且使用了Spring的Servlet容器集成特性。在这种情况下，你可以直接使用Servlet的规范来注册和管理过滤器，而不需要通过Spring来管理。因此，即使不使用@Component注解，你的过滤器也能正常工作。这是因为你的过滤器实例是由Servlet容器管理的，而不是由Spring管理的。

最后，关于你在使用外置Tomcat运行Spring Boot项目时遇到的问题。当你排除了Spring Boot内置的Tomcat并使用外置Tomcat运行时，过滤器的注册和配置方式会有所不同。如果你的过滤器实例是由Spring管理的（即通过@Component和@WebFilter注解），你可能会遇到冲突或错误的问题。因为在这种情况下，Spring和Tomcat可能都在尝试注册过滤器实例，导致报错提示说可能已经注册过这个过滤器了。为了解决这个问题，你可以尝试只使用Tomcat的方式来注册过滤器（不使用Spring的注解），或者确保你的过滤器的注册和管理是由Spring完全控制的（在这种情况下你需要同时使用@Component和@WebFilter注解）。请注意在使用这种方式时，确保你的项目中没有其他地方也在尝试注册这个过滤器实例。

总的来说，这个问题的关键在于如何正确地管理和注册你的过滤器实例。你需要根据你的项目配置和需求来选择最适合的方式来注册和管理你的过滤器实例。希望这个答案能帮助你理解这个问题并找到解决方案。