教你用Springboot实现拦截器获取header内容

 更新时间:2021年05月21日 16:34:12   作者:盐城吊霸天  
项目中遇到一个需求,对接上游系统是涉及到需要增加请求头,请求头的信息是动态获取的,需要动态从下游拿到之后转给上游,文中非常详细的介绍了该需求的实现,需要的朋友可以参考下

分析

既然需要动态获取那么只有两种方式:要么每次下游请求过来时从请求头中获取,要么定义统一的拦截器自动获取。

实现

那么我们就先来实现一下吧。

第一种比较简单,直接使用springboot获取请求头的方式,从controller方法入口处使用: @RequestHeader(value = "xxxx",required = false) String appUser的方式获取请求头

代码如下:

@RequestMapping(name = "获取用户详情信息",value = "/getUserDetail",method=GET)
 
public String getUserDetail(@RequestHeader(value = "app-user",required = false) String appUser, @RequestParam(name = "search") String search){       
 
    log.info("------>拿到的请求头是:"+appUser);    
 
    return "SUCCESS";
 
}

此种方法虽然可以获取,但是太过low b,而且如果有几十个接口那么都要这么写,过于累赘

还是使用拦截器的方式吧

具体如下:

首先,定义一个拦截器,需要实现HandlerInterceptor,其中包含preHandler以及afterCompletion分别对应调用前以及调用完成后

package com.xxxx.cc.admin.interceptor;
 
 
 
 
 
import com.alibaba.fastjson.JSONObject;
 
import com.ddmc.cc.admin.support.ThreadLocalUtils;
 
import lombok.extern.slf4j.Slf4j;
 
import org.apache.commons.lang.StringUtils;
 
import org.springframework.stereotype.Component;
 
import org.springframework.web.servlet.HandlerInterceptor;
 
 
 
import javax.servlet.http.HttpServletRequest;
 
import javax.servlet.http.HttpServletResponse;
 
 
 
/**
* Copyright (C), 2017-2021 
* Author: sjugg
* Date: 2021/5/19 10:39
* FileName: AuthInterceptor
* Description: 交易前置拦截器
*/
 
@Component
 
@Slf4j
 
public class AuthInfoInterceptor implements HandlerInterceptor {
 
 
 
    @Override
 
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
 
        String userInfo = request.getHeader("app-user");
 
        log.info(">>>>>>>拦截到api相关请求头<<<<<<<<"+userInfo);
 
        if(StringUtils.isNotEmpty(userInfo)){
 
            //直接搂下来,放到ThreadLocal中 后续直接从中获取
 
           ThreadLocalUtils.set(MaiCaiApiConstants.MAI_CAI_APP_USER,userInfo);
 
        }
 
        return true;//注意 这里必须是true否则请求将就此终止。
 
    }
 
 
    @Override
 
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
 
        //移除app-user
 
        ThreadLocalUtils.remove("app-user");
 
        log.info("移除请求头中的app-user:"+ThreadLocalUtils.get("app-user"));
 
    }
 
}

后面只要从ThreadLocal中按key去拿就可以了。

另外需要做的是

添加web过滤器

1、添加web 过滤器,管理过滤的类,以及过滤的请求路径

2、继承WebMvcConfigurationSupport 类 和上面一样Generate,复写父类的方法 addInterceptors

3、通过registry.addInterceptor拦截类,addPathPatterns拦截路径,excludePathPatterns添加允许路径

这里我拦截的是以xxxx开头的请求。

package com.ddmc.cc.admin.config;
 
 
import com.ddmc.cc.admin.interceptor.AuthInfoInterceptor;
 
import org.springframework.beans.factory.annotation.Autowired;
 
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
 
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
 
 
/**
* 
*
* @author sjugg
* @since 2021/5/13 4:43 下午
*/
 
@Configuration
 
public class WebConfig implements WebMvcConfigurer {
 
 
    @Autowired
 
    private AuthInfoInterceptor authInfoInterceptor;
 
 
    @Override
 
    public void addInterceptors(InterceptorRegistry registry) {
 
        registry.addInterceptor(authInfoInterceptor).addPathPatterns("/xxxx/*");
 
    }
 
}

执行效果如下

请求头里设置app-user信息

 

可以看到Controller中已经拿到请求头里的信息

获取head的代码:

@RequestMapping(name = "获取用户详情信息",value = "/getUserDetail",method=GET)
 
public String getUserDetail(@RequestParam(name = "search") String search){
 
    log.info("-----> heard info here: "+ThreadLocalUtils.get("app-user"));
 
    return "SUCCESS";
}

方法执行完之后对应的threadlocal变量也被清除

 

到此这篇关于教你用Springboot实现拦截器获取header内容的文章就介绍到这了,更多相关Springboot获取header内容内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java结束线程的三种方法及该如何选择

    Java结束线程的三种方法及该如何选择

    这篇文章主要介绍了Java结束线程的三种方法及该如何选择,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-03-03
  • Java 获取泛型的类型实例详解

    Java 获取泛型的类型实例详解

    这篇文章主要介绍了Java 获取泛型的类型实现代码的相关资料,需要的朋友可以参考下
    2017-05-05
  • lombok 子类中如何使用@Builder问题

    lombok 子类中如何使用@Builder问题

    这篇文章主要介绍了lombok 子类中如何使用@Builder问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-09-09
  • springboot中的starter及自定义方法详解

    springboot中的starter及自定义方法详解

    这篇文章主要介绍了springboot中的starter及自定义方法详解,Starter是Spring Boot中的一个非常重要的概念,Starter相当于模块,它能将模块所需的依赖整合起来并对模块内的Bean根据环境(条件)进行自动配置,需要的朋友可以参考下
    2023-11-11
  • java中FileOutputStream中文乱码问题解决办法

    java中FileOutputStream中文乱码问题解决办法

    这篇文章主要介绍了java中FileOutputStream中文乱码问题解决办法的相关资料,需要的朋友可以参考下
    2017-04-04
  • Java多线程基本概念以及避坑指南

    Java多线程基本概念以及避坑指南

    多线程之于进程的理解,可以类比多进程之于操作系统,多线程指在单个程序中可以同时运行多个不同的线程执行不同的任务,这篇文章主要给大家介绍了关于Java多线程基本概念以及避坑指南的相关资料,需要的朋友可以参考下
    2021-09-09
  • Java详细介绍单例模式的应用

    Java详细介绍单例模式的应用

    单例模式(Singleton Pattern)是 Java 中最简单的设计模式之一。这种类型的设计模式属于创建型模式,它提供了一种创建对象的最佳方式
    2022-09-09
  • java实现哈夫曼压缩的实例

    java实现哈夫曼压缩的实例

    这篇文章主要介绍了java实现哈夫曼压缩的实例的相关资料,需要的朋友可以参考下
    2017-07-07
  • Java在PDF中添加表格过程详解

    Java在PDF中添加表格过程详解

    这篇文章主要介绍了Java在PDF中添加表格过程详解,本文将介绍通过Java编程在PDF文档中添加表格的方法。添加表格时,可设置表格边框、单元格对齐方式、单元格背景色、单元格合并、插入图片、设置行高、列宽、字体、字号等,需要的朋友可以参考下
    2019-07-07
  • 详细讲解Java中==与equals的区别对比

    详细讲解Java中==与equals的区别对比

    这篇文章主要为大家详细介绍了Java中==与equals的区别对比,文中有详细的代码示例供大家参考,具有一定的参考价值,感兴趣的同学可以参考阅读下
    2023-09-09

最新评论