在Springboot HandlerInterceptor中获取GET和POST请求参数

  说一个最近工作中遇到的事,我们系统因为业务发展的问题,针对不同用户群体做了两套系统(B系统和S系统),底层基础功能一样,但偏上层的业务有差异,最近我们想将底层基础功能提供一个统一的入口,所以就新起了一个类似业务网关的服务,把两个系统的接口封装一层,提供一个统一的接口出去,然后B业务的请求转发的B系统,S业务的请求转发到S系统。

  但这里就有个很重要的问题了,一个请求进来之后,我们如何判定这个请求应该转发到B系统还是S系统? 当然上游请求的时候可以在请求参数里带上他们的业务来源,我们直接根据业务来源路由即可,实际上最开始我们也是这么做的。 但有个问题时有些接口业务方很难判定自己的请求是属于哪个业务方的,而且未来B和S两个系统也是要做融合的。长期的话,使用者对业务标识字段有很大的理解成本,而且未来融合的时候业务标识会变动,到时候推动上游改造就很难很难了。

  幸运的是,我们自己其实可以通过请求中的id信息来判断出是哪个业务的。但是目前已经6-7接口了,未来肯定会继续增加接口,难道每个接口都需要加判断逻辑? 这显然很不程序猿! 上面已经说到了,每个接口都需要传id信息,那是不是只需要写个interceptor把id信息解析出来,然后统一做处理就行了! 实际实现的时候,我发现还是稍微有一点点复杂,特此记录下。

  首先如果是将参数放在params里的请求,就很简单了,只需要在Interceptor直接读出来就行了。 形如String orderId = request.getParameter("orderId"); 但从请求body里获取参数就比较复杂了,得从HttpServletRequest里的inputStream里获取到。 但是,java中inputStream的特性,从里面读出内容后,之后就没法读了,也就是说你在Inteceptor里取到了Body,后面的流程就再也取不到了,总之这次的http请求就费了。当然解决方法也很简单,通过我查阅资料,只需要用HttpServletRequestWrapper将Request请求包装一层就行了,作用就是让body能重复读取,具体代码如下:

  先来看下RequestWrapper的实现:

public class RequestWrapper extends HttpServletRequestWrapper {

	private String body;

	/**
	 * Wrapper的构造方法,主要是将body里的内容取出来,然后存储到对象中的body变量中,方便
	 * 后续复用
	 *
	 * @param request The request to wrap
	 * @throws IllegalArgumentException if the request is null
	 */
	public RequestWrapper(HttpServletRequest request) throws IOException {
		super(request);

		StringBuilder stringBuilder = new StringBuilder();
		BufferedReader bufferedReader = null;
		try {
			InputStream inputStream = request.getInputStream();
			if (inputStream != null) {
				bufferedReader = new BufferedReader(new InputStreamReader(inputStream,"UTF-8"));
				char[] charBuffer = new char[128];
				int bytesRead = -1;
				while ((bytesRead = bufferedReader.read(charBuffer)) > 0) {
					stringBuilder.append(charBuffer, 0, bytesRead);
				}
			}
		} catch (IOException ex) {
			throw ex;
		} finally {
			if (bufferedReader != null) {
				try {
					bufferedReader.close();
				} catch (IOException ex) {
					throw ex;
				}
			}
		}
		body = stringBuilder.toString();
	}


	/**
	 * 这里才是关键,这里将getInputStream重新,让它能重复获取到body里的内容,这样才不会影响后续的流程
	 * @return
	 * @throws IOException
	 */
	@Override
	public ServletInputStream getInputStream() throws IOException {
		final ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(body.getBytes("UTF-8"));
		ServletInputStream servletInputStream = new ServletInputStream() {
			@Override
			public boolean isFinished() {
				return false;
			}

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

			@Override
			public void setReadListener(ReadListener readListener) { }
			
			@Override
			public int read() throws IOException {
				return byteArrayInputStream.read();
			}
		};
		return servletInputStream;
	}


