SpringCloud（五）Zuul網關與分散式配置中心

来源:https://www.cnblogs.com/yuanqinnan/archive/2019/09/22/11568787.html
-Advertisement-
Play Games

在 Spring Cloud 微服務系統中，一種常見的負載均衡方式是，客戶端的請求首先經過負載均衡（Ngnix），再到達服務網關（Zuul 集群），然後再到具體的服務。服務統一註冊到高可用的服務註冊中心集群，服務的所有的配置文件由配置服務管理，配置服務的配置文件放在 GIT 倉庫，方便開發人員隨時改 ...


在 Spring Cloud 微服務系統中，一種常見的負載均衡方式是，客戶端的請求首先經過負載均衡（Ngnix），再到達服務網關（Zuul 集群），然後再到具體的服務。服務統一註冊到高可用的服務註冊中心集群，服務的所有的配置文件由配置服務管理，配置服務的配置文件放在 GIT 倉庫，方便開發人員隨時改配置。

一、Zuul

Zuul包含了對請求的路由和過濾兩個最主要的功能： 其中路由功能負責將外部請求轉發到具體的微服務實例上，是實現外部訪問統一入口的基礎而過濾器功能則負責對請求的處理過程進行干預，是實現請求校驗、服務聚合等功能的基礎.

Zuul和Eureka進行整合，將Zuul自身註冊為Eureka服務治理下的應用，同時從Eureka中獲得其他微服務的消息，也即以後的訪問微服務都是通過Zuul跳轉後獲得。Zuul服務最終還是會註冊進Eureka。

總體來說Zuul提供代理、路由、過濾三大功能。

1.1 創建Zuul項目

創建一個spring-cloud-learn-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>com.yuanqinnan</groupId>
        <artifactId>spring-cloud-learn-parent</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>spring-cloud-learn-zuul</artifactId>
    <packaging>jar</packaging>

    <name>spring-cloud-learn-zuul</name>
    <dependencies>
        <!-- Spring Boot Begin -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot End -->

        <!-- Spring Cloud Begin -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <!-- Spring Cloud End -->
    </dependencies>
</project>

新建啟動類ZuulApplication，增加@EnableZuulProxy註解

@SpringBootApplication
@EnableEurekaClient
@EnableZuulProxy
public class ZuulApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
    }
}

application.yml配置如下：

spring:
  application:
    name: spring-cloud-learn-zuul

server:
  port: 8769

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

zuul:
  routes:
    api-a:
      path: /api/a/**
      serviceId: spring-cloud-learn-consumer-dept-ribbon
    api-b:
      path: /api/b/**
      serviceId: spring-cloud-learn-consumer-dept-feign

這個配置文件也很好理解，主要是配置路由：

  • 以 /api/a 開頭的請求都轉發給 spring-cloud-learn-consumer-dept-ribbon 服務

  • 以 /api/b 開頭的請求都轉發給 spring-cloud-learn-consumer-dept-feign 服務

然後再啟動之前的所有項目

打開瀏覽器訪問：http://localhost:8769/api/a/hi?message=HelloZuul 瀏覽器顯示

Hi，your message is :"HelloZuul" i am from port：8763

打開瀏覽器訪問：http://localhost:8769/api/a/hi?message=HelloZuul 瀏覽器顯示

Hi，your message is : HelloZuul i am from port : 8763

1.2 失敗時的回調

由於網路震蕩或者一些未知原因，可能會導致網關調用失敗，這個時候我們需要配置一個網關路由失敗時的回調，繼承FallbackProvider

@Component
public class ConsumerDeptFeignFallbackProvider implements FallbackProvider {

    @Override
    public String getRoute() {
        // ServiceId，如果需要所有調用都支持回退，則 return "*" 或 return null
        return "spring-cloud-learn-consumer-dept-feign";
    }
     /**
     　* 如果請求服務失敗，則返回指定的信息給調用者
     　* @param
     　* @return
       * @date
     　*/
    @Override
    public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
        return new ClientHttpResponse() {
            /**
             * 網關向 api 服務請求失敗了，但是消費者客戶端向網關發起的請求是成功的，
             * 不應該把 api 的 404,500 等問題拋給客戶端
             * 網關和 api 服務集群對於客戶端來說是黑盒
             * @return
             * @throws IOException
             */
            @Override
            public HttpStatus getStatusCode() throws IOException {
                return HttpStatus.OK;
            }

            @Override
            public int getRawStatusCode() throws IOException {
                return HttpStatus.OK.value();
            }

            @Override
            public String getStatusText() throws IOException {
                return HttpStatus.OK.getReasonPhrase();
            }

            @Override
            public void close() {

            }

            @Override
            public InputStream getBody() throws IOException {
                ObjectMapper objectMapper = new ObjectMapper();
                Map<String, Object> map = new HashMap<>();
                map.put("status", 200);
                map.put("message", "無法連接，請檢查您的網路");
                return new ByteArrayInputStream(objectMapper.writeValueAsString(map).getBytes("UTF-8"));
            }

            @Override
            public HttpHeaders getHeaders() {
                HttpHeaders headers = new HttpHeaders();
                // 和 getBody 中的內容編碼一致
                headers.setContentType(MediaType.APPLICATION_JSON_UTF8);
                return headers;
            }
        };
    }
}

