Gateway網(wǎng)關(guān)自定義攔截器的不可重復(fù)讀取數(shù)據(jù)問題
Gateway網(wǎng)關(guān)自定義攔截器的不可重復(fù)讀取數(shù)據(jù)
最近在開發(fā)gateway網(wǎng)關(guān)時(shí),通過自定義攔截器對某些接口的數(shù)據(jù)進(jìn)行處理,發(fā)現(xiàn),無法讀取到數(shù)據(jù)。經(jīng)過查詢,發(fā)現(xiàn)在Spring5的webflux編程或者普通web編程中,只能從request中獲取body一次,后面無法再獲取。
參考網(wǎng)上的方法先通過全局過濾器把body先緩存起來。
這個(gè)網(wǎng)上有很多例子:
/** ?* @author zhong ?* @date 2022/1/6 - 15:34 ?*? ?*/ @Configuration public class CacheBodyGlobalFilter implements Ordered, GlobalFilter { ? ? ? @Override ? ? public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { ? ? ? ? //判斷是否時(shí)認(rèn)證接口 ? ? ? ? if (!AuthUtils.isAuthorPath(exchange.getRequest())) { ? ? ? ? ? ? //不是認(rèn)證接口 ? ? ? ? ? ? return chain.filter(exchange); ? ? ? ? } else { ? ? ? ? ? ? //指定接口可建數(shù)據(jù)從新讀出構(gòu)建 ? ? ? ? ? ? return DataBufferUtils.join(exchange.getRequest().getBody()) ? ? ? ? ? ? ? ? ? ? .flatMap(dataBuffer -> { ? ? ? ? ? ? ? ? ? ? ? ? DataBufferUtils.retain(dataBuffer); ? ? ? ? ? ? ? ? ? ? ? ? Flux<DataBuffer> cachedFlux = Flux ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? .defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount()))); ? ? ? ? ? ? ? ? ? ? ? ? ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) { ? ? ? ? ? ? ? ? ? ? ? ? ? ? @Override ? ? ? ? ? ? ? ? ? ? ? ? ? ? public Flux<DataBuffer> getBody() { ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? return cachedFlux; ? ? ? ? ? ? ? ? ? ? ? ? ? ? } ? ? ? ? ? ? ? ? ? ? ? ? }; ? ? ? ? ? ? ? ? ? ? ? ? //exchange.getAttributes().put(CACHE_REQUEST_BODY_OBJECT_KEY, cachedFlux); ? ? ? ? ? ? ? ? ? ? ? ? return chain.filter(exchange.mutate().request(mutatedRequest).build()); ? ? ? ? ? ? ? ? ? ? }); ? ? ? ? } ? ? } ? ? ? @Override ? ? public int getOrder() { ? ? ? ? return Ordered.HIGHEST_PRECEDENCE; ? ? } }
CacheBodyGlobalFilter這個(gè)全局過濾器的目的就是把原有的request請求中的body內(nèi)容讀出來,并且使用ServerHttpRequestDecorator這個(gè)請求裝飾器對request進(jìn)行包裝,重寫getBody方法,并把包裝后的請求放到過濾器鏈中傳遞下去。這樣后面的過濾器中再使用exchange.getRequest().getBody()來獲取body時(shí),實(shí)際上就是調(diào)用的重載后的getBody方法,獲取的最先已經(jīng)緩存了的body數(shù)據(jù)。這樣就能夠?qū)崿F(xiàn)body的多次讀取了。
這個(gè)過濾器的order設(shè)置的是Ordered.HIGHEST_PRECEDENCE,即最高優(yōu)先級(jí)的過濾器。優(yōu)先級(jí)設(shè)置這么高的原因是某些系統(tǒng)內(nèi)置的過濾器可能也會(huì)去讀body。
但是在測試中我發(fā)現(xiàn),如果我在請求接口中如果沒有body內(nèi)容,就會(huì)導(dǎo)致程序只能執(zhí)行CacheBodyGlobalFilter這一個(gè)攔截器,而無法執(zhí)行其他攔截器(自定義的和默認(rèn)的)。而且接口返回200,這和我的預(yù)期時(shí)不一致的。
通過測試發(fā)現(xiàn),原因是,按照以上代碼執(zhí)行,如果是body為null,Conten-Type也為空,所以沒有執(zhí)行代碼中的flatMap()方法.所以也就沒有執(zhí)行后面的調(diào)用鏈。
chain.filter(exchange.mutate().request(mutatedRequest).build());
解決辦法,在獲取到數(shù)據(jù)流時(shí),如果數(shù)據(jù)流為null,我們可以構(gòu)建一個(gè)空的數(shù)據(jù)流,這也也就能執(zhí)行我們后面的攔截器。
利用Flux.defaultIfEmpty(defaultDataBuffer);的方法可以實(shí)現(xiàn)這個(gè)功能。
public final Flux<T> defaultIfEmpty(T defaultV) { ? ?return onAssembly(new FluxDefaultIfEmpty<>(this, defaultV)); }?
代碼如下:
@Configuration public class CacheBodyGlobalFilter implements Ordered, GlobalFilter { ? ? ? @Override ? ? public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { ? ? ? ? //判斷是否時(shí)認(rèn)證接口 ? ? ? ? if (!AuthUtils.isAuthorPath(exchange.getRequest())) { ? ? ? ? ? ? //不是認(rèn)證接口 ? ? ? ? ? ? return chain.filter(exchange); ? ? ? ? } else { ? ? ? ? ? ? //指定接口可建數(shù)據(jù)從新讀出構(gòu)建 ? ? ? ? ? ? ? //當(dāng)body中沒有緩存時(shí),只會(huì)執(zhí)行這一個(gè)攔截器, 原因是fileMap中的代碼沒有執(zhí)行,所以需要在波多野為空時(shí)構(gòu)建一個(gè)空的緩存 ? ? ? ? ? ? DefaultDataBufferFactory defaultDataBufferFactory = new DefaultDataBufferFactory(); ? ? ? ? ? ? DefaultDataBuffer defaultDataBuffer = defaultDataBufferFactory.allocateBuffer(0); ? ? ? ? ? ? //構(gòu)建新數(shù)據(jù)流, 當(dāng)body為空時(shí),構(gòu)建空流 ? ? ? ? ? ? Flux<DataBuffer> bodyDataBuffer = exchange.getRequest().getBody().defaultIfEmpty(defaultDataBuffer); ? ? ? ? ? ? return DataBufferUtils.join(bodyDataBuffer) ? ? ? ? ? ? ? ? ? ? .flatMap(dataBuffer -> { ? ? ? ? ? ? ? ? ? ? ? ? DataBufferUtils.retain(dataBuffer); ? ? ? ? ? ? ? ? ? ? ? ? Flux<DataBuffer> cachedFlux = Flux ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? .defer(() -> Flux.just(dataBuffer.slice(0, dataBuffer.readableByteCount()))); ? ? ? ? ? ? ? ? ? ? ? ? ServerHttpRequest mutatedRequest = new ServerHttpRequestDecorator(exchange.getRequest()) { ? ? ? ? ? ? ? ? ? ? ? ? ? ? @Override ? ? ? ? ? ? ? ? ? ? ? ? ? ? public Flux<DataBuffer> getBody() { ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? return cachedFlux; ? ? ? ? ? ? ? ? ? ? ? ? ? ? } ? ? ? ? ? ? ? ? ? ? ? ? }; ? ? ? ? ? ? ? ? ? ? ? ? //exchange.getAttributes().put(CACHE_REQUEST_BODY_OBJECT_KEY, cachedFlux); ? ? ? ? ? ? ? ? ? ? ? ? return chain.filter(exchange.mutate().request(mutatedRequest).build()); ? ? ? ? ? ? ? ? ? ? }); ? ? ? ? } ? ? } ? ? ? @Override ? ? public int getOrder() { ? ? ? ? return Ordered.HIGHEST_PRECEDENCE; ? ? } }
當(dāng)然這個(gè)是在我們的攔截的接口存在沒有body,但是也要執(zhí)行后面的攔截器的情況下。如果說接口必須要有body。那我們可以在CacheBodyGlobalFilter 這攔截器中直接返回指定的內(nèi)容。這個(gè)我還沒有測試過。
統(tǒng)一網(wǎng)關(guān)Gateway
一、為什么需要網(wǎng)關(guān)
網(wǎng)關(guān)功能:
- 身份認(rèn)證和權(quán)限校驗(yàn)
- 服務(wù)路由、負(fù)載均衡
- 請求限流
二、搭建網(wǎng)關(guān)服務(wù)
搭建網(wǎng)關(guān)服務(wù)的步驟:
1、創(chuàng)建新的module,引入SpringCloudGateway的依賴和nacos的服務(wù)發(fā)現(xiàn)依賴
<!--網(wǎng)關(guān)依賴--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <!--nacos服務(wù)發(fā)現(xiàn)依賴--> <dependency> <groupId>com.alibaba.cloud</groupId> <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId> </dependency>
2、編寫路由配置及nacos地址
server: port: 10010 # 網(wǎng)關(guān)端口 spring: application: name: gateway # 服務(wù)名稱 cloud: nacos: server-addr: localhost:8848 # nacos地址 gateway: routes: # 網(wǎng)關(guān)路由配置 - id: user-service # 路由id,自定義,只要唯一即可 # uri: http://127.0.0.1:8081 # 路由的目標(biāo)地址 http就是固定地址 uri: lb://userservice # 路由的目標(biāo)地址 lb就是負(fù)載均衡,后面跟服務(wù)名稱 predicates: # 路由斷言,也就是判斷請求是否符合路由規(guī)則的條件 - Path=/user/** # 這個(gè)是按照路徑匹配,只要以/user/開頭就符合要求
3、搭建步驟總結(jié):
創(chuàng)建項(xiàng)目,引入nacos服務(wù)發(fā)現(xiàn)和gateway依賴
配置application.yml,包括服務(wù)基本信息、nacos地址、路由
路由配置包括:
- 路由id:路由的唯一標(biāo)示
- 路由目標(biāo)(uri):路由的目標(biāo)地址,http代表固定地址,lb代表根據(jù)服務(wù)名負(fù)載均衡
- 路由斷言(predicates):判斷路由的規(guī)則,
- 路由過濾器(filters):對請求或響應(yīng)做處理
Gateway執(zhí)行流程:
三、路由斷言工廠
上文中,在配置文件中寫的斷言規(guī)則只是字符串,這些字符串會(huì)被Predicate Factory讀取并處理,轉(zhuǎn)變?yōu)槁酚膳袛嗟臈l件!例如Path=/user/**是按照路徑匹配,這個(gè)規(guī)則是由org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory類來處理的,像這樣的斷言工廠在SpringCloudGateway還有十幾個(gè)
Spring提供了11種基本的Predicate工廠:
四、路由過濾器
路由過濾器 GatewayFilter
GatewayFilter是網(wǎng)關(guān)中提供的一種過濾器,可以對進(jìn)入網(wǎng)關(guān)的請求和微服務(wù)返回的響應(yīng)做處理:
過濾器工廠 GatewayFilterFactory
Spring提供了31種不同的路由過濾器工廠。例如:
過濾器工廠案例:給所有進(jìn)入userservice的請求添加一個(gè)請求頭
給所有進(jìn)入userservice的請求添加一個(gè)請求頭:Truth=xiaobai is headsome
spring: cloud: gateway: routes: # 網(wǎng)關(guān)路由配置 - id: user-service uri: lb://userservice predicates: - Path=/user/** filters: # 過濾器 - AddRequestHeader=Truth, xiaobai is headsome # 添加請求頭
默認(rèn)過濾器
如果要對所有的路由都生效,則可以將過濾器工廠寫到default(默認(rèn)過濾器)下。格式如下:
spring: application: name: gateway # 服務(wù)名稱 cloud: nacos: server-addr: localhost:8848 # nacos地址 gateway: routes: # 網(wǎng)關(guān)路由配置 - id: user-service uri: lb://userservice predicates: - Path=/user/** - id: order-service uri: lb://orderservice predicates: - Path=/order/** default-filters: # 默認(rèn)過濾器,會(huì)對所有的路由請求都生效 - AddRequestHeader=Truth, xiaobai is headsome # 添加請求頭
全局過濾器 GlobalFilter
全局過濾器的作用也是處理一切進(jìn)入網(wǎng)關(guān)的請求和微服務(wù)響應(yīng),與GatewayFilter的作用一樣。
區(qū)別在于GatewayFilter通過配置定義,處理邏輯是固定的。而GlobalFilter的邏輯需要自己寫代碼實(shí)現(xiàn)。
定義方式是實(shí)現(xiàn)GlobalFilter接口。
public interface GlobalFilter { /** * 處理當(dāng)前請求,有必要的話通過{@link GatewayFilterChain}將請求交給下一個(gè)過濾器處理 * * @param exchange 請求上下文,里面可以獲取Request、Response等信息 * @param chain 用來把請求委托給下一個(gè)過濾器 * @return {@code Mono<Void>} 返回標(biāo)示當(dāng)前過濾器業(yè)務(wù)結(jié)束 */ Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain); }
全局過濾器案例:定義全局過濾器,攔截并判斷用戶身份
需求:
定義全局過濾器,攔截請求,判斷請求的參數(shù)是否滿足下面條件:
參數(shù)中是否有authorization,authorization參數(shù)值是否為admin
如果同時(shí)滿足則放行,否則攔截
自定義類,實(shí)現(xiàn)GlobalFilter接口,添加@Order注解
@Order(-1) @Component public class AuthorizeFilter implements GlobalFilter { @Override public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) { // 1.獲取請求參數(shù) MultiValueMap<String, String> params = exchange.getRequest().getQueryParams(); // 2.獲取authorization參數(shù) String auth = params.getFirst("authorization"); // 3.校驗(yàn) if ("admin".equals(auth)) { // 放行 return chain.filter(exchange); } // 4.攔截 // 4.1.禁止訪問 exchange.getResponse().setStatusCode(HttpStatus.FORBIDDEN); // 4.2.結(jié)束處理 return exchange.getResponse().setComplete(); } }
過濾器執(zhí)行順序
請求進(jìn)入網(wǎng)關(guān)會(huì)碰到三類過濾器:當(dāng)前路由的過濾器、DefaultFilter、GlobalFilter
請求路由后,會(huì)將當(dāng)前路由過濾器和DefaultFilter、GlobalFilter,合并到一個(gè)過濾器鏈(集合)中,排序后依次執(zhí)行每個(gè)過濾器
- 每一個(gè)過濾器都必須指定一個(gè)int類型的order值,order值越小,優(yōu)先級(jí)越高,執(zhí)行順序越靠前。
- GlobalFilter通過實(shí)現(xiàn)Ordered接口,或者添加@Order注解來指定order值,由我們自己指定
- 路由過濾器和defaultFilter的order由Spring指定,默認(rèn)是按照聲明順序從1遞增。
- 當(dāng)過濾器的order值一樣時(shí),會(huì)按照 defaultFilter > 路由過濾器 > GlobalFilter的順序執(zhí)行。
五、跨域問題處理
跨域:域名不一致就是跨域,主要包括:
- 域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com
- 域名相同,端口不同:localhost:8080和localhost8081
跨域問題:瀏覽器禁止請求的發(fā)起者與服務(wù)端發(fā)生跨域ajax請求,請求被瀏覽器攔截的問題
解決方案:CORS
網(wǎng)關(guān)處理跨域采用的同樣是CORS方案,并且只需要簡單配置即可實(shí)現(xiàn):
spring: cloud: gateway: globalcors: # 全局的跨域處理 add-to-simple-url-handler-mapping: true # 解決options請求被攔截問題 corsConfigurations: '[/**]': allowedOrigins: # 允許哪些網(wǎng)站的跨域請求 - "http://localhost:8090" - "http://www.leyou.com" allowedMethods: # 允許的跨域ajax的請求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" # 允許在請求中攜帶的頭信息 allowCredentials: true # 是否允許攜帶cookie maxAge: 360000 # 這次跨域檢測的有效期
以上為個(gè)人經(jīng)驗(yàn),希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
SpringBoot2.3.0配置JPA的實(shí)現(xiàn)示例
這篇文章主要介紹了SpringBoot2.3.0配置JPA的實(shí)現(xiàn)示例,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-08-08Java實(shí)現(xiàn)Excel批量導(dǎo)入數(shù)據(jù)
這篇文章主要為大家詳細(xì)介紹了Java實(shí)現(xiàn)Excel批量導(dǎo)入數(shù)據(jù),文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-08-08Mapper類中存在名稱相同的方法重載報(bào)錯(cuò)問題
這篇文章主要介紹了Mapper類中存在名稱相同的方法重載報(bào)錯(cuò)問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-03-03關(guān)于Jackson的JSON工具類封裝 JsonUtils用法
這篇文章主要介紹了關(guān)于Jackson的JSON工具類封裝 JsonUtils用法,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-09-09mybatis-plus查詢無數(shù)據(jù)問題及解決
這篇文章主要介紹了mybatis-plus查詢無數(shù)據(jù)問題及解決方案,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-12-12Java基礎(chǔ)學(xué)習(xí)筆記之?dāng)?shù)組詳解
這篇文章主要介紹了Java基礎(chǔ)學(xué)習(xí)筆記之?dāng)?shù)組,結(jié)合實(shí)例形式詳細(xì)分析了java的基本概念、定義、迭代、輸出、反轉(zhuǎn)、排序等常用操作技巧,需要的朋友可以參考下2019-08-08Java多線程Callable和Future接口區(qū)別
這篇文章主要介紹了Java多線程Callable和Future接口區(qū)別,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-04-04