Spring Boot之FilterRegistrationBean-自定义Filter详解

 更新时间:2021年08月12日 09:38:55   作者:NPException  
这篇文章主要介绍了Spring Boot之FilterRegistrationBean-自定义Filter详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

Spring Boot之FilterRegistrationBean-自定义Filter

项目老的用spring写的,新的升级到了springboot,原代码中有在web.xml中定义过滤器,在boot中,自然没法这样用了,因而看了看boot如何使用自定义过滤器。

在springboot 中,主要是靠FilterRegistrationBean 这个类来提供这样的功能。

自定义 Filter

我们常常在项目中会使用 filters 用于录调用日志、排除有 XSS 威胁的字符、执行权限验证等等。Spring Boot 自动添加了 OrderedCharacterEncodingFilter 和 HiddenHttpMethodFilter,并且我们可以自定义 Filter。

两个步骤:

  • 1、实现 Filter 接口,实现 Filter 方法
  • 2、添加 @Configuration 注解,将自定义Filter加入过滤链

好吧,直接上代码

package com.zoo.lion.modules.test.test; 
import org.apache.catalina.filters.RemoteIpFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; 
import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
 
/**
 * @Author: xf
 * @Date: 2019/7/16 13:39
 * @Version 1.0
 */
@Configuration
public class WebConfiguration {
 
    @Bean
    public RemoteIpFilter remoteIpFilter() {
        return new RemoteIpFilter();
    }
 
    @Bean
    public FilterRegistrationBean<MyFilter> testFilterRegistration() {
        FilterRegistrationBean<MyFilter> registration = new FilterRegistrationBean<>();
        registration.setFilter(new MyFilter());
        //过滤应用程序中所有资源,当前应用程序根下的所有文件包括多级子目录下的所有文件,注意这里*前有“/”
        registration.addUrlPatterns("/*");
        //过滤指定的类型文件资源, 当前应用程序根目录下的所有html文件,注意:*.html前没有“/”,否则错误
        registration.addUrlPatterns(".html");
        //过滤指定的目录下的所有文件,当前应用程序根目录下的folder_name子目录(可以是多级子目录)下所有文件
        registration.addUrlPatterns("/folder_name/*");
        //过滤指定文件
        registration.addUrlPatterns("/index.html");
 
        registration.addInitParameter("paramName", "paramValue");
        registration.setName("MyFilter");
        registration.setOrder(1);
        return registration;
    } 
 
    public class MyFilter implements Filter { 
        @Override
        public void init(FilterConfig filterConfig) {
 
        }
 
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
            HttpServletRequest request2 = (HttpServletRequest) request;
            System.out.println(request2.getRequestURI());
            chain.doFilter(request, response);
        }
 
        @Override
        public void destroy() { 
        }
    }
}

SpringBoot FilterRegistrationBean对象支持web的filter的排序

1.FilterRegistrationBean对象可以实现对web Filter的排序,使用setOrder(int i)方法

具体代码如下:

package com.dbzhang;
/**
 * @author zdb
 * @description @Configuration和@Bean注解配置使用,就相当于在配置文件中配置bean的注解式用法
 */
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.http.HttpServletRequest;
import org.apache.catalina.filters.RemoteIpFilter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration
public class WebConfiguration {
	@Bean
	public RemoteIpFilter remoteIpFilter(){
		return new RemoteIpFilter();
	}
	/***
	 * 这个FilterRegistrationBean类可以使用setOrder()方法实现对filter的排序,然后在进行注册
	 * https://blog.csdn.net/doctor_who2004/article/details/56055505
	 */
	public FilterRegistrationBean testFilterRegistration(){
		FilterRegistrationBean registration = new FilterRegistrationBean();
		registration.setFilter(new MyFilter());
		registration.addUrlPatterns("/*");
		registration.addInitParameter("paramName", "paramValue");
		registration.setName("MyFilter");
		registration.setOrder(1);
		return registration;
	}
	/**
	 * 
	 * @author zdb
	 * @description 这个是用来实现Filter
	 *
	 */
	public class MyFilter implements Filter{ 
		@Override
		public void destroy() {			
		}
 
		@Override
		public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
				throws IOException, ServletException {
			HttpServletRequest request = (HttpServletRequest)servletRequest;
			System.out.println("this is MyFilter,url:"+request.getRequestURI());
			filterChain.doFilter(servletRequest, servletResponse);
		}
 
		@Override
		public void init(FilterConfig arg0) throws ServletException {			
		}		
	}
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java多线程实现聊天客户端和服务器

    Java多线程实现聊天客户端和服务器

    这篇文章主要为大家详细介绍了Java多线程聊天客户端和服务器实现代码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-10-10
  • SpringBoot Maven打包插件spring-boot-maven-plugin无法解析原因

    SpringBoot Maven打包插件spring-boot-maven-plugin无法解析原因

    spring-boot-maven-plugin是spring boot提供的maven打包插件,本文主要介绍了SpringBoot Maven打包插件spring-boot-maven-plugin无法解析原因,具有一定的参考价值,感兴趣的可以了解一下
    2024-03-03
  • 基于Java实现Redis多级缓存方案

    基于Java实现Redis多级缓存方案

    这篇文章主要介绍了Redis多级缓存方案分享,传统缓存方案、多级缓存方案、JVM本地缓存,举例说明这些方案,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-03-03
  • Java反射如何修改private final成员变量值

    Java反射如何修改private final成员变量值

    这篇文章主要介绍了Java反射如何修改private final成员变量值,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-07-07
  • hibernate 命名查询如何实现

    hibernate 命名查询如何实现

    Hibernate允许在映射文件中定义字符串形式的查询语句,这种查询方式成为命名查询,需要的朋友可以参考下
    2012-11-11
  • Java高级之虚拟机加载机制的实例讲解

    Java高级之虚拟机加载机制的实例讲解

    下面小编就为大家分享一篇Java高级之虚拟机加载机制的实例讲解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • SpringBoot3整合mybatis-plus的实现

    SpringBoot3整合mybatis-plus的实现

    MyBatis-Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,本文主要介绍了Mybatis-Plus3.x的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2023-10-10
  • Spring Security实现用户名密码登录详解

    Spring Security实现用户名密码登录详解

    这篇文章主要为大家详细介绍了Spring Security如何实现用户名密码登录功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起了解一下
    2022-10-10
  • 详解application.properties和application.yml文件的区别

    详解application.properties和application.yml文件的区别

    这篇文章主要介绍了详解application.properties和application.yml文件的区别,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • java去除数组重复元素的四种方法

    java去除数组重复元素的四种方法

    本文给大家分享四种java去除数组重复元素的方法,每种方法通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2021-11-11

最新评论