1.3 過濾功能

Zuul 不僅僅只是路由，還有很多強大的功能，本節演示一下它的服務過濾功能，比如用在安全驗證方面。

來創建下過濾器功能：只要繼承 ZuulFilter 類併在類上增加 @Component 註解就可以使用服務過濾功能了

@Component
public class LoginFilter extends ZuulFilter {
    private static final Logger logger = LoggerFactory.getLogger(LoginFilter.class);
     /**
      * 配置過濾類型，有四種不同生命周期的過濾器類型
      * 1. pre：路由之前
      * 2. routing：路由之時
      * 3. post：路由之後
      * 4. error：發送錯誤調用
     */
    @Override
    public String filterType() {
        return "pre";
    }
     /**
     　* 配置過濾的順序
     　*/
    @Override
    public int filterOrder() {
        return 0;
    }

     /**
     　* 配置是否需要過濾：true/需要，false/不需要
     　*/
    @Override
    public boolean shouldFilter() {
        return false;
    }
     /**
     　* 過濾器的具體業務代碼
     　* @param
     　*/
    @Override
    public Object run() throws ZuulException {
        RequestContext context = RequestContext.getCurrentContext();
        HttpServletRequest request = context.getRequest();
        logger.info("{} >>> {}", request.getMethod(), request.getRequestURL().toString());
        String token = request.getParameter("token");
        if (token == null) {
            logger.warn("Token is empty");
            context.setSendZuulResponse(false);
            context.setResponseStatusCode(401);
            try {
                context.getResponse().getWriter().write("Token is empty");
            } catch (IOException e) {
            }
        } else {
            logger.info("OK");
        }
        return null;
    }

這裡的四個方法：

  1. filterType：返回一個字元串代表過濾器的類型，在 Zuul 中定義了四種不同生命周期的過濾器類型

    pre：路由之前

    routing：路由之時

    post： 路由之後

    error：發送錯誤調用

  2. filterOrder：過濾的順序

  3. shouldFilter：是否需要過濾，這裡是 true，需要過濾

