Springboot中使用Filter实现Header认证详解

 更新时间:2023年08月12日 10:05:38   作者:牛奋lch  
这篇文章主要介绍了Springboot中使用Filter实现Header认证详解,当在 web.xml 注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时,它可以决定是否将请求继续传递给 Servlet 程序,以及对请求和响应消息是否进行修改,需要的朋友可以参考下

前言

假设客户端在http请求中,已经加入了Header的认证信息,例如:

HttpPost post = new HttpPost("http://localhost:8990/sendMail");
				StringEntity entity = new StringEntity(json, "utf-8");
				entity.setContentType("application/json");
				post.setEntity(entity);
				// 设置验证头信息
				post.addHeader("token", "WEFGYHJIKLTY4RE6DF29HNBCFD13ER87");

那么服务端怎么通过Filter,来验证客户端的token是否有效了?请接着往下看。

一、实现自定义Filter

1、实现Filter接口

我们要自定义Filter,只需实现Filter接口即可

2、覆写doFilter方法

根据业务逻辑,来覆写doFilter方法

示例如下:

@Slf4j
@Component
@WebFilter(urlPatterns={"/sendMail/*"}, filterName="tokenAuthorFilter")
public class TokenAuthorFilter implements Filter {
	@Autowired
	private AuthorizationRepository repository;
	@Override
	public void destroy() {
	}
	@Override
	public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
			throws IOException, ServletException {
		HttpServletRequest req = (HttpServletRequest)request;
		response.setCharacterEncoding("UTF-8");
		response.setContentType("application/json; charset=utf-8");
		String token = req.getHeader("token");
		Response res = new Response();
		boolean isFilter = false;
		if (null == token || token.isEmpty()) {
			res.setSuccess(false);
			res.setErrorCode("403");
			res.setErrorMessage("token没有认证通过!原因为:客户端请求参数中无token信息");
		} else {
			Authorization auth = repository.findByToken(token);
			if (null == auth) {
				res.setSuccess(false);
				res.setErrorCode("403");
				res.setErrorMessage("token没有认证通过!原因为:客户端请求中认证的token信息无效,请查看申请流程中的正确token信息");
			}else if((auth.getStatus() == 0)){
				res.setSuccess(false);
				res.setErrorCode("401");
				res.setErrorMessage("该token目前已处于停用状态,请联系邮件系统管理员确认!");
			}else{
				isFilter = true;
				res.setSuccess(true);
			}
		}
		if(!res.isSuccess()){
			PrintWriter writer = null;
			OutputStreamWriter osw = null;
			try {
				osw = new OutputStreamWriter(response.getOutputStream() , "UTF-8");
				writer = new PrintWriter(osw, true);
				String jsonStr = ObjectMapperInstance.getInstance().writeValueAsString(res);
				writer.write(jsonStr);
				writer.flush();
				writer.close();
				osw.close();
			} catch (UnsupportedEncodingException e) {
				log.error("过滤器返回信息失败:" + e.getMessage(), e);
			} catch (IOException e) {
				log.error("过滤器返回信息失败:" + e.getMessage(), e);
			} finally {
				if (null != writer) {
					writer.close();
				}
				if(null != osw){
					osw.close();
				}
			}
			return;
		}
		if(isFilter){
			log.info("token filter过滤ok!");
			chain.doFilter(request, response);
		}
	}
	@Override
	public void init(FilterConfig arg0) throws ServletException {
	}
}

通过上面的几步,就实现了一个自定义的Filter。

3、注册Filter

接下来,需要注册这个过滤器,spring boot提供了以下两种注册方式。

3.1 是用注解注册

在Filter上添加如下注解即可

@Slf4j
@Component
@WebFilter(urlPatterns={"/sendMail/*"}, filterName="tokenAuthorFilter")
public class TokenAuthorFilter implements Filter {

@WebFilter注解的作用就是用来注册Filter,通过这种方式注册的Filter,需要在启动类上加上@ServletComponentScan注解才能生效,如下:

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

3.2 手动配置Filter

@Configuration
@Component
public class FilterConfig {
	@Autowired
	private TokenAuthorFilter filter;
	@Bean
    public FilterRegistrationBean  filterRegistrationBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        registrationBean.setFilter(filter);
        List<String> urlPatterns = new ArrayList<String>();
        urlPatterns.add("/sendMail/*");// 设置匹配的url
        registrationBean.setUrlPatterns(urlPatterns);
        return registrationBean;
    }
}

