Spring Cloud Gateway替代zuul作為API閘道器
本文非常簡要介紹如何使用Spring Cloud Gateway最API 閘道器（不是使用zuul作為閘道器），關於Spring Cloud Gateway和zuul的效能比較本文不再贅述，基本可以肯定Spring Cloud Finchley版本的gateway比zuul 1.x系列的效能和功能整體要好。
特別提醒：Spring Cloud Finchley版本中，即使你引入了spring-cloud-starter-netflix-zuul，也不是2.0版本的zuul
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-zuul</artifactId> </dependency>
我們的介紹分為3個部分， 第一，pom檔案，第二專案的基本架構，第三原始碼和截圖。
第一，pom檔案
因為使用Eureka作為服務註冊和發現，因此在pom中引入了eureka，各位可根據自己的實際情況修改。
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.yq</groupId> <artifactId>GatewayDemo</artifactId> <version>1.0-SNAPSHOT</version> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.0.0.RELEASE</version> <relativePath/> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Finchley.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-netflix-hystrix --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-hystrix</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- fastjson--> <dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.1.33</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.5</version> </dependency> </dependencies> <repositories> <repository> <id>spring-milestones</id> <name>Spring Milestones</name> <url>https://repo.spring.io/milestone</url> <snapshots> <enabled>false</enabled> </snapshots> </repository> </repositories> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
第二，專案結構
總共有3個專案，
第一個專案是eureka 註冊中心，非常簡單，基本就一個Application類。 埠7700
第二個專案是User service，也非常簡單提供兩個rest api，為了簡略不連線資料，直接在內從中生成一組資料。埠6601
第三個專案就是我們的閘道器。埠6604
目前專案中整合websocket服務配置，本文咱不介紹可直接忽略。
第三，專案程式碼和執行截圖
閘道器的主程式碼
package com.yq; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.boot.SpringApplication; import org.springframework.cloud.client.SpringCloudApplication; import org.springframework.cloud.gateway.route.RouteLocator; import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder; import org.springframework.context.annotation.Bean; import org.springframework.web.reactive.function.BodyInserters; import org.springframework.web.reactive.function.server.RequestPredicates; import org.springframework.web.reactive.function.server.RouterFunction; import org.springframework.web.reactive.function.server.RouterFunctions; import org.springframework.web.reactive.function.server.ServerResponse; @SpringCloudApplication public class APIGatewayApplication { private static final Logger logger = LoggerFactory.getLogger(APIGatewayApplication.class); @Bean public RouteLocator customRouteLocator(RouteLocatorBuilder builder) { return builder.routes() .route(r -> r.path("/baidu") .uri("http://baidu.com:80/") ) .route("websocket_route", r -> r.path("/apitopic1/**") .uri("ws://127.0.0.1:6605")) .route(r -> r.path("/userapi3/**") .filters(f -> f.addResponseHeader("X-AnotherHeader", "testapi3")) .uri("lb://user-service/") ) .build(); } public static void main(String[] args) { SpringApplication.run(APIGatewayApplication.class, args); logger.info(" Start APIGatewayApplication Done"); } }
閘道器的配置檔案application.yml
server:
port: 6604
#服務名
spring:
application:
name: gateway-service
cloud:
gateway:
filter:
remove-non-proxy-headers:
headers:
- dummy
routes:
- id: apiuser
# 重點！/info必須使用http進行轉發，lb代表從註冊中心獲取服務
uri: lb://user-service
predicates:
# 重點！轉發該路徑！,/userapi/**,
- Path=/userapi/**
# http://localhost:6601/userapi/user/users/2, 必須加上StripPrefix=1，否則訪問服務時會帶上userapi
#而不是我們期望的去掉userapi，只保留**部分
filters:
- StripPrefix=1
- id: api2user
uri: lb://user-service
predicates:
- Path=/userapi2/**
filters:
- StripPrefix=1
eureka:
client:
serviceUrl:
defaultZone: http://localhost:7700/eureka/
我們簡要分析分析一下配置檔案
- id: apiuser
# 重點！/info必須使用http進行轉發，lb代表從註冊中心獲取服務
uri: lb://user-service
predicates:
# 重點！轉發該路徑！,/userapi/**,
- Path=/userapi/**
# http://localhost:6601/userapi/user/users/2, 必須加上StripPrefix=1，否則訪問服務時會帶上userapi
#而不是我們期望的去掉userapi，只保留**部分
filters:
- StripPrefix=1
配置了一個路由apiuser， 當路徑（ - Path=/userapi/**），就轉發到服務（lb://user-service），同時把路徑中的userapi這部分去掉（- StripPrefix=1）。
執行效果圖
直接訪問User service
http://localhost:6601/user/users/2
通過閘道器訪問user service
http://localhost:6604/userapi/user/users/2
這裡寫圖片描述
參考文件：
1， http://cloud.spring.io/spring-cloud-static/Finchley/single/spring-cloud.html#_spring_cloud_gateway
2， https://github.com/spring-cloud-samples/spring-cloud-gateway-sample