  4. run：過濾器的具體業務代碼

測試下:http://localhost:8769/api/a/hi?message=HelloZuul 網頁顯示

Token is empty

http://localhost:8769/api/b/hi?message=HelloZuul&token=123 網頁顯示

Hi，your message is :"HelloZuul" i am from port：8763

 

二、分散式配置中心

在分散式系統中，由於服務數量巨多，為了方便服務配置文件統一管理，實時更新，所以需要分散式配置中心組件。在 Spring Cloud 中，有分散式配置中心組件 Spring Cloud Config ，它支持配置服務放在配置服務的記憶體中（即本地），也支持放在遠程 Git 倉庫中。在 Spring Cloud Config 組件中，分兩個角色，一是 Config Server，二是 Config Client。

2.1 Config Server項目

創建項目的方式與之前相同，新建spring-cloud-learn-config項目，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>com.yuanqinnan</groupId>
        <artifactId>spring-cloud-learn-parent</artifactId>
        <version>1.0.0-SNAPSHOT</version>
    </parent>

    <artifactId>spring-cloud-learn-config</artifactId>
    <packaging>jar</packaging>

    <name>spring-cloud-learn-config</name>

    <dependencies>
        <!-- Spring Boot Begin -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot End -->

        <!-- Spring Cloud Begin -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <!-- Spring Cloud End -->
    </dependencies>
</project>

新建啟動項目ConfigApplication，增加@EnableConfigServer註解

@SpringBootApplication
@EnableConfigServer
@EnableEurekaClient
public class ConfigApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConfigApplication.class, args);
    }
}

application.yml 配置文件

spring:
  application:
    name: spring-cloud-learn-config
  cloud:
    config:
      label: master
      server:
        git:
          uri: https://github.com/yuanqinnan/spring-cloud-config
          search-paths: respo
          username:
          password:

server:
  port: 8888

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

這裡註意的地方是埠號不要修改，使用8888，如要修改創建一個bootstrap.properties文件進行修改，原因是 bootstrap 開頭的配置文件會被優先載入和配置，切記。

這裡的配置文件也比較好理解，相關配置說明，如下：

  • spring.cloud.config.label：配置倉庫的分支

  • spring.cloud.config.server.git.uri：配置 Git 倉庫地址（GitHub、GitLab、碼雲 ...）

  • spring.cloud.config.server.git.search-paths：配置倉庫路徑（存放配置文件的目錄）

  • spring.cloud.config.server.git.username：訪問 Git 倉庫的賬號

  • spring.cloud.config.server.git.password：訪問 Git 倉庫的密碼

註意事項：

  • 如果使用 GitLab 作為倉庫的話，git.uri 需要在結尾加上 .git，GitHub 則不用

我們想要測試的話，先在自己的github上新建一個倉庫，並新增respo文件夾（存放配置文件的目錄），然後新增一個配置文件consumer-dept-feign.yml(這個是配置feign項目的)即可，然後我們就可以看看效果：

訪問路徑為：http://localhost:8888/consumer-dept-feign/master 這裡路徑也好理解，這裡的是配合文件名稱加上分支名稱

 

在實際開發過程中，我們一般有三個環境，開發、測試、生產，而我們一般會在配置文件後加尾碼來區分，如consumer-dept-feign-dev.yml，這個時候的訪問路徑就是http://localhost:8888/consumer-dept-feign/dev/master,路徑地址增加環境地址，為了方便測試，再上傳一個consumer-dept-feign-prod.yml，作為正式環境的配置，只修改一下埠號（8766）即可。

這裡看出來，我們的feign項目的配置文件已經換成配置中心的，那現在可以去改造feign，讓他去取配置中心的配置。

2.2 改造Config Client項目

因為我們剛剛上傳了spring-cloud-learn-consumer-dept-feign項目的配置文件，現在拿來做下實踐，第一步還是添加依賴：

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>

啟動類沒有變化，只需修改配置文件：

spring:
  cloud:
    config:
      uri: http://localhost:8888
      name: consumer-dept-feign
      label: master
      profile: dev

我們看到這裡只保留了cloud.config下的相關配置，因為其他所有的配置，我們都可以去雲配置中找，這裡的配置說明如下：

