相關
前言
Zuul 是 Netflix 開源的一個 API Gateway 伺服器, 本質上是一個基於 Servlet 的 Web 應用。在微服務框架 Spring Cloud 中，Zuul 被作為 服務的閘道器，負責對 請求 進行一些 預處理，比如：安全驗證、動態路由、負載分配 等等。
正文
1. 路由閘道器
在前面幾篇的基礎上，新建一個 service-zuul 的專案模組，配置 pom.xml 如下：
<?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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>io.github.ostenant.springcloud</groupId>
<artifactId>service-zuul</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>service-zuul</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Dalston.SR1</spring-cloud.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zuul</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>${spring-cloud.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
複製程式碼在應用程式啟動類上，使用 註解 @EnableZuulProxy 開啟 路由閘道器：
@EnableZuulProxy
@EnableEurekaClient
@SpringBootApplication
public class ServiceZuulApplication {
public static void main(String[] args) {
SpringApplication.run(ServiceZuulApplication.class, args);
}
}
複製程式碼在 application.yml 檔案中配置 URL 字首和 服務 的對映關係。首先指定 服務註冊中心 的地址為 http://localhost:8761/eureka/，服務的 埠號 為 8769。服務名 為 service-zuul，以 /api-a/ 為 字首 的請求都轉發給 service-feign 服務，以 /api-b/ 為 字首 的請求都轉發給 service-ribbon 服務。
server:
port: 8769
spring:
application:
name: service-zuul
client:
service-url:
defaultZone: http://localhost:8761/eureka/
zuul:
routes:
api-a:
path: /api-a/**
serviceId: service-feign
api-b:
path: /api-b/**
serviceId: service-ribbon
複製程式碼按順序依次執行 eureka-server、service-hi、service-ribbon、service-feign、service-zuul 幾個應用，其中在 8762 和 8763 埠 啟動兩個 service-hi 服務例項。
訪問 http://localhost:8769/api-a/hi?name=zuul 兩次，服務端返回資料如下：
Hi zuul, I am from port: 8763
Hi zuul, I am from port: 8762
這說明 Zuul 起到了 路由 的作用。如果某個 服務 存在 多個例項，Zuul 會結合 Ribbon 做 負載均衡，將請求 均分並路由 到不同的 服務例項。
2. 配置過濾器
Zuul 不僅只作為 路由，並且提供 過濾功能，包括一些 安全驗證。繼續改造專案，增加一個 Zuul 提供的過濾器。
@Component
public class MyFilter extends ZuulFilter {
private Logger logger = LoggerFactory.getLogger(getClass());
@Override
public String filterType() {
return "pre";
}
@Override
public int filterOrder() {
return 0;
}
@Override
public boolean shouldFilter() {
return true;
}
/**
* 過濾器的具體邏輯
*/
@Override
public Object run() {
RequestContext ctx = RequestContext.getCurrentContext();
HttpServletRequest request = ctx.getRequest();
logger.info(String.format("%s >> %s", request.getMethod(),
request.getRequestURL().toString()));
Object accessToken = request.getParameter("token");
if (accessToken == null) {
log.warn("token is empty");
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
try {
ctx.getResponse().getWriter().write("token is empty");
} catch (Exception e) {
logger.error(e);
return null;
}
}
return null;
}
}
複製程式碼filterType() 方法表示 過濾器 的型別：
-
pre：路由發生之前；
-
routing：路由發生時；
-
post：路由發生之後；
-
error：傳送錯誤呼叫時。
訪問 http://localhost:8769/api-b/hi?name=zuul，服務端返回的響應資料如下：
token is empty
訪問 http://localhost:8769/api-b/hi?name=zuul&token=123 兩次，服務端返回的響應資料如下：
Hi zuul, I am from port: 8763
Hi zuul, I am from port: 8762
3. 配置API前戳版本號
在上面 Zuul 工程 application.yml 的基礎上增加一條配置 zuul.prefix: /v1，然後重啟應用，訪問 http://localhost:8769/v1/api-b/hi?name=mark&token=123 即可。
4. 配置熔斷器
在 Zuul 的基礎上實現 熔斷功能 很簡單，類似實現 過濾器 的步驟，只需要實現 ZuulFallbackProvider 介面即可，程式碼如下：
@Component
public class MyFallbackProvider implements ZuulFallbackProvider {
@Override
public String getRoute() {
return "service-feign";
}
@Override
public ClientHttpResponse fallbackResponse() {
return new ClientHttpResponse() {
@Override
public HttpStatus getStatusCode() throws IOException {
return HttpStatus.OK;
}
@Override
public int getRawStatusCode() throws IOException {
return 200;
}
@Override
public String getStatusText() throws IOException {
return "OK";
}
@Override
public void close() {
}
@Override
public InputStream getBody() throws IOException {
return new ByteArrayInputStream("Fallback method is invoked!".getBytes());
}
@Override
public HttpHeaders getHeaders() {
HttpHeaders httpHeaders = new HttpHeaders();
httpHeaders.setContentType(MediaType.APPLICATION_JSON);
return httpHeaders;
}
};
}
}
複製程式碼-
getRoute()：指定 熔斷器 作用於哪些 服務；
-
fallbackResponse()：指定 熔斷 時返回的響應資料。
重新啟動 service-zuul 應用，並關閉所有的 service-hi 的 服務例項，在瀏覽器上訪問 http://localhost:8769/v1/api-a/hi?name=mark&token=123，服務端返回的響應資料如下：
Fallback method is invoked!
如果需要所有的 路由服務 都加上 熔斷功能，只需要在 getRoute() 方法上返回 “*” 的 萬用字元 即可。
5. Zuul的常見使用方式
Zuul 採用的是 同步步阻塞模型，效能比 Nginx 差，由於 Zuul 和其他 Netflix 元件 相互配合、無縫整合，Zuul 很容易就能實現 負載均衡、智慧路由 和 熔斷器 等功能。在大多數情況下，Zuul 都是以 叢集 的形式部署。
-
對不同的 終端使用者，使用不同的
Zuul來進行 路由，例如 移動端 共用一個Zuul閘道器例項，Web端用另一個Zuul閘道器例項，其他的 客戶端 用另一個Zuul例項進行路由。 -
另外一種常見的 叢集部署方式 就是通過
Nginx和Zuul相互結合來做 負載均衡。
參考
- 方誌朋《深入理解Spring Cloud與微服務構建》
歡迎關注技術公眾號： 零壹技術棧
本帳號將持續分享後端技術乾貨，包括虛擬機器基礎，多執行緒程式設計，高效能框架，非同步、快取和訊息中介軟體，分散式和微服務，架構學習和進階等學習資料和文章。