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认证内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java的SPI机制实例详解

    Java的SPI机制实例详解

    这篇文章主要介绍了Java的SPI机制实例详解的相关资料,需要的朋友可以参考下
    2017-06-06
  • java文件复制代码片断(java实现文件拷贝)

    java文件复制代码片断(java实现文件拷贝)

    本文介绍java实现文件拷贝的代码片断,大家可以直接放到程序里运行
    2014-01-01
  • 使用SpringBoot设置虚拟路径映射绝对路径

    使用SpringBoot设置虚拟路径映射绝对路径

    这篇文章主要介绍了使用SpringBoot设置虚拟路径映射绝对路径的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • SpringBoot项目中jar发布获取jar包所在目录路径的最佳方法

    SpringBoot项目中jar发布获取jar包所在目录路径的最佳方法

    在开发过程中,我们经常要遇到上传图片、word、pdf等功能,但是当我们把项目打包发布到服务器上时,对应的很多存储路径的方法就会失效,下面这篇文章主要给大家介绍了关于SpringBoot项目中jar发布获取jar包所在目录路径的相关资料
    2022-07-07
  • Spring实现Quartz自动配置的方法详解

    Spring实现Quartz自动配置的方法详解

    这篇文章主要介绍了Spring实现Quartz自动配置的方法详解,如果想在应用中使用Quartz任务调度功能,可以通过Spring Boot实现Quartz的自动配置,以下介绍如何开启Quartz自动配置,以及Quartz自动配置的实现过程,需要的朋友可以参考下
    2023-11-11
  • SpringBoot中实现定时任务的4种方式详解

    SpringBoot中实现定时任务的4种方式详解

    这篇文章主要介绍了SpringBoot中实现定时任务的4种方式详解,在Springboot中定时任务是一项经常能用到的功能,实现定时任务的方式有很多,今天来介绍常用的几种,需要的朋友可以参考下
    2023-11-11
  • web.xml详解_动力节点Java学院整理

    web.xml详解_动力节点Java学院整理

    这篇文章给大家详细介绍了web.xml的相关知识,需要的朋友可以参考下
    2017-07-07
  • MyBatis基础支持DataSource实现源码解析

    MyBatis基础支持DataSource实现源码解析

    这篇文章主要为大家介绍了MyBatis基础支持DataSource实现源码解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • SpringBoot项目接收前端参数的11种方式

    SpringBoot项目接收前端参数的11种方式

    在前后端项目交互中,前端传递的数据可以通过HTTP请求发送到后端, 后端在Spring Boot中如何接收各种复杂的前端数据呢?这篇文章总结了11种在Spring Boot中接收前端数据的方式,需要的朋友可以参考下
    2024-12-12
  • IDEA多线程文件下载插件开发的步骤详解

    IDEA多线程文件下载插件开发的步骤详解

    这篇文章主要介绍了IDEA多线程文件下载插件开发的步骤详解,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12

最新评论