Springboot 过滤器

Posted 2023-04-05

参考技术A 它是基于Servlet 技术实现的， 简单的来说，过滤器就是起到过滤的作用，在web项目开发中帮我们过滤一些指定的 url做一些特殊的处理。

过滤掉一些不需要的东西，例如一些错误的请求。
也可以修改请求和相应的内容。
也可以拿来过滤未登录用户。

过滤器(filter)有三个方法，其中初始化（init）和摧毁（destroy）方法一般不会用到，主要用到的是doFilter这个方法。

如果过滤通过，则在doFilter执行 filterChain.doFilter(request,response);

自定义Filter有两种实现方式，第一种是使用@WebFilter，第二种是使用 FilterRegistrationBean

@WebFilter 用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。

SpringBoot——SpringBoot中使用过滤器Filter的两种方式

1.方式一（使用注解）

首先，我们写一个Filter。要求就是简单的打印一句话。

在MyFilter这个类的上方使用 @WebFilter 注解来创建Filter即可。

package com.songzihao.springboot.filter;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

/**
 *
 */
@WebFilter(urlPatterns = "/myfilter")
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("======您已进入过滤器======");

        filterChain.doFilter(servletRequest,servletResponse);
    }
}

之后在SpringBoot项目的入口类上方使用注解 @ServletComponentScan 注解来扫描filter包中的注解即可。

package com.songzihao.springboot;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan(basePackages = "com.songzihao.springboot.filter")
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

最后启动测试。

---

2.方式二（定义配置类）

仍然是先写一个 Filter。这次不使用注解。 

package com.songzihao.springboot.filter;

import javax.servlet.*;
import java.io.IOException;

/**
 *
 */
public class MyFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("======您已进入过滤器======");

        filterChain.doFilter(servletRequest,servletResponse);
    }
}

之后写一个控制层controller。

package com.songzihao.springboot.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 *
 */
@Controller
public class UserController {

    @RequestMapping(value = "/user/detail")
    public @ResponseBody String userDetail() {
        return "/user/detail";
    }

    @RequestMapping(value = "/center")
    public @ResponseBody String center() {
        return "center";
    }
}

然后再写一个配置类！！！

package com.songzihao.springboot.config;

import com.songzihao.springboot.filter.MyFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 *
 */
@Configuration //定义此类为配置类
public class FilterConfig {

    @Bean
    public FilterRegistrationBean myFilterRegistrationBean() {
        //注册过滤器
        FilterRegistrationBean filterRegistrationBean=new FilterRegistrationBean(new MyFilter());
        //添加过滤路径
        filterRegistrationBean.addUrlPatterns("/user/*");
        return filterRegistrationBean;
    }
}

最后启动测试。