springboot整合filter

如何在SpringBoot当中去整合Filter,SpringBoot在整合Filter时,其实和整合Servlet差不多,提供了两种

方案,一种还是通过注解扫描,完成Filter的注册,第二种方式呢,通过方法完成Filter组件的注册,我们先来

看第一种,通过注解扫描完成Filter的注册,首先我们要创建SpringBoot的项目,我们先去编写一个Filter,

需要实现一个Filter接口,以往我们编写Filter的时候,如何对他做配置,首先这个需要有一个Filter节点,

然后在filter节点当中,有一个filter-name,还有一个filter-class,然后还有一个filter-mapping,然后在filter-mapping

当中,也需要一个filter-name,还有url-pattern,比如我们让他去拦截一个servlet,这是我们原来通过web.xml,

给Filter做的一些配置,现在我们不需要对web.xml做什么配置,同样还是一个Annotation,这个叫@WebFilter,

在这里同样有一个filterName,然后还有一个urlPatterns,那么filterName对应的就是我们的FirstFilter，

urlPatterns这一块,我们以往在做Filter开发的时候,可能Filter要做多个请求,那我们怎么办呢,我们也知道urlpatterns这一块,

其实他是一个数组类型,既然是数组类型,我要让他拦截*.do,或者是*.jsp,这是可以的,现在我们只让他拦截servlet

的url,我们就不用配这么多了,这样我们的Servlet就编写完毕了,然后我们在doFilter里面加点内容

@Override
public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
		throws IOException, ServletException {
	System.out.println("进入Filter");
	arg2.doFilter(arg0, arg1);
	System.out.println("离开Filter");
}

这样我们就把Filter编写好了,这个Servlet我们已经有了,然后我们写一个启动类,其实这个启动类呢,和我们Servlet

的启动类是一样的

@SpringBootApplication
@ServletComponentScan 
public class App {

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

在这里要添加一个@SpringBootApplication,然后再加一个@ServletComponentScan,用的还是@ServletComponentScan,

这样我们的启动类就写好了,下面我们运行一下,看一下filter是否可以工作,启动没有问题,接下来我们来访问/first

localhost:8080/first

这个时候filter已经执行了,然后firstServlet也执行了,filter离开的时候也执行了,filter的拦截是生效的,

以上就是通过注解扫描的方式来实现,接下来我们再来看第二种方式,通过方法来完成Filter组件的注册,在这里也是不需要

添加Annotation的,因为它是需要方法来注册的,

@Override
public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
		throws IOException, ServletException {
	System.out.println("进入SecondFilter");
	arg2.doFilter(arg0, arg1);
	System.out.println("离开SecondFilter");
}

这样我们的Filter就写完了,我们去编写一个新的启动类,在这里也不需要加Annotation,我们先把Servlet的注册方法

拷贝过来,接下来我们要一个注册Filter的方法,这个方法需要返回一个对象,这个对象叫FilterRegistrationBean,

同样方法名叫什么都可以,然后我们去创建这个对象,这里我们要讲Filter实例化出来,然后添加URL,他这里叫addUrlPatterns,

在这里可以看到其实这个参数是可变参数,如果是可变参数,我们可以去创建一个String的数组,然后在数组里给定一个URL,

拦截*.do,或者是*.jsp,但是我们现在并不是让他拦截这些,拦截Servlet就可以,拦截这个/second

@Bean
public FilterRegistrationBean getFilterRegistrationBean(){
	FilterRegistrationBean bean = new FilterRegistrationBean(new SecondFilter());
	//bean.addUrlPatterns(new String[]{"*.do","*.jsp"});
	bean.addUrlPatterns("/second");
	return bean;
}

最后要在方法上加一个@Bean的注解,这个方法我们就写完了

localhost:8080/second

<project xmlns="http://maven.apache.org/POM/4.0.0" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
	http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.learn</groupId>
  <artifactId>03-spring-boot-filter</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.5.12.RELEASE</version>
  </parent>
  
	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>
  
  <dependencies>
  <!-- springBoot的启动器 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
</project>

package com.learn.servlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *SpringBoot整合Servlet方式一
 *
 *<servlet>
 *	<servlet-name>FirstServlet</servlet-name>
 *	<servlet-class>com.learn.servlet.FirstServlet</servlet-class>
 *</servlet>
 *
 *<servlet-mapping>
 * <servlet-name>FirstServlet</servlet-name>
 * <url-pattern>/first</url-pattern>
 *</servlet-mapping>
 *
 */
@WebServlet(name="FirstServlet",urlPatterns="/first")
public class FirstServlet extends HttpServlet {

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
		System.out.println("FirstServlet............");
	}
}

package com.learn.filter;

import java.io.IOException;

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 javax.servlet.annotation.WebFilter;

/**
 *SpringBoot整合Filter 方式一
 *<filter>
 *	<filter-name>FirstFilter</filter-name>
 *	<filter-class>com.learn.filter.FirstFilter</filter-class>
 *</filter>
 *<filter-mapping>
 *	<filter-name>FirstFilter</filter-name>
 *	<url-pattern>/first</url-pattern>
 *</filter-mapping>
 */
//@WebFilter(filterName="FirstFilter",urlPatterns={"*.do","*.jsp"})
@WebFilter(filterName="FirstFilter",urlPatterns="/first")
public class FirstFilter implements Filter {

	@Override
	public void destroy() {
		// TODO Auto-generated method stub

	}
	@Override
	public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
			throws IOException, ServletException {
		System.out.println("进入Filter");
		arg2.doFilter(arg0, arg1);
		System.out.println("离开Filter");
	}

	@Override
	public void init(FilterConfig arg0) throws ServletException {
		// TODO Auto-generated method stub
	}
}

package com.learn;

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

@SpringBootApplication
@ServletComponentScan 
public class App {

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

package com.learn.servlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 *SpringBoot整合Servlet方式二
 *
 */
public class SecondServlet extends HttpServlet {

	@Override
	protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
		System.out.println("SecondServlet..........");
	}
	
}

package com.learn.filter;

import java.io.IOException;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

/**
 *SpringBoot整合Filter 方式二
 */
public class SecondFilter implements Filter {
	@Override
	public void destroy() {
		
	}
	@Override
	public void doFilter(ServletRequest arg0, ServletResponse arg1, FilterChain arg2)
			throws IOException, ServletException {
		System.out.println("进入SecondFilter");
		arg2.doFilter(arg0, arg1);
		System.out.println("离开SecondFilter");
	}

	@Override
	public void init(FilterConfig arg0) throws ServletException {
		
	}
}

package com.learn;

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

import com.learn.filter.SecondFilter;
import com.learn.servlet.SecondServlet;

/**
 * SpringBoot整合Filter方式二
 */
@SpringBootApplication
public class App2 {

	public static void main(String[] args) {
		SpringApplication.run(App2.class, args);
	}
	
	/**
	 * 注册Servlet
	 * @return
	 */
	@Bean
	public ServletRegistrationBean getServletRegistrationBean(){
		ServletRegistrationBean bean = new ServletRegistrationBean(new SecondServlet());
		bean.addUrlMappings("/second");
		return bean;
	}
	
	/**
	 * 注册Filter
	 */
	@Bean
	public FilterRegistrationBean getFilterRegistrationBean(){
		FilterRegistrationBean bean = new FilterRegistrationBean(new SecondFilter());
		//bean.addUrlPatterns(new String[]{"*.do","*.jsp"});
		bean.addUrlPatterns("/second");
		return bean;
	}
}