上面两种方式虽然使用上有些不一样,但是本质都是一样的,都会调用FilterRegistrationBean来进行注册。

二、spring boot内置的Filter

为了方便我们的开发,spring boot内置了许多有用的Filter,我们可以根据业务的需求,选择适合业务的Filter。

三、拓展

通过前面的N篇博客,我们会发现spring boot处理Servlet,Listener,Filter的思路大致都是一样

对应的注解分别为@WebServlet 、@WebListener、@WebFilter

对应的注册Bean分别为ServletRegistrationBean,ServletListenerRegistrationBean,FilterRegistrationBean

无论哪种方式,都大大的简化了我们的开发

到此这篇关于Springboot中使用Filter实现Header认证详解的文章就介绍到这了,更多相关Filter实现Header认证内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • SpringMVC存取Session的两种方法

    SpringMVC存取Session的两种方法

    Spring MVC是个非常优秀的框架,本篇文章主要介绍了SpringMVC存取Session的两种方法,具有一定的参考价值,有兴趣的可以了解一下。
    2017-01-01
  • spring boot搭建文件服务器解决同时上传多个图片和下载的问题

    spring boot搭建文件服务器解决同时上传多个图片和下载的问题

    这篇文章主要介绍了spring boot搭建文件服务器解决同时上传多个图片和下载的问题,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-11-11
  • SpringBoot动态定时任务实现与应用详解

    SpringBoot动态定时任务实现与应用详解

    定时任务在许多应用场景中是必不可少的,特别是在自动化任务执行、定期数据处理等方面,定时任务能极大地提高系统的效率,然而,随着业务需求的变化,定时任务的执行频率或时间点可能需要动态调整,所以本文给大家介绍了SpringBoot动态定时任务实现与应用
    2024-08-08
  • SpringBoot3.2.2整合MyBatis-Plus3.5.5依赖不兼容的问题解决

    SpringBoot3.2.2整合MyBatis-Plus3.5.5依赖不兼容的问题解决

    这篇文章给大家介绍了Spring Boot 3.2.2整合MyBatis-Plus 3.5.5依赖不兼容问题,文中通过代码示例和图文介绍的非常详细,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
    2024-01-01
  • 解决springboot的findOne方法没有合适的参数使用问题

    解决springboot的findOne方法没有合适的参数使用问题

    这篇文章主要介绍了解决springboot的findOne方法没有合适的参数使用问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • SpringBoot整合Aop全过程

    SpringBoot整合Aop全过程

    AOP(面向切面编程)技术可以高效地解决日志记录、事务管理、权限控制等问题,日志记录通过自定义注解和切面类,自动记录方法调用详情,减少重复代码,事务管理方面,通过AOP可以在不改变业务代码的情况下,实现事务的自动开启、提交和回滚,保证数据一致性
    2024-10-10
  • Mybatis Web中的数据库操作方法举例详解

    Mybatis Web中的数据库操作方法举例详解

    Mybatis是一款优秀的持久化框架,用于简化JDBC的开发,下面这篇文章主要给大家介绍了关于Mybatis Web中数据库操作方法的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-09-09
  • Spring细数两种代理模式之静态代理和动态代理概念及使用

    Spring细数两种代理模式之静态代理和动态代理概念及使用

    代理是一种设计模式,提供了对目标对象另外的访问方式,即通过代理对象访问目标对象。可以不修改目标对象,对目标对象功能进行拓展。在我们学习Spring的时候就会发现,AOP(面向切面编程)的底层就是代理
    2023-02-02
  • springboot项目配置logback-spring.xml实现按日期归档日志的方法

    springboot项目配置logback-spring.xml实现按日期归档日志的方法

    本文主要介绍了springboot项目配置logback-spring.xml实现按日期归档日志的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-08-08
  • springBoot发布https服务及调用的过程详解

    springBoot发布https服务及调用的过程详解

    文章介绍了如何在Spring Boot中配置HTTPS服务,包括生成自签名证书和配置SSL证书的位置和密码,此外,还讨论了如何在Docker容器中启动HTTPS服务,以及如何通过HTTP请求调用HTTPS服务并跳过证书校验,感兴趣的朋友跟随小编一起看看吧
    2025-11-11

最新评论