Spring Cloud (五)：路由網關（Zuul）

在微服務架構中，需要幾個基礎的服務治理元件，包括服務注冊與發現、服務消費、負載均衡、斷路器、智能路由、配置管理等，由于這幾個基礎元件互相協作，共同組建了一個簡單的微服務系統。一個簡單的微服務系統的如下：

注：服務A 與 服務B 同樣可以互相調用，且配置服務也是注冊到服務注冊中心的。

在SpringCloud 微服務中，一種常見的負載均衡方式是：用戶端的請求首先經過負載均衡（zuul、Nginx）–服務網關（zuul叢集）–具體的服務。服務統一注冊到 服務注冊中心叢集，服務所有的配置檔案由配置服務管理，配置服務的配置檔案放在Git倉庫，友善開發人員随時配置。

一、Zuul 簡介

Zuul 的主要功能是路由轉發和過濾器。路由功能是微服務的一部分，比如 /api/user 轉發到user服務，/api/shop轉發到shop服務。zuul預設和ribbon結合實作了負載均衡的功能。

zuul有以下功能：

• Authentication
• Insights
• Stress Testing
• Canary Testing
• Dynamic Routing
• Service Migration
• Load Shedding
• Security
• Static Response handling
• Static Response handling

二、準備工作

繼續上一節的工程，在原有工程上建立一個新的工程。

三、建立一個 新工程 eureka-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.0http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.lbh</groupId>
        <artifactId>eurekademo</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.lbh</groupId>
    <artifactId>eureka-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>eureka-zuul</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.RC2</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            <version>2.0.0.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
            <version>2.0.0.RELEASE</version>
        </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>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
        </repository>
    </repositories>

</project>
           

入口類中加入注解 @EnableZuulProxy, 開啟zuul功能：

@EnableZuulProxy   // 開啟zuul功能
@EnableEurekaClient
@EnableDiscoveryClient
@SpringBootApplication
public class EurekaZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(EurekaZuulApplication.class, args);
        System.out.println("==============eureka-zuul 啟動成功=================");
    }

}
           

加上配置檔案 application.yml ：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

server:
  port: 8769

spring:
  application:
    name: eureka-zuul

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: eureka-ribbon
    api-b:
      path: /api-b/**
      serviceId: eureka-feign
           

首先制定注冊中心的位址為：http://localhost:8761/eureka/，服務名為 eureka-zuul，以 /api-a/ 的請求都轉發給 eureka-ribbon，以 /api-b/ 的請求都轉發給 eureka-feign。

依次運作五個工程，打開浏覽器通路：http://localhost:8769/api-a/hi?name=lbh ,顯示： hi lbh ,i am from port:8762

打開浏覽器通路：http://localhost:8769/api-b/hi?name=zm ,顯示： hi zm ,i am from port:8762

此時，zuul起到作用了。

四、服務過濾

zuul 不僅隻是路由，還能過濾，做一些安全驗證之類的。建立一個過濾器

package com.lbh.eurekazuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
* Created by Advancer on 2019/1/21 10:24.
* auth: lbh
*/

@Component
public class MyFilter extends ZuulFilter {

    private static Logger log = LoggerFactory.getLogger(MyFilter.class);

    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        log.info(String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString()));
        Object accountToken = request.getParameter("token");
        if (null == accountToken) {
            log.warn("token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        log.info("ok");
        return null;
    }
}
           

filterType: 傳回一個字元串代表過濾器的類型，在zuul中定義了四種不同生命周期的過濾器類型，具體如下：

• pre: 路由之前
• routing: 路由之時
• post：路由之後

• error： 發送錯誤調用

  filterOrder： 過濾器的順序

  shouldFilter: 這裡可以寫邏輯判斷，是否要過濾，true為 永遠過濾。

  run: 過濾器的具體邏輯。可以用很複雜，包括查sql, nosql 去判斷該請求到底有沒有權限通路。

此時 通路：http://localhost:8769/api-a/hi?name=lbh : 顯示 token is empty

通路：http://localhost:8769/api-a/hi?name=lbh&token=11 : 顯示 hi lbh ,i am from port:8762

代碼下載下傳位址：

https://github.com/JavaAdvancer/eurekademo
           

文章參考資料：

https://www.fangzhipeng.com/springcloud/2018/08/30/sc-f5-zuul/