閘道器路由配置解析
阿新 • • 發佈：2021-08-13
- gateway配置
server: port: 9001 spring: application: name: platform-gateway cloud: gateway: discovery: locator: enabled: true lower-case-service-id: true routes: - id: platform-service111 uri: lb://platform-service predicates: - Path=/platform-service/** - id: platform-redis222 uri: lb://platform-redis predicates: - Path=/platform-redis/** default-filters: # 配置跨域，header去重 - DedupeResponseHeader=Vary Access-Control-Allow-Credentials Access-Control-Allow-Origin, RETAIN_UNIQUE - DedupeResponseHeader=Access-Control-Allow-Origin, RETAIN_FIRST - AddResponseHeader=Access-Control-Allow-Credentials,true eureka: instance: prefer-ip-address: true instance-id: ${spring.cloud.client.ip-address}:${server.port} client: service-url: register-with-eureka: true fetch-registy: true defaultZone: http://172.10.101.123:7001/eureka/
gateway動態路由規則
cloud:
gateway:
discovery:
locator:
enabled: true
lower-case-service-id: true
使用這部分配置即可實現微服務名稱自動進行動態路由配置，不需要再進行routes配置。
gateway的Path路徑匹配規則
routes: - id: platform-service111 uri: lb://platform-service predicates: - Path=/user/**
斷言規則：platform-service-ip:port/user/** = gateway-ip:port/user/**
重點：整合swagger
- 首先需要兩個類:SwaggerResourcesConfig和SwaggerResourceController
@Component @Primary @AllArgsConstructor public class SwaggerResourcesConfig implements SwaggerResourcesProvider { public static final String API_URI = "/v2/api-docs"; private final RouteLocator routeLocator; private final GatewayProperties gatewayProperties; /** * 這個類是核心，這個類封裝的是SwaggerResource，即在swagger-ui.html頁面中頂部的選擇框，選擇服務的swagger頁面內容。 * RouteLocator：獲取spring cloud gateway中註冊的路由 * RouteDefinitionLocator：獲取spring cloud gateway路由的詳細資訊 * RestTemplate：獲取各個配置有swagger的服務的swagger-resources */ @Override public List<SwaggerResource> get() { List<SwaggerResource> resources = new ArrayList<>(); List<String> routes = new ArrayList<>(); //取出gateway的route routeLocator.getRoutes().subscribe(route -> routes.add(route.getId())); //結合配置的route-路徑(Path)，和route過濾，只獲取有效的route節點 gatewayProperties.getRoutes().stream().filter(routeDefinition -> routes.contains(routeDefinition.getId())) .forEach(routeDefinition -> routeDefinition.getPredicates().stream() .filter(predicateDefinition -> ("Path").equalsIgnoreCase(predicateDefinition.getName())) .forEach(predicateDefinition -> resources.add(swaggerResource(routeDefinition.getId(), predicateDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0") .replace("/**", API_URI))))); return resources; } private SwaggerResource swaggerResource(String name, String location) { SwaggerResource swaggerResource = new SwaggerResource(); swaggerResource.setName(name); swaggerResource.setLocation(location); swaggerResource.setSwaggerVersion("3.0.0"); return swaggerResource; } }
@RestController
@RequestMapping("/swagger-resources")
public class SwaggerResourceController {
@Autowired
private SwaggerResourcesConfig swaggerResources;
@Autowired(required = false)
private SecurityConfiguration securityConfiguration;
@Autowired(required = false)
private UiConfiguration uiConfiguration;
@Autowired
public SwaggerResourceController(SwaggerResourcesConfig swaggerResources) {
this.swaggerResources = swaggerResources;
}
@GetMapping("/configuration/security")
public Mono<ResponseEntity<SecurityConfiguration>> securityConfiguration() {
return Mono.just(new ResponseEntity<>(
Optional.ofNullable(securityConfiguration).orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK));
}
@GetMapping("/configuration/ui")
public Mono<ResponseEntity<UiConfiguration>> uiConfiguration() {
return Mono.just(new ResponseEntity<>(
Optional.ofNullable(uiConfiguration).orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK));
}
@GetMapping("")
public Mono<ResponseEntity> swaggerResources() {
return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK)));
}
}
- 通過SwaggerResourcesConfig 知道，我們需要再gateway中配置routes
routes:
- id: platform-service111
uri: lb://platform-service
predicates:
- Path=/platform-service/**
- id: platform-redis222
uri: lb://platform-redis
predicates:
- Path=/platform-redis/**
參考SwaggerResourcesConfig 中的配置，可以知道id是swagger-ui.html頁面中頂部的選擇框的內容。
當我們切換選擇框中的id時，會自動進行路由匹配。在這裡又涉及到一個微服務進行動態路由轉發的問題：
- 閘道器請求的路徑為
http://localhost:9001/platform-service/v2/api-docs，但實際上訪問的是http://localhost:8001/v2/api-docs，這裡是localhost:9001/platform-service/覆蓋了localhost:8001/。
我猜想這是因為我們在前面通過enabled: true配置了動態路由轉發，swagger配置類中結合了Path的路徑拼接成了/localhost:9001/platform-service/v2/api-docs。但是這裡並沒有走uri+predicates的路徑，所以沒有出現路徑錯誤的問題。（所以這裡的route是針對swagger的路由設定的，不是gateway動態路由轉發的路由配置）
(上圖中顯示的BaseURL說明是走的 locator 路由) - 還有一種情況是：比如我們不通過閘道器，直接訪問微服務的swagger地址為：
localhost:8001/ps/v2/api-docs；然後我們配置檔案中這樣寫：
routes:
- id: platform-service111
uri: lb://platform-service
predicates:
- Path=/ps/**
(上圖中顯示的BaseURL說明是走的 routes 路由)
根據路由規則，localhost:9001/ps/** = localhost:8001/ps/** 此時就是隻是9001掩蓋了8001。
swagger的配置類幫我們拼接了路徑：/ps/v2/api-docs
因為這裡路徑中不是http://localhost:9001/platform-service/，自然不會進行動態路由轉發，所有就只是簡單的走uri+predicates匹配規則。
但是第一種情況是因為開啟了動態路由配置，剛好Path的斷言規則恰好是它的微服務名稱
究極總結：
- 配置routes是為了方便swagger選擇，通過id進行切換
- 由於配置了 locator 會自動進行微服務名進行路由，所以當斷言為
- Path=/platform-service/**，swagger配置類會進行路徑拼接，拼接成http://localhost:9001/platform-service/**，這個時候呢，它走的就不是routes定義的路由匹配了，它走的是 locator 開啟的自動根據微服務名進行路由匹配了。 - 當斷言為
- Path=/ps/**，swagger配置類拼接的成的路徑為http://localhost:9001/ps/**，因為此時9001跟的不是微服務名稱，不能觸發 locator 的自動路由匹配，這個時候呢，它走的就不是 locator了，它走的是routes開啟的路由匹配。
參考：Spring Cloud Gateway整合Swagger聚合微服務系統API文件(非Zuul) 這篇文章和我的理解又出入，不能理解- Path=/admin/**，他的微服務下面根本沒有admin這個路徑，怎麼匹配的到呢