相關配置說明，如下：

  • spring.cloud.config.uri：配置服務中心的網址

  • spring.cloud.config.name：配置文件名稱的首碼

  • spring.cloud.config.label：配置倉庫的分支

  • spring.cloud.config.profile

    ：配置文件的環境標識

    • dev：表示開發環境

    • test：表示測試環境

    • prod：表示生產環境

現在只要能夠啟動feign項目，就說明配置中心生效了，我們啟動一下，一切順利，可以啟動成功。當我們修改 profile為prod時，啟動的就是8766埠。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Java連載33-對象的創建和使用、記憶體分析
    一、創建一個學生類 每個學生都有學號信息，但是每一個學生的學號都是不同的，所以要訪問這個學號必須先創建對象，通過對象去訪問學號信息，學號信息不能直接通過“類”去訪問，所以這種成員變數又被稱為“實例變數” 註意： （1）對象又被稱為實例，實例變數又被稱為對象變數（對象級別的變數） （2）不創建對象，這 ...
  • Docker常用命令小記
    除了基本的docker pull、docker image、docker ps，還有一些命令及參數也很重要，在此記錄下來避免遺忘。 環境信息 以下是本次操作的環境： 1. 操作系統：CentOS Linux release 7.7.1908 2. Docker：19.03.2 假設當前環境正運行著兩 ...
  • PHP開啟目錄引索+fancyindex漂亮目錄瀏覽帶搜索功能
    PHP開啟目錄引索 一. 前言 不知為何對nginx情有獨鍾, 最近練習php, 為了方便寫代碼, 便想要開啟nginx的目錄索引功能, 顯然不如Apache開啟的方便, 幾次嘗試都崩了... 我這個小白確實有點看不懂nginx的配置文件. 不過最後還是成功了, 記錄一下, 萬一哪天忘了, 回來看看 ...
  • 十二.作業難點(有IT大牛路過的可以幫我解答我的疑問?萬分感謝)--轉行的苦逼人
    今天開始改變寫博客風格,其他不多說. 今天題目如下: 我先寫自己的寫程式的方法,先直接看正確完整的代碼直接往下看 一開始看了題目,我發現的規律是"alex"、"name"、"hobby"由多個變成一個 因此我想到了用set集合去重 我是想要把user_list列表的鍵收集起來變成列表,然後通過set ...
  • springboot筆記-使用JSP
    Spring Boot 項目中使用 JSP: 項目結構：需要添加webapp文件夾用來存放目錄 jsp 文件 在配置文件application.properties中指定 jsp 的位置和尾碼。spring.mvc.view.prefix=/WEB-INF/jsp/spring.mvc.view.s ...
  • SpringBoot源碼解析:創建SpringApplication對象實例
    上篇文章 "SpringBoot自動裝配原理解析" 中，我們分析了SpringBoot的自動裝配原理以及 註解的原理，本篇文章則繼續基於上篇文章中的main方法來分析 這個類 點擊 方法一路跟蹤下來，發現首先做的是實例化 對象實例 1. 首先看一下 方法 大抵意思就是根據當前項目中是否存在上方的幾個 ...
  • 採集萬方醫葯方向的期刊+文章+作者信息(數據量千萬級)
    最近將萬方數據的爬取代碼進行了重構，速度大概有10w每小時吧，因為屬於公司項目，代碼暫時就不開源了，所以在這裡先說說思路和一些註意事項吧，順帶吐槽一下萬方。 先上圖： 其實邏輯也蠻簡單的，醫學類的期刊分了16個大類，那麼首先手動將這16大類所對應的唯一id拿下來拼接出該類型的url，然後翻頁請求它就 ...
  • 【C/C++】qsort函數的使用方法和細節
    函數概述 qsort 為quick sort的簡寫，意為快速排序，主要用於對各種數組的排序，在頭文件stdlib.h中。 因為數組的元素可能是任何類型的，甚至是結構或者聯合，所以必須高數函數qsort如何確定兩個數組元素哪一個“更小”，這就需要我們給出比較的規則，即什麼算大，什麼算小。 通過編寫比較 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類