原文网址:Spring Cloud Gateway--配置路由的方法_IT利刃出鞘的博客-CSDN博客
说明
本文介绍Spring Cloud Gateway配置路由的方法。
路由概述
路由是网关配置的基本组成模块,和Zuul的路由配置模块类似。一个Route模块由一个 ID,一个目标 URI,一组断言和一组过滤器定义。如果断言为真,则路由匹配,目标URI会被访问。
配置文件是:application.yml。
默认情况下Gatway会根据注册中心注册的服务列表, 以注册中心上微服务名为路径创建动态路由进行转发,从而实现动态路由的功能。
application.yml示例
- spring:
- application:
- name: cloud-gateway-gateway
- cloud:
- gateway:
- discovery:
- locator:
- # 开启从注册中心动态创建路由的功能,利用微服务名进行路由
- enabled: true
- # 用小写的请求路径的服务名匹配服务。默认为false(大写)。(因为服务注册时服务名被转成大写)
- lowerCaseServiceId: true
假如直接请求应用时的url是:localhost:8080/findUser(假设应用端口为8080)
则这样配置后请求网关的url是:localhost:9000/user/findUser(假设网关服务端口为9000,应用服务名为user)
application.yml示例
- spring:
- application:
- name: futureGateway
- cloud:
- gateway:
- routes:
- - id: accountServiceRouter # 路由ID,保持唯一
- uri: lb://accountService # 目标服务地址
- predicates: # 断言(路由条件)
- - Path=/account/**
- - id: accountServiceRouter2 # 测试过滤器
- uri: lb://accountService # 目标服务地址
- predicates: # 断言(路由条件)
- - Path=/client/account/**
- filters: # 过滤器
- - StripPrefix=1 # 截去路径中的/client,剩余部分和uri拼接作为地址,数字代表要截去的位数
- - id: emailServiceRouter
- uri: http://127.0.0.1:8201
- predicates:
- - Path=/email/**
id
在一个网关中,id要是唯一的,命名的时候方便区分即可。
uri
请求转发的目标地址,可以以http、https、lb和ws等为前缀。例如:
predicates
断言。通过断言可以设置一组路由条件,可以根据请求方式、请求头、请求参数、请求主机和请求路径等断言进行设置,通常我们使用请求路径进行设置,只要请求地址和Path中的地址匹配,就会将请求转发,多个路径以逗号分隔,例如:
- spring:
- cloud:
- gateway:
- routes:
- - id: path_route
- uri: https://example.org
- predicates:
- - Path=/red/{segment},/blue/{segment}
filters
过滤器。使用过滤器可以在网关转发请求前和接收响应后执行一些操作,例如鉴权、限流等,例如StripPrefix可以去掉客户端请求地址中的若干路径,然后将剩余的路径和uri中的地址拼接后转发。
Filter分两种,GatewayFilter和GlobalFilter,GatewayFilter应用在单个路由上,GlobalFilter应用在全局路由上。因为GlobalFilter可以使所有的路由都生效,所以可以用来实现统一的鉴权、日志记录等功能。
示例配置
- @Configuration
- public class GatewayConfig {
-
- @Bean
- public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
- // 路由构造器
- RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();
-
- // 设置路径
- routes.route("baidu_news_guonei_routh", r -> {
- return r.path("/guonei").uri("http://news.baidu.com/guonei");
- });
- routes.route("baidu_news_guoji_routh", r -> {
- return r.path("/guoji").uri("http://news.baidu.com/guoji");
- });
-
- return routes.build();
- }
- }