Spring Boot （四） 添加过滤器

1. 背景与结论

• 背景：web开发使用Controller基本能解决大部分的需求，但是有时候我们也需要使用Filter。现在就来简单的在SpringBoot中使用这些特殊类吧！
• 结论：在SpringBoot中使用Filter也有两种方式：注解注册Filter和代码注册。

2.实现与测试

2.1 注解方式

首先我们创建一个filter，我这里就举一个简单的例子，给每个请求统计一下处理时间

LogServiceFilter.java

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

@WebFilter(filterName="logServiceFilter" , urlPatterns = "/*")
public class LogServiceFilter implements Filter {

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

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        Long start = System.currentTimeMillis();
        System.out.println("requestUri:" + ((HttpServletRequest) servletRequest).getRequestURI());
        filterChain.doFilter(servletRequest , servletResponse);
        System.out.println("cost:" + ((System.currentTimeMillis() - start) / 1000));
    }

    @Override
    public void destroy() {

    }
}

然后我们在启动类上加入一个注解，扫描包

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

/**
 * @author Administrator
 */

@SpringBootApplication
@ServletComponentScan(basePackages={"cn.sweetz.exercise.springbootdemo.common.filter"})
public class SpringBootDemoApplication {

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

}

@ServletComponentScan 中的basePackages如果不写，默认与启动类是一样的

2.2 启动测试

启动项目，输入地址：http://localhost:8060/test/properties

看到打印的结果，说明这个filter是起作用了的，至此，通过注解的方式添加Filter就完成了。

2.3 代码注册

同样我们创建一个filter，我这里就与上面的保持一致，简单的做一下修改，注释掉原来的注解以做区分。

LogServiceFilter.java

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

//@WebFilter(filterName="logServiceFilter" , urlPatterns = "/*")
public class LogServiceFilter implements Filter {

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

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        Long start = System.currentTimeMillis();
        System.out.println("requestUri:" + ((HttpServletRequest) servletRequest).getRequestURI());
        filterChain.doFilter(servletRequest , servletResponse);
        System.out.println("cost:" + ((System.currentTimeMillis() - start) / 1000));
    }

    @Override
    public void destroy() {

    }
}

启动类上注掉原来加的注解

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

/**
 * @author Administrator
 */

@SpringBootApplication
//@ServletComponentScan(basePackages={"cn.sweetz.exercise.springbootdemo.common.filter"})
public class SpringBootDemoApplication {

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

}

重点来了，我们可以直接在启动类里面通过代码注册进去，也可以自己写一个配置类，来注册进去，这里采用第二种方式来实现，创建一个配置类：

import cn.sweetz.exercise.springbootdemo.common.filter.LogServiceFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

@Configuration
public class MyMvcWebConfig extends WebMvcConfigurationSupport {

    @Bean
    public FilterRegistrationBean setLogServiceFilter(){
        FilterRegistrationBean<LogServiceFilter> registrationBean = new FilterRegistrationBean<>();

        LogServiceFilter logServiceFilter = new LogServiceFilter();
        registrationBean.setFilter(logServiceFilter);
        registrationBean.setName("logServiceFilter");
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }

}

@Configuration 表示这是一个配置类
@Bean 会返回一个bean对象，类似于之前spring中的applicationContext.xml中的一个bean标签

2.4 启动测试

启动项目，输入地址：http://localhost:8060/test/properties，同样，我们也能看到更上面一样的效果