gateway網(wǎng)關接口請求的校驗方式
gateway網(wǎng)關token的校驗
再加入gateway網(wǎng)關之后,我們在后臺服務的許多校驗操作都可以移動到gateway網(wǎng)關, 今天我就來說一下怎么校驗請求攜帶的token。
首先我們需要編寫一個局部過濾器
繼承AbstractGatewayFilterFactory如下
然后在apply方法中實現(xiàn)自己要校驗的邏輯,所有的請求參數(shù)或者token都可以通過request獲取。 驗證失敗我在catch捕捉異常, 然后將異常信息返回給前端請求,
返回信息的異常處理是這樣的
e.printStackTrace(); ServerHttpResponse response = exchange.getResponse(); JSONObject message = new JSONObject(); message.put("status", -1); message.put("data", e.getMessage()); byte[] bits = message.toJSONString().getBytes(StandardCharsets.UTF_8); DataBuffer buffer = response.bufferFactory().wrap(bits); response.setStatusCode(HttpStatus.UNAUTHORIZED); //指定編碼,否則在瀏覽器中會中文亂碼 response.getHeaders().add("Content-Type", "text/plain;charset=UTF-8"); return response.writeWith(Mono.just(buffer));
狀態(tài)碼根據(jù)需求自己定義,異常信息就可以放回給前端請求。
至于校驗通過,就直接放行即可
chain.filter(exchange);
如果還需要修改返回的路徑請求可以這樣
// 修改路徑 String newPath ="/test/" + request.getPath(); ServerHttpRequest newRequest = request.mutate() .path(newPath) .build(); exchange.getAttributes().put(GATEWAY_REQUEST_URL_ATTR, newRequest.getURI()); //放行 return chain.filter(exchange.mutate() .request(newRequest).build());
以上就是過濾器的編寫, 然后就是路由的配置,我是在yml文件中配置
routes: - id: token_routh uri: lb://test-service order: 0 predicates: - Path=/test/** filters: # 去除/test - StripPrefix=1 - TokenApi
filters下面的TokenApi對應的過濾器就是剛剛編寫的過濾器,以上就完成了 對指定接口校驗的功能。
spring cloud gateway網(wǎng)關請求處理過程
一、網(wǎng)關請求處理過程
客戶端向Spring Cloud Gateway發(fā)出請求。如果網(wǎng)關處理程序映射確定請求與路由匹配,則將其發(fā)送到網(wǎng)關Web處理程序。此處理程序運行通過特定于請求的過濾器鏈發(fā)送請求。濾波器被虛線劃分的原因是濾波器可以在發(fā)送代理請求之前或之后執(zhí)行邏輯。執(zhí)行所有“pre”過濾器邏輯,然后進行代理請求。在發(fā)出代理請求之后,執(zhí)行“post”過濾器邏輯。
在沒有端口的路由中定義的URI將分別為HTTP和HTTPS URI獲取默認端口設置為80和443。
DispatcherHandler
:所有請求的調度器,負載請求分發(fā)RoutePredicateHandlerMapping
:路由謂語匹配器,用于路由的查找,以及找到路由后返回對應的WebHandler,DispatcherHandler會依次遍歷HandlerMapping集合進行處理FilteringWebHandler
: 使用Filter鏈表處理請求的WebHandler,RoutePredicateHandlerMapping找到路由后返回對應的FilteringWebHandler對請求進行處理,F(xiàn)ilteringWebHandler負責組裝Filter鏈表并調用鏈表處理請求。
1.1、DispatcherHandler分發(fā)處理
在import org.springframework.web.reactive.DispatcherHandler;類中核心方法handle
public Mono<Void> handle(ServerWebExchange exchange) { if (logger.isDebugEnabled()) { ServerHttpRequest request = exchange.getRequest(); logger.debug("Processing " + request.getMethodValue() + " request for [" + request.getURI() + "]"); } //校驗handlerMapping集合是否為空 //依次遍歷handlerMapping集合進行請求處理 //通過mapping獲取mapping對應的handler,調用handler處理 return this.handlerMappings == null ? Mono.error(HANDLER_NOT_FOUND_EXCEPTION) : Flux.fromIterable(this.handlerMappings).concatMap((mapping) -> { return mapping.getHandler(exchange); }).next().switchIfEmpty(Mono.error(HANDLER_NOT_FOUND_EXCEPTION)).flatMap((handler) -> { return this.invokeHandler(exchange, handler); }).flatMap((result) -> { return this.handleResult(exchange, result); }); }
DispatcherHandler的handler執(zhí)行順序
- 校驗handlerMapping
- 遍歷Mapping獲取mapping對應的handler(此處會找到gateway對應的 RoutePredicateHandlerMapping,并通過 RoutePredicateHandlerMapping獲取handler(FilteringWebHandler))
- 通過handler對應的HandlerAdapter對handler進行調用(gateway使用的 SimpleHandlerAdapter) 即 FilteringWebHandler與SimpleHandlerAdapter對應
其中SimpleHandlerAdapter中handler實現(xiàn)
public Mono<HandlerResult> handle(ServerWebExchange exchange, Object handler) { WebHandler webHandler = (WebHandler)handler; Mono<Void> mono = webHandler.handle(exchange); return mono.then(Mono.empty()); }
1.2、RoutePredicateHandlerMapping 路由謂詞處理映射
public class RoutePredicateHandlerMapping extends AbstractHandlerMapping { private final FilteringWebHandler webHandler; private final RouteLocator routeLocator; public RoutePredicateHandlerMapping(FilteringWebHandler webHandler, RouteLocator routeLocator, GlobalCorsProperties globalCorsProperties) { this.webHandler = webHandler; this.routeLocator = routeLocator; //設置排序字段1,此處的目的是Spring Cloud Gateway 的 GatewayWebfluxEndpoint 提供 HTTP API ,不需要經(jīng)過網(wǎng)關 //它通過 RequestMappingHandlerMapping 進行請求匹配處理。RequestMappingHandlerMapping 的 order = 0 , // 需要排在 RoutePredicateHandlerMapping 前面。所有,RoutePredicateHandlerMapping 設置 order = 1 。 this.setOrder(1); this.setCorsConfigurations(globalCorsProperties.getCorsConfigurations()); } protected Mono<?> getHandlerInternal(ServerWebExchange exchange) { //設置mapping到上下文環(huán)境 exchange.getAttributes().put(ServerWebExchangeUtils.GATEWAY_HANDLER_MAPPER_ATTR, this.getClass().getSimpleName()); // 查找路由 return this.lookupRoute(exchange).flatMap((r) -> { exchange.getAttributes().remove(ServerWebExchangeUtils.GATEWAY_PREDICATE_ROUTE_ATTR); if (this.logger.isDebugEnabled()) { this.logger.debug("Mapping [" + this.getExchangeDesc(exchange) + "] to " + r); } //將找到的路由信息設置到上下文環(huán)境中 exchange.getAttributes().put(ServerWebExchangeUtils.GATEWAY_ROUTE_ATTR, r); //返回mapping對應的WebHandler即FilteringWebHandler return Mono.just(this.webHandler); }).switchIfEmpty(Mono.empty().then(Mono.fromRunnable(() -> { //當前未找到路由時返回空,并移除GATEWAY_PREDICATE_ROUTE_ATTR exchange.getAttributes().remove(ServerWebExchangeUtils.GATEWAY_PREDICATE_ROUTE_ATTR); if (this.logger.isTraceEnabled()) { this.logger.trace("No RouteDefinition found for [" + this.getExchangeDesc(exchange) + "]"); } }))); } protected CorsConfiguration getCorsConfiguration(Object handler, ServerWebExchange exchange) { return super.getCorsConfiguration(handler, exchange); } private String getExchangeDesc(ServerWebExchange exchange) { StringBuilder out = new StringBuilder(); out.append("Exchange: "); out.append(exchange.getRequest().getMethod()); out.append(" "); out.append(exchange.getRequest().getURI()); return out.toString(); } protected Mono<Route> lookupRoute(ServerWebExchange exchange) { //通過路由定位器獲取路由信息 return this.routeLocator.getRoutes().concatMap((route) -> { return Mono.just(route).filterWhen((r) -> { exchange.getAttributes().put(ServerWebExchangeUtils.GATEWAY_PREDICATE_ROUTE_ATTR, r.getId()); return (Publisher)r.getPredicate().apply(exchange); }).doOnError((e) -> { this.logger.error("Error applying predicate for route: " + route.getId(), e); }).onErrorResume((e) -> { return Mono.empty(); }); }).next().map((route) -> { if (this.logger.isDebugEnabled()) { this.logger.debug("Route matched: " + route.getId()); } this.validateRoute(route, exchange); return route; }); } protected void validateRoute(Route route, ServerWebExchange exchange) { } }
RoutePredicateHandlerMapping的執(zhí)行順序
- 通過路由定位器獲取全部路由(RouteLocator)
- 通過路由的謂語(Predicate)過濾掉不可用的路由信息
- 查找到路由信息后將路由信息設置當上下文環(huán)境中(GATEWAY_ROUTE_ATTR)
- 返回gatway自定的webhandler(FilteringWebHandler)
備注:
在構建方法中看到setOrder(1);作用:Spring Cloud Gateway 的 GatewayWebfluxEndpoint 提供 HTTP API ,不需要經(jīng)過網(wǎng)關。
通過 RequestMappingHandlerMapping 進行請求匹配處理。RequestMappingHandlerMapping 的 order = 0 ,需要排在 RoutePredicateHandlerMapping 前面,所以設置 order = 1 。
1.3、FilteringWebHandler 過濾web請求處理
/** * 通過過濾器處理web請求的處理器 */ public class FilteringWebHandler implements WebHandler { protected static final Log logger = LogFactory.getLog(FilteringWebHandler.class); /** * 全局過濾器 */ private final List<GatewayFilter> globalFilters; public FilteringWebHandler(List<GlobalFilter> globalFilters) { this.globalFilters = loadFilters(globalFilters); } /** * 包裝加載全局的過濾器,將全局過濾器包裝成GatewayFilter */ private static List<GatewayFilter> loadFilters(List<GlobalFilter> filters) { return filters.stream() .map(filter -> { //將所有的全局過濾器包裝成網(wǎng)關過濾器 GatewayFilterAdapter gatewayFilter = new GatewayFilterAdapter(filter); //判斷全局過濾器是否實現(xiàn)了可排序接口 if (filter instanceof Ordered) { int order = ((Ordered) filter).getOrder(); //包裝成可排序的網(wǎng)關過濾器 return new OrderedGatewayFilter(gatewayFilter, order); } return gatewayFilter; }).collect(Collectors.toList()); } @Override public Mono<Void> handle(ServerWebExchange exchange) { //獲取請求上下文設置的路由實例 Route route = exchange.getRequiredAttribute(GATEWAY_ROUTE_ATTR); //獲取路由定義下的網(wǎng)關過濾器集合 List<GatewayFilter> gatewayFilters = route.getFilters(); //組合全局的過濾器與路由配置的過濾器 List<GatewayFilter> combined = new ArrayList<>(this.globalFilters); //添加路由配置過濾器到集合尾部 combined.addAll(gatewayFilters); //對過濾器進行排序 AnnotationAwareOrderComparator.sort(combined); logger.debug("Sorted gatewayFilterFactories: "+ combined); //創(chuàng)建過濾器鏈表對其進行鏈式調用 return new DefaultGatewayFilterChain(combined).filter(exchange); } }
FilteringWebHandler的執(zhí)行順序
- 構建一個包含全局過濾器的集合(combined)
- 獲取上下中的路由信息GATEWAY_ROUTE_ATTR
- 將路由里的過濾器添加到集合中(combined)
- 對過濾器集合進行排序操作
- 通過過濾器集合組裝過濾器鏈表,并進行調用(DefaultGatewayFilterChain與Servlet中的FilterChain與原理是一致的)
- 通過過濾器來處理請求到具體業(yè)務服務
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
Java報錯:UnsupportedOperationException in Collection
在Java編程中,UnsupportedOperationException是一種常見的運行時異常,通常在試圖對不支持的操作執(zhí)行修改時發(fā)生,它表示當前操作不被支持,本文將深入探討UnsupportedOperationException的產(chǎn)生原因,并提供具體的解決方案和最佳實踐,需要的朋友可以參考下2024-06-06Java線程隊列LinkedBlockingQueue的使用
本文主要介紹了Java線程隊列LinkedBlockingQueue的使用,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2023-06-06項目打包成jar后包無法讀取src/main/resources下文件的解決
本文主要介紹了項目打包成jar后包無法讀取src/main/resources下文件的解決,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-04-04關于SpringCloud灰度發(fā)布的實現(xiàn)
這篇文章主要介紹了關于SpringCloud灰度發(fā)布的實現(xiàn),灰度發(fā)布又稱金絲雀發(fā)布,是在系統(tǒng)升級的時候能夠平滑過渡的一種發(fā)布方式,灰度發(fā)布可以保證整體系統(tǒng)的穩(wěn)定,在初始灰度的時候就可以發(fā)現(xiàn)、調整問題,以保證其影響度,需要的朋友可以參考下2023-08-08SpringMVC?RESTFul實體類創(chuàng)建及環(huán)境搭建
這篇文章主要為大家介紹了SpringMVC?RESTFul實體類創(chuàng)建及環(huán)境搭建詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-05-05SpringBoot中實現(xiàn)數(shù)據(jù)字典的示例代碼
這篇文章主要介紹了SpringBoot中實現(xiàn)數(shù)據(jù)字典的示例代碼,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2020-09-09JavaWeb連接數(shù)據(jù)庫MySQL的操作技巧
數(shù)據(jù)庫是編程中重要的一部分,它囊括了數(shù)據(jù)操作,數(shù)據(jù)持久化等各方面。在每一門編程語言中都占有相當大的比例。本次,小編以MySQL為例,使用mvc編程思想,給大家講解下javaweb對數(shù)據(jù)庫的操作2017-02-02springboot使用alibaba的druid數(shù)據(jù)庫連接池錯誤的問題及解決
這篇文章主要介紹了springboot使用alibaba的druid數(shù)據(jù)庫連接池錯誤的問題及解決方案,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-02-02