SpringBoot拦截器如何获取http请求参数

 更新时间:2020年09月10日 09:20:18   作者:上帝爱吃苹果-Soochow  
这篇文章主要给大家介绍了SpringBoot拦截器如何获取http请求参数的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

1.1、获取http请求参数是一种刚需

我想有的小伙伴肯定有过获取http请求的需要,比如想

  1. 前置获取参数,统计请求数据
  2. 做服务的接口签名校验
  3. 敏感接口监控日志
  4. 敏感接口防重复提交

等等各式各样的场景,这时你就需要获取 HTTP 请求的参数或者请求body,一般思路有两种,一种就是自定义个AOP去拦截目标方法,第二种就是使用拦截器。整体比较来说,使用拦截器更灵活些,因为每个接口的请求参数定义不同,使用AOP很难细粒度的获取到变量参数,本文主线是采用拦截器来获取HTTP请求。

1.2、定义拦截器获取请求

基于 spring-boot-starter-parent 2.1.9.RELEASE

看起来这个很简单,这里就直接上code,定义个拦截器

/**
 * @author axin
 * @summary HTTP请求拦截器
 */
@Slf4j
public class RequestInterceptor implements HandlerInterceptor {

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

    //获取请求参数
    String queryString = request.getQueryString();
    log.info("请求参数:{}", queryString);

    //获取请求body
    byte[] bodyBytes = StreamUtils.copyToByteArray(request.getInputStream());
    String body = new String(bodyBytes, request.getCharacterEncoding());

    log.info("请求体:{}", body);
    return true;
  }
}

然后把这个拦截器配置一下中:

/**
 * WebMVC配置,你可以集中在这里配置拦截器、过滤器、静态资源缓存等
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new RequestInterceptor()).addPathPatterns("/**");
  }
}

定义个接口测试一下

/**
 * @author axin
 * @summary 提交测试接口
 */
@Slf4j
@RestController
public class MyHTTPController {

  @GetMapping("/v1/get")
  public void get(@RequestParam("one") String one,
          @RequestParam("two") BigDecimal number) {
    log.info("参数:{},{}", one, number);
  }


  @PostMapping("/v1/post")
  public void check(@RequestBody User user) {

    log.info("{}", JSON.toJSONString(user));
  }
}

GET请求获取请求参数示例:

POST请求获取请求Body示例:

我们发现拦截器在获取HTTP请求的body时出现了 400 (Required request body is missing: public void com.axin.world.controller.MyHTTPController.check(com.axin.world.domain.User));同时也发现拦截器竟然走了两遍,这又是咋回事呢?

1.3、为什么拦截器会重复调两遍呢?

其实是因为 tomcat截取到异常后就转发到/error页面,就在这个转发的过程中导致了springmvc重新开始DispatcherServlet的整个流程,所以拦截器执行了两次,我们可以看下第二次调用时的url路径:

1.4、ServletInputStream(CoyoteInputStream) 输入流无法重复调用

而之前出现的 Required request body is missing 错误 其实是ServletInputStream被读取后无法第二次再读取了,所以我们要把读取过的内容存下来,然后需要的时候对外提供可被重复读取的ByteArrayInputStream。

对于MVC的过滤器来说,我们就需要重写 ServletInputStream 的 getInputStream()方法。

1.5、自定义 HttpServletRequestWrapper

为了 重写 ServletInputStream 的 getInputStream()方法,我们需要自定义一个 HttpServletRequestWrapper :

/**
* @author Axin
* @summary 自定义 HttpServletRequestWrapper 来包装输入流
*/
public class AxinHttpServletRequestWrapper extends HttpServletRequestWrapper {

  /**
   * 缓存下来的HTTP body
   */
  private byte[] body;

  public AxinHttpServletRequestWrapper(HttpServletRequest request) throws IOException {
    super(request);
    body = StreamUtils.copyToByteArray(request.getInputStream());
  }

  /**
   * 重新包装输入流
   * @return
   * @throws IOException
   */
  @Override
  public ServletInputStream getInputStream() throws IOException {
    InputStream bodyStream = new ByteArrayInputStream(body);
    return new ServletInputStream() {

      @Override
      public int read() throws IOException {
        return bodyStream.read();
      }

      /**
       * 下面的方法一般情况下不会被使用,如果你引入了一些需要使用ServletInputStream的外部组件,可以重点关注一下。
       * @return
       */
      @Override
      public boolean isFinished() {
        return false;
      }

      @Override
      public boolean isReady() {
        return true;
      }

      @Override
      public void setReadListener(ReadListener readListener) {

      }
    };
  }
  
  @Override
  public BufferedReader getReader() throws IOException {
    InputStream bodyStream = new ByteArrayInputStream(body);
    return new BufferedReader(new InputStreamReader(getInputStream()));
  }
}

