SpringBoot如何使用RequestBodyAdvice進(jìn)行統(tǒng)一參數(shù)處理
SpringBoot RequestBodyAdvice參數(shù)處理
在實(shí)際項(xiàng)目中 , 往往需要對(duì)請(qǐng)求參數(shù)做一些統(tǒng)一的操作 , 例如參數(shù)的過(guò)濾 , 字符的編碼 , 第三方的解密等等 , Spring提供了RequestBodyAdvice一個(gè)全局的解決方案 , 免去了我們?cè)贑ontroller處理的繁瑣 .
RequestBodyAdvice僅對(duì)使用了@RqestBody注解的生效 , 因?yàn)樗砩线€是AOP , 所以GET方法是不會(huì)操作的.
package com.xbz.common.web;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.RequestBodyAdvice;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Type;
/**
* @title 全局請(qǐng)求參數(shù)處理類
* @author Xingbz
* @createDate 2019-8-2
*/
@ControllerAdvice(basePackages = "com.xbz.controller")//此處設(shè)置需要當(dāng)前Advice執(zhí)行的域 , 省略默認(rèn)全局生效
public class GlobalRequestBodyAdvice implements RequestBodyAdvice {
/** 此處如果返回false , 則不執(zhí)行當(dāng)前Advice的業(yè)務(wù) */
@Override
public boolean supports(MethodParameter methodParameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
// return methodParameter.getMethod().isAnnotationPresent(XXApiReq.class);
return false;
}
/**
* @title 讀取參數(shù)前執(zhí)行
* @description 在此做些編碼 / 解密 / 封裝參數(shù)為對(duì)象的操作
*
* */
@Override
public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) throws IOException {
return new XHttpInputMessage(inputMessage, "UTF-8");
}
/**
* @title 讀取參數(shù)后執(zhí)行
* @author Xingbz
*/
@Override
public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
return inputMessage;
}
/**
* @title 無(wú)請(qǐng)求時(shí)的處理
*/
@Override
public Object handleEmptyBody(Object body, HttpInputMessage inputMessage, MethodParameter parameter, Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
return body;
}
}
//這里實(shí)現(xiàn)了HttpInputMessage 封裝一個(gè)自己的HttpInputMessage
class XHttpInputMessage implements HttpInputMessage {
private HttpHeaders headers;
private InputStream body;
public XHttpInputMessage(HttpInputMessage httpInputMessage, String encode) throws IOException {
this.headers = httpInputMessage.getHeaders();
this.body = encode(httpInputMessage.getBody(), encode);
}
private InputStream encode(InputStream body, String encode) {
//省略對(duì)流進(jìn)行編碼的操作
return body;
}
@Override
public InputStream getBody() {
return body;
}
@Override
public HttpHeaders getHeaders() {
return null;
}
}
Spring默認(rèn)提供了接口的抽象實(shí)現(xiàn)類RequestBodyAdviceAdapter , 我們可以繼承這個(gè)類按需實(shí)現(xiàn) , 讓代碼更簡(jiǎn)潔一點(diǎn)
package org.springframework.web.servlet.mvc.method.annotation;
import java.io.IOException;
import java.lang.reflect.Type;
import org.springframework.core.MethodParameter;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.lang.Nullable;
public abstract class RequestBodyAdviceAdapter implements RequestBodyAdvice {
@Override
public HttpInputMessage beforeBodyRead(HttpInputMessage inputMessage, MethodParameter parameter,
Type targetType, Class<? extends HttpMessageConverter<?>> converterType)
throws IOException {
return inputMessage;
}
@Override
public Object afterBodyRead(Object body, HttpInputMessage inputMessage, MethodParameter parameter,
Type targetType, Class<? extends HttpMessageConverter<?>> converterType) {
return body;
}
@Override
@Nullable
public Object handleEmptyBody(@Nullable Object body, HttpInputMessage inputMessage,
MethodParameter parameter, Type targetType,
Class<? extends HttpMessageConverter<?>> converterType) {
return body;
}
}
Springboot 對(duì)RequestBody的值進(jìn)行統(tǒng)一修改的幾種方式
背景
最近在項(xiàng)目中遇到需要統(tǒng)一對(duì)Request請(qǐng)求中的某一個(gè)自定義對(duì)象的屬性進(jìn)行統(tǒng)一修改的需求。
考慮了幾種實(shí)現(xiàn)方式，現(xiàn)在記錄一下。由于原項(xiàng)目過(guò)于復(fù)雜，自己寫幾個(gè)demo進(jìn)行記錄。
解決方式
方式一：利用filter進(jìn)行處理
大坑：
如果你想要改變加了RequestBody注解的數(shù)據(jù)，無(wú)論如何你都要通過(guò)getInputStream()方法來(lái)獲取流來(lái)拿到對(duì)應(yīng)的參數(shù)，然后更改。在不經(jīng)過(guò)拿取流的情況下，spring的RequestBody注解也是通過(guò)getInputStream()方法來(lái)獲取流來(lái)映射為request對(duì)象。
但是如果你想要的統(tǒng)一的進(jìn)行修改，也必須經(jīng)過(guò)getInputStream()來(lái)首先拿到stream然后才能進(jìn)行修改。但此時(shí)stream被消費(fèi)之后，就會(huì)關(guān)閉。
然后你的controller中的參數(shù)就拿不到對(duì)象，報(bào)錯(cuò)如下。
I/O error while reading input message; nested exception is java.io.IOException: Stream closed
可以通過(guò)創(chuàng)建并使用自定義的的HttpServletRequestWrapper來(lái)避免這種情況。
步驟一：編寫自定義HttpServletRequestWrapper
package com.example.testlhf.filter;
import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.JSONObject;
import com.example.testlhf.entity.Student;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.ReadListener;
import javax.servlet.ServletInputStream;
import javax.servlet.ServletRequest;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
/**
* @Description TODO
* @Author yyf
* @Date 2020/10/29 12:48
* @Version 1.0
**/
@Slf4j
public class ChangeStudentNameRequestWrapper extends HttpServletRequestWrapper {
/**
* 存儲(chǔ)body數(shù)據(jù)的容器
*/
private byte[] body;
public ChangeStudentNameRequestWrapper(HttpServletRequest request) throws IOException {
super(request);
//接下來(lái)的request使用這個(gè)
String bodyStr = getBodyString(request);
body = bodyStr.getBytes(Charset.defaultCharset());
}
/**
* 獲取請(qǐng)求Body
*
* @param request request
* @return String
*/
public String getBodyString(final ServletRequest request) {
try {
return inputStream2String(request.getInputStream());
} catch (IOException e) {
log.error("", e);
throw new RuntimeException(e);
}
}
/**
* 獲取請(qǐng)求Body
*
* @return String
*/
public String getBodyString() {
final InputStream inputStream = new ByteArrayInputStream(body);
return inputStream2String(inputStream);
}
/**
* 將inputStream里的數(shù)據(jù)讀取出來(lái)并轉(zhuǎn)換成字符串
*
* @param inputStream inputStream
* @return String
*/
private String inputStream2String(InputStream inputStream) {
StringBuilder sb = new StringBuilder();
BufferedReader reader = null;
try {
reader = new BufferedReader(new InputStreamReader(inputStream, Charset.defaultCharset()));
String line;
while ((line = reader.readLine()) != null) {
sb.append(line);
}
} catch (IOException e) {
log.error("", e);
throw new RuntimeException(e);
} finally {
if (reader != null) {
try {
reader.close();
} catch (IOException e) {
log.error("", e);
}
}
}
JSONObject jsonObject = JSONObject.parseObject(sb.toString());
if (jsonObject != null && jsonObject.get("student") != null) {
Student student = JSON.toJavaObject((JSON) jsonObject.get("student"), Student.class);
log.info("修改之前的學(xué)生名稱為：" + student.getName());
student.setName("amd");
jsonObject.put("student", student);
return jsonObject.toJSONString();
}
return sb.toString();
}
@Override
public BufferedReader getReader() throws IOException {
return new BufferedReader(new InputStreamReader(getInputStream()));
}
@Override
public ServletInputStream getInputStream() throws IOException {
final ByteArrayInputStream inputStream = new ByteArrayInputStream(body);
return new ServletInputStream() {
@Override
public int read() throws IOException {
return inputStream.read();
}
@Override
public boolean isFinished() {
return false;
}
@Override
public boolean isReady() {
return false;
}
@Override
public void setReadListener(ReadListener readListener) {
}
};
}
}
步驟二：使用自定義的HttpServletRequestWrapper取代原有的
使用自定義的request取代原有的傳遞給過(guò)濾器鏈。
package com.example.testlhf.filter;
import lombok.extern.slf4j.Slf4j;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
/**
* @Description TODO
* @Author yyf
* @Date 2020/10/29 13:20
* @Version 1.0
**/
@Slf4j
public class ReplaceStreamFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
log.info("StreamFilter初始化...");
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
ServletRequest requestWrapper = null;
//獲取請(qǐng)求中的流，將取出來(lái)的字符串，再次轉(zhuǎn)換成流，然后把它放入到新request對(duì)象中,
if (request instanceof HttpServletRequest) {
requestWrapper = new ChangeStudentNameRequestWrapper((HttpServletRequest) request);
}
// 在chain.doFiler方法中傳遞新的request對(duì)象
if (requestWrapper == null) {
chain.doFilter(request, response);
} else {
chain.doFilter(requestWrapper, response);
}
}
@Override
public void destroy() {
log.info("StreamFilter銷毀...");
}
}
步驟三：將過(guò)濾器注冊(cè)進(jìn)spring容器
package com.example.testlhf.filter;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.servlet.Filter;
/**
* @Description TODO
* @Author yyf
* @Date 2020/10/29 14:20
* @Version 1.0
**/
@Configuration
public class MyFilterConfig {
/**
* 注冊(cè)過(guò)濾器
*
* @return FilterRegistrationBean
*/
@Bean
public FilterRegistrationBean someFilterRegistration() {
FilterRegistrationBean<Filter> registration = new FilterRegistrationBean<>();
registration.setFilter(replaceStreamFilter());
registration.addUrlPatterns("/*");
registration.setName("replaceStreamFilter");
return registration;
}
/**
* 實(shí)例化StreamFilter
*
* @return Filter
*/
@Bean(name = "replaceStreamFilter")
public Filter replaceStreamFilter() {
return new ReplaceStreamFilter();
}
}
看下效果：
到此使用過(guò)濾器對(duì)post請(qǐng)求中的參數(shù)的修改已經(jīng)完畢。
方式二：使用攔截器進(jìn)行處理
當(dāng)我自以為可以使用攔截器前置通知進(jìn)行處理時(shí)才發(fā)現(xiàn)，事情并不簡(jiǎn)單。
步驟一：自定義一個(gè)攔截器
如下圖實(shí)現(xiàn)一個(gè)攔截器，preHandle中有HttpServletRequest request參數(shù)，雖然可以通過(guò)它的流獲取到body中數(shù)據(jù)，但是如果將body中數(shù)據(jù)進(jìn)行修改的話，其并不能傳遞給controller。因?yàn)閞equest只有兩個(gè)set方法。如果將要統(tǒng)一修改的值攝入Attribute，則還仍需從controller中拿到
步驟二：在controller中獲取值
雖然用這種方式可以在request中添加統(tǒng)一的參數(shù)，也可以從每一個(gè)controller中獲取值，但仍需要對(duì)每一個(gè)controller進(jìn)行代碼修改，顯然這種方式并不是我們需要的。
方式三：使用切面處理
步驟一：引入aspect所需要使用的maven依賴
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aspects</artifactId>
<version>5.1.3.RELEASE</version>
</dependency>
步驟二：編寫自定義的前置通知以及表達(dá)
@Component
@Aspect
public class ChangeStudentNameAdvice {
@Before("execution(* com.example.testlhf.service.impl.*.*(..))&&args(addStudentRequset)")
public void aroundPoints(AddStudentRequset addStudentRequset) {
addStudentRequset.getStudent().setName("amd");
}
}
注意此處的形參需要和args括號(hào)內(nèi)的字符串保持一致，否則報(bào)錯(cuò)。
注意此處的形參需要和args括號(hào)內(nèi)的字符串保持一致，否則報(bào)錯(cuò)。
步驟三：開啟注解@EnableAspectJAutoProxy
總結(jié)：
首先說(shuō)下filter和interceptor的區(qū)別：兩者之間的所依賴的環(huán)境不一致，filter作為javaWeb三大組件之一，其作用為：攔截請(qǐng)求，以及過(guò)濾相應(yīng)。其依賴于servlet容器。但interceptor依賴于web框架，例如springmvc框架。最常見的面向切面編程AOP所使用的動(dòng)態(tài)代理模式，即是使用攔截器在service方法執(zhí)行前或者執(zhí)行后進(jìn)行一些操作。他們都可以適用于如下的場(chǎng)景：權(quán)限檢查，日志記錄，事務(wù)管理等等。當(dāng)然包括，對(duì)所有的請(qǐng)求某些參數(shù)進(jìn)行統(tǒng)一的修改。
比較三種方式，方式一和方式二所謂的攔截基本都是基于對(duì)http請(qǐng)求的攔截，filter執(zhí)行在interceptor之前。雖然filter和interceptor都有類似鏈這種概念，但filter可以將request請(qǐng)求修改之后傳遞給后面的filter，就像電路中的串聯(lián)，而interceptor的鏈?zhǔn)仟?dú)立的，修改其中一個(gè)request并不會(huì)影響其他的interceptor，類似并聯(lián)，不能做到只修改一處其他不用修改的方式。
簡(jiǎn)單來(lái)說(shuō)方式一和方式二針對(duì)進(jìn)入controller進(jìn)行攔截，而后做一些操作。方式三使用的攔截的理念是針對(duì)業(yè)務(wù)方法的，在執(zhí)行業(yè)務(wù)方法的前面對(duì)參數(shù)進(jìn)行修改，和spring中對(duì)事務(wù)控制的實(shí)現(xiàn)方式類似。
思考：
雖然第一，第三種方式都可以在技術(shù)上實(shí)現(xiàn)針對(duì)某些方法進(jìn)行統(tǒng)一的參數(shù)修改。但是如果將項(xiàng)目當(dāng)做一個(gè)工程來(lái)思考的話，不同于日志打印或者事務(wù)控制這種非業(yè)務(wù)邏輯的處理，這種統(tǒng)一修改某些參數(shù)來(lái)完成一些操作，已嚴(yán)重入侵了業(yè)務(wù)邏輯。
真正的解決方式要么在請(qǐng)求的源頭就做好參數(shù)設(shè)置，要么通過(guò)配置文件在需要使用的地方來(lái)進(jìn)行某些參數(shù)的賦值。
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
Spring?MVC各種參數(shù)進(jìn)行封裝的方法實(shí)例
這篇文章主要給大家介紹了關(guān)于Spring?MVC各種參數(shù)進(jìn)行封裝的相關(guān)資料,SpringMVC內(nèi)置多種數(shù)據(jù)類型轉(zhuǎn)換器,可以根據(jù)請(qǐng)求中的參數(shù)與后端控制器方法的參數(shù)的關(guān)系為我們實(shí)現(xiàn)簡(jiǎn)單的數(shù)據(jù)封裝,需要的朋友可以參考下2023-06-06
SpringBoot請(qǐng)求參數(shù)傳遞與接收說(shuō)明小結(jié)
這篇文章主要介紹了SpringBoot請(qǐng)求參數(shù)傳遞與接收，本文通過(guò)示例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2022-12-12
這篇文章主要介紹了Spring Boot 打包分離依賴JAR 和配置文件,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-11-11
這篇文章主要介紹了SpringBoot 自動(dòng)裝配的原理詳解分析，文章通過(guò)通過(guò)一個(gè)案例來(lái)看一下自動(dòng)裝配的效果展開詳情，感興趣的小伙伴可以參考一下2022-08-08
java實(shí)現(xiàn)Excel的導(dǎo)入、導(dǎo)出
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)Excel的導(dǎo)入、導(dǎo)出的相關(guān)資料，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-06-06
Java實(shí)現(xiàn)經(jīng)典游戲打磚塊游戲的示例代碼
這篇文章主要介紹了如何利用Java實(shí)現(xiàn)經(jīng)典的游戲—打磚塊。玩家操作一根螢?zāi)簧纤降摹鞍糇印保屢活w不斷彈來(lái)彈去的“球”在撞擊作為過(guò)關(guān)目標(biāo)消去的“磚塊”的途中不會(huì)落到螢?zāi)坏紫?。感興趣的小伙伴可以了解一下2022-02-02
Java教程各種接口的介紹，需要的朋友可以參考一下2013-02-02
簡(jiǎn)單實(shí)現(xiàn)java上傳圖片文件功能
這篇文章主要教大家如何簡(jiǎn)單實(shí)現(xiàn)java上傳圖片文件功能，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-01-01
下面小編就為大家?guī)?lái)一篇深入理解JAVA多線程之線程間的通信方式。小編覺(jué)得挺不錯(cuò)的，現(xiàn)在分享給大家，也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-05-05
使用Autowired為什么會(huì)被IDEA警告最佳修改方法
這篇文章主要介紹了使用Autowired為什么會(huì)被IDEA警告，應(yīng)該怎么修改最佳,除了使用@Autowired以外，我們其實(shí)也有幾種好用的方式，使用@Resource替代@Autiwired方法是其中一種，只需要改變一個(gè)注解，這里就不展示了，需要的朋友可以參考下2023-02-02