SpringBoot一步配置Filter

愈知愈知不知：你知道的越多，你不知道的越多。

引言

关于如何搭建SpringBoot工程以及开启Web功能，可以查看我的这篇博客：
用Spring Initializr快速构建SpringBoot及整合MVC

关于Filter

Filter：过滤器，属于Servlet规范中三个技术之一，本质是一种特殊Java类，可以拦截访问Web资源的请求与响应等操作，实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

在使用servlet的时候，我们实现过滤器Filter可能需要三步：
1.声明一个类实现javax.servlet.Filter接口。
2.重写doFilter()方法。
3.配置web项目中的web.xml文件以注册过滤器，其中过滤器的注册顺序决定了过滤器在过滤器链中的执行顺序，如：

 <!-- 注册过滤器 -->
  <filter>
  	<!-- 过滤器注册名,自定义 -->
  	<filter-name>MyFilter</filter-name>
  	<!-- 过滤器全限定类名 -->
  	<filter-class>com.guqueyeu.filter.MyFilter</filter-class>
  </filter>
  <!-- 配置过滤器的过滤路径 -->
  <filter-mapping>
  	<!-- 过滤器注册名 -->
  	<filter-name>EncodingFilter</filter-name>
  	<!-- 设置过滤请求路径 -->
  	<url-pattern>/*</url-pattern>
  </filter-mapping>

SpringBoot配置Filter

我们利用Java匿名内部类的特性，直接在SpringBoot启动类中添加一个方法即可完成对Filter的配置：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;

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

@SpringBootApplication(scanBasePackages = "com.guqueyue")
public class HelloGuqueyueApplication {

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

    @Bean // 将方法的返回值对象放入Spring容器中
    public FilterRegistrationBean getFilter(){
        /**
         * 无须配置web.xml文件，直接配置filter
         */
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        // 设置过滤器注册名，自定义
        filterRegistrationBean.setName("MyFilter");
        filterRegistrationBean.setFilter(new Filter() {
            // 内部类，重写doFilter()方法
            @Override
            public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
                System.out.println("过滤前：Hello准备中...");
                // 放行
                filterChain.doFilter(servletRequest, servletResponse);
                System.out.println("过滤后: Hello释放完毕!");
            }
        });
        // 设置过滤器的请求路径
        filterRegistrationBean.addUrlPatterns("/*");

        return filterRegistrationBean;
    }
}

Web层的controller代码为：

/**
 * @author guqueyue
 * @Date 2020/4/10
 **/
@RestController
public class HelloController {

    @RequestMapping("/hello")
    public String hello() {
        System.out.println("Hello！！！");
        return "Hello, guqueyue！";
    }

}

运行启动类的main方法，打开浏览器输入"http://localhost:8080/hello"，控制台打印如下：

配置完成！其中8080为SpringBoot的默认访问端口，若要改变访问端口，请自行到配置文件application.yml中配置，如我想将端口改为"10086"：

server:
  port: 10086