然后定义一个 DispatcherServlet子类来分派 上面自定义的 AxinHttpServletRequestWrapper :

/**
* @author Axin
* @summary 自定义 DispatcherServlet 来分派 AxinHttpServletRequestWrapper
*/
public class AxinDispatcherServlet extends DispatcherServlet {

  /**
   * 包装成我们自定义的request
   * @param request
   * @param response
   * @throws Exception
   */
  @Override
  protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
    super.doDispatch(new AxinHttpServletRequestWrapper(request), response);
  }
}

然后配置一下:

/**
 * WebMVC配置,你可以集中在这里配置拦截器、过滤器、静态资源缓存等
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(new RequestInterceptor()).addPathPatterns("/**");
  }

  @Bean
  @Qualifier(DispatcherServletAutoConfiguration.DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
  public DispatcherServlet dispatcherServlet() {
    return new AxinDispatcherServlet();
  }
}

再调用一下 POST请求:

请求成功!

1.5、总结一下 展望一下

如果你想对HTTP请求做些骚操作,那么前置获取HTTP请求参数是前提,为此文本给出了使用MVC拦截器获取参数的样例。

在获取HTTP Body 的时候,出现了 Required request body is missing 的错误,同时拦截器还出现执行了两遍的问题,这是因为 ServletInputStream被读取了两遍导致的,tomcat截取到异常后就转发到 /error 页面 被拦截器拦截到了,拦截器也就执行了两遍。

为此我们通过自定义 HttpServletRequestWrapper 来包装一个可被重读读取的输入流,来达到期望的拦截效果。

在获取到HTTP的请求参数后,我们可以前置做很多操作,比如常用的服务端接口签名验证,敏感接口防重复请求等等。

个人水平有限,如果文章有逻辑错误或表述问题还请指出,欢迎一起交流。

到此这篇关于SpringBoot拦截器如何获取http请求参数的文章就介绍到这了,更多相关SpringBoot拦截器获取http请求参数内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 基于Java实现双向链表

    基于Java实现双向链表

    这篇文章主要为大家详细介绍了基于Java实现双向链表,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • 关于Java大整数运算之BigInteger类

    关于Java大整数运算之BigInteger类

    这篇文章主要介绍了关于Java大整数运算之BigInteger类,BigInteger提供高精度整型数据类型及相关操作,所有操作中,都以二进制补码形式表示,需要的朋友可以参考下
    2023-05-05
  • 解决cmd执行javac报错:不是内部或外部命令,也不是可运行的程序

    解决cmd执行javac报错:不是内部或外部命令,也不是可运行的程序

    刚接触JAVA的新手可能就不知道怎么解决'JAVAC'不是内部命令或外部命令,这篇文章主要给大家介绍了关于解决cmd执行javac报错:不是内部或外部命令,也不是可运行的程序的相关资料,需要的朋友可以参考下
    2023-11-11
  • Spring解决依赖版本不一致报错问题

    Spring解决依赖版本不一致报错问题

    许多同学经常会遇到依赖版本不一致导致代码报错,所以这篇文章就给大家详细介绍一下Spring解决依赖版本不一致报错问题,需要的朋友跟着小编一起来看看吧
    2023-07-07
  • SpringBoot接口返回结果封装方法实例详解

    SpringBoot接口返回结果封装方法实例详解

    在实际项目中,一般会把结果放在一个封装类中,封装类中包含http状态值,状态消息,以及实际的数据。这里主要记录两种方式,通过实例代码给大家介绍的非常详细,需要的朋友参考下吧
    2021-09-09
  • Java BOI与NIO超详细实例精讲

    Java BOI与NIO超详细实例精讲

    在Java的软件设计开发中,通信架构是不可避免的,我们在进行不同系统或者不同进程之间的数据交互,或者在高并发下的通信场景下都需要用到网络通信相关的技术,对于一些经验丰富的程序员来说,Java早期的网络通信架构存在一些缺陷,这篇文章介绍Java BOI与NIO
    2022-11-11
  • SpringMVC中@RequestMapping注解的实现

    SpringMVC中@RequestMapping注解的实现

    RequestMapping是一个用来处理请求地址映射的注解,本文主要介绍了SpringMVC中@RequestMapping注解的实现,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • Spark调度架构原理详解

    Spark调度架构原理详解

    这篇文章主要介绍了Spark 调度架构原理详解,具有一定借鉴价值,需要的朋友可以参考下。
    2017-12-12
  • 解释:int型默认值为0的问题

    解释:int型默认值为0的问题

    这篇文章主要介绍了解释:int型默认值为0的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-08-08
  • spring整合shiro框架的实现步骤记录

    spring整合shiro框架的实现步骤记录

    Shiro是一个强大易用的Java安全框架,提供了认证、授权、加密和会话管理等功能。下面这篇文章主要给大家介绍了关于spring整合shiro框架的实现步骤,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2018-05-05

最新评论