Spring Cloud實戰系列(五) - 服務網關Zuul

相關

1. Spring Cloud實戰系列(一) - 服務註冊與發現Eureka

2. Spring Cloud實戰系列(二) - 客戶端調用Rest + Ribbon

3. Spring Cloud實戰系列(三) - 聲明式客戶端Feign

4. Spring Cloud實戰系列(四) - 熔斷器Hystrix

5. Spring Cloud實戰系列(五) - 服務網關Zuul

6. Spring Cloud實戰系列(六) - 分佈式配置中心Spring Cloud Config

7. Spring Cloud實戰系列(七) - 服務鏈路追蹤Spring Cloud Sleuth

8. Spring Cloud實戰系列(八) - 微服務監控Spring Boot Admin

9. Spring Cloud實戰系列(九) - 服務認證受權Spring Cloud OAuth 2.0

10. Spring Cloud實戰系列(十) - 單點登陸JWT與Spring Security OAuth

前言

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與微服務構建》

---

歡迎關注技術公衆號： 零壹技術棧

本賬號將持續分享後端技術乾貨，包括虛擬機基礎，多線程編程，高性能框架，異步、緩存和消息中間件，分佈式和微服務，架構學習和進階等學習資料和文章。