SpringCloud - （五）路由網關（Zuul）

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

在Spring Cloud微服務系統中，一種常見的負載均衡方式是，用戶端的請求首先經過負載均衡（zuul、Ngnix），再到達服務網關（zuul叢集），然後再到具體的服。，服務統一注冊到高可用的服務注冊中心叢集，服務的所有的配置檔案由配置服務管理（下一篇文章講述），配置服務的配置檔案放在git倉庫，友善開發人員随時改配置。

Zuul簡介

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

建立Ahut-Service-Zuul項目

新建立一個工程Ahut-Service-Zuul，建立過程和Ahut-Eureka-Client-One一樣

項目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>

    <groupId>com.ahut</groupId>
    <artifactId>service-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>service-zuul</name>
    <description>service zuul</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.12.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Edgware.SR3</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <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-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，開啟zuul的功能：

package com.ahut;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

/**
 * @author cheng
 * @className: ServiceZuulApplication
 * @description: zuul proxy
 * @dateTime
@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ServiceZuulApplication

    public static void main(String[] args) {
        SpringApplication.run(ServiceZuulApplication.class, args);
    }
}

配置檔案application.properties

# 配置伺服器端口
server.port=8950
# spring項目名稱
spring.application.name=AHUT-SERVICE-ZUUL
# 注冊中心url
eureka.client.service-url.defaultZone=http://localhost:8900/eureka/
# 路由網關
# /api-ribbon/**請求路徑的轉發給AHUT-SERVICE-RIBBON服務
zuul.routes.api-ribbon.path=/api-ribbon/**
zuul.routes.api-ribbon.serviceId=AHUT-SERVICE-RIBBON
# /api-feign/**請求路徑的轉發給AHUT-SERVICE-FEIGN服務
zuul.routes.api-feign.path=/api-feign/**
zuul.routes.api-feign.serviceId=AHUT-SERVICE-FEIGN

說明：

以/api-ribbon/ 開頭的請求都轉發給AHUT-SERVICE-RIBBON服務
以/api-feign/開頭的請求都轉發給AHUT-SERVICE-FEIGN服務

開啟項目：

Ahut-Eureka-Server（注冊中心）
Ahut-Eureka-Client-One（AHUT-EUREKA-CLIENT服務一）
Ahut-Service-Feign（AHUT-SERVICE-FEIGN服務消費者）
Ahut-Service-Ribbon（AHUT-SERVICE-RIBBON服務消費者）
Ahut-Service-Zuul（AHUT-SERVICE-ZUUL路由網關）

通路eureka：

通路 http://localhost:8950/api-ribbon/v1/hello

請求轉發到AHUT-SERVICE-RIBBON服務

通路 http://localhost:8950/api-feign/v1/hello

請求轉發到AHUT-SERVICE-FEIGN服務

說明zuul路由網關已經生效

此時的項目架構

服務過濾

zuul不僅隻是路由，并且還能過濾，做一些安全驗證。繼續改造工程。

建立過濾器

package com.ahut.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

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

/**
 * @author cheng
 * @className: MyFilter
 * @description: 自定義過濾器
 * @dateTime
@Component
public class MyFilter extends ZuulFilter

    /**
     * @description: 傳回一個字元串代表過濾器的類型
     * @author cheng
     * @dateTime
    @Override
    public String filterType() {
        return "pre";
    }

    /**
     * @description: 過濾的順序
     * @author cheng
     * @dateTime
    @Override
    public int filterOrder() {
        return 0;
    }

    /**
     * @description: 這裡可以寫邏輯判斷，是否要過濾，本文true,永遠過濾。
     * @author cheng
     * @dateTime
    @Override
    public boolean shouldFilter() {
        return true;
    }

    /**
     * @description: 過濾器的具體邏輯。可用很複雜，包括查sql，nosql去判斷該請求到底有沒有權限通路。
     * @author cheng
     * @dateTime
    @Override
    public Object run() {
        RequestContext context = RequestContext.getCurrentContext();
        // 擷取request
        HttpServletRequest request = context.getRequest();
        // 擷取token
        String token = request.getParameter("token");
        if (token == null) {
            context.setSendZuulResponse(false);
            context.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
            Writer writer = null;
            try {
                // 擷取輸出流
                writer = context.getResponse().getWriter();
                writer.write("token is empty");
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                if (writer != null) {
                    try {
                        // 關閉流
                        writer.close();
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }
            }
        }
        return null;
    }

}

方法說明：

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

pre：路由之前

routing：路由之時

post：路由之後

error：發送錯誤調用
filterOrder：過濾的順序
shouldFilter：這裡可以寫邏輯判斷，是否要過濾，本文true表示永遠過濾
run：過濾器的具體邏輯。可用很複雜，包括查sql，nosql去判斷該請求到底有沒有權限通路

不帶token通路 http://localhost:8950/api-ribbon/v1/hello

帶token通路 http://localhost:8950/api-feign/v1/hello?token=token

SpringCloud - （五）路由網關（Zuul）

Zuul簡介

建立Ahut-Service-Zuul項目

此時的項目架構

服務過濾

繼續閱讀

基于Springboot+VUE+Mysql的大學生校園疫情防控管理系統

Using MessageConverter

馴服爛代碼_C＃中的馴服配置

Spring Cloud整合Sleuth，當請求完成後，Zipkin沒有鍊路資訊

JAVA自學之路——馬士兵

Rabbitmq指令行手動建立隊列

整合 Spring 開發架構及服務端技術

SSM整合02---Spring-SpringMVC層一、添加web架構支援二、web.xml三、spring-mvc.xml

SSM架構（二）------------表現層的SpringMVC

Intellij idea基于Maven 的SSM 架構整合

Spring資料和Redis

SpringMVC的啟動過程源碼分析1 SpringMVC 配置XML的方式啟動2 SpringMVC純注解模式啟動

Java Spring 架構

sleuth鍊路追蹤

SpringCloud微服務（四）之ribbon筆記ribbon是什麼？入門案例自定義均衡負載算法

nginx location中斜線的位置的重要性