	/**
	 * 重写获取 字符流的方式
	 * @return
	 * @throws IOException
	 */
	@Override
	public BufferedReader getReader() throws IOException {
		return new BufferedReader(new InputStreamReader(this.getInputStream(), Charsets.UTF_8));
	}


	/**
	 * 获取body
	 * @return
	 */
	public String getBody() {
		return this.body;
	}
}

  上面RequestWrapper的代码我查阅资料的时候在多篇博文中看到了,但是单有RequestWrapper还不足以完成整个请求,而且我看很多网络上的博客都是只在Interceptor中Wapper,但实际这样是不对的,而且也完全不需要,因为必须要替换掉整个请求链路中的Request才行。这里我们只需要在Filter中将普通的Request替换成我们自己的RequestWrapper ,具体代码如下:

@Component
@WebFilter(urlPatterns = "/*", filterName = "wapperRequestFilter")
public class WapperRequestFilter implements Filter {

	@Override
	public void init(FilterConfig filterConfig) throws ServletException {

	}

	@Override
	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
		ServletRequest requestWrapper = null;
		if(servletRequest instanceof HttpServletRequest) {
			requestWrapper = new RequestWrapper((HttpServletRequest) servletRequest);
		}
		if(requestWrapper == null) {
			filterChain.doFilter(servletRequest, servletResponse);
		} else {
		    // 将请求封装并传递下去
			filterChain.doFilter(requestWrapper, servletResponse);
		}
	}

	@Override
	public void destroy() {

	}
}

  接下来我们就可以直接在Inteceptor里使用RequestWrapper来获取Body里的内容,并且不会影响到后续的请求处理,具体代码如下:

@Component
@Slf4j
public class WebInterceptor implements HandlerInterceptor {
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
		String orderId = request.getParameter("orderId");
		String body = StringUtils.EMPTY;
		if (request instanceof RequestWrapper) {
			body = ((RequestWrapper) request).getBody();
		}
		if (StringUtils.isNotBlank(body)) {
			JSONObject jsonObject = JSONObject.parseObject(body);
			orderId = jsonObject.getString("orderId");
		}
		LOGGER.info("orderId:{}", orderId);
		return true;
	}

	@Override
	public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
	}
}

   在上面的代码中WebInterceptor可以拿到我们替换后的WapperRequest,这个里面可以直接获取到body,而且也不影响后续流程继续获取body。 今天的内容就到这里了,虽然只是自己解决问题的一个小笔记,但也希望能帮助到大家。

  • 3
    点赞
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 5
    评论
Spring BootHandlerInterceptor是一个拦截器接口,用于在请求处理之前和之后进行拦截操作。它可以拦截请求并在处理器执行之前和之后执行自定义逻辑,比如日志记录、权限验证等。 要使用HandlerInterceptor,首先需要实现该接口,并实现其的三个方法: 1. preHandle:在请求处理之前执行,返回true表示继续处理请求,返回false则终止请求处理流程。 2. postHandle:在请求处理之后、视图渲染之前执行,可以对ModelAndView进行操作。 3. afterCompletion:在整个请求处理完成后执行,主要用于清理资源等工作。 接下来,需要将自定义的HandlerInterceptor注册到Spring Boot的配置。可以通过实现WebMvcConfigurer接口,并覆盖addInterceptors方法来添加自定义的拦截器。 以下是一个简单的示例代码: ```java import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { // 执行请求处理之前的逻辑 return true; // 返回true表示继续处理请求,返回false表示终止请求处理流程 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 执行请求处理之后、视图渲染之前的逻辑 } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 整个请求处理完成后执行的逻辑,可以用于清理资源等工作 } } ``` 然后在配置类注册这个拦截器: ```java import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; @Configuration public class MyInterceptorConfig implements WebMvcConfigurer { @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**"); } } ``` 上述代码将自定义的拦截器添加到所有请求路径上。 这样,当有请求进来时,会先经过preHandle方法,然后执行请求处理器(Controller),再经过postHandle方法,最后经过afterCompletion方法。在这些方法可以根据具体需求进行相应的处理和操作。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 5
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

xindoo

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值