springcloud微服務系列教程 (九) 服務網關組件Zuul

前言

經過前幾篇教程的介紹,咱們基本上認識了構建一個微服務系統所須要的組件,經過這些組件的結合,咱們已經能夠搭建一個較爲簡略的微服務系統了,好比下面的架構圖:
這裏寫圖片描述
能夠看出,該系統架構圖包含了服務註冊中心eureka-server做爲服務註冊中心,config-server做爲配置中心獲取遠程Git地址的配置文件信息,在服務的請求處還作了負載均衡,服務之間作了集羣分佈,實現了高可用,服務之間還能夠實現相互調用,因而可知,一個簡易的微服務系統就搭建成了。java

引出Zuul

上面的架構已經包含了微服務系統的基礎功能,可是仍有不足之處:
首先是服務路由的不肯定性,在以前的學習中,咱們經過restTemplate+ribbon 以及 feign客戶端的方式實現了負載均衡,能夠實現對高可用服務的消費,但那種直接基於服務名來調用的負載處理並不徹底,咱們須要有一個更強大的網關控制工具。
其次是缺少校驗功能,當咱們須要對一個即有的集羣內訪問接口,實現外部服務訪問時,咱們不得不經過在原有接口上增長校驗邏輯,這樣跟服務之間就存在耦合了,不符合開發的宗旨。
針對上述的不足之處,spring cloud 提供了 Zuul組件來加以完善。
Zuul的主要功能是路由轉發和過濾器。路由功能是微服務的一部分,好比/api/user轉發到到user服務,/api/shop轉發到到shop服務。zuul默認和Ribbon結合實現了負載均衡的功能,加入了Zuul後的微服務架構將變得更加完善,架構圖以下:
這裏寫圖片描述
下面用實例帶你們領略Zuul的魅力。git

建立工程

在建立Zuul工程以前,咱們須要先引用以前的工程,讀者有疑問能夠參考https://blog.csdn.net/yeyazhishang/article/details/81392085github

在原有的工程建立新新工程zuul-service,其pom文件以下:web

<?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.yeya</groupId>
    <artifactId>zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

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

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.4.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>Finchley.SR1</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-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-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>

在程序的啓動類上加入註解 @EnableDiscoveryClient 和 @EnableZuulProxy,開啓服務註冊和服務網關的功能,代碼以下:spring

@SpringBootApplication
@EnableDiscoveryClient
@EnableZuulProxy
public class ZuulApplication { 
 
   

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

在配置文件application.yml配置以下信息:sql

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:1111/eureka/
server:
  port: 1116
spring:
  application:
    name: zuul-service
zuul:
  routes:
    api-a:
      path: /clientapi/** serviceId: eureka-client api-b: path: /ribbonapi/** serviceId: eureka-ribbon

其中,eureka.client.serviceUrl.defaultZone是服務註冊中心的地址,服務的名稱爲zuul-service,以/clientapi/ 開頭的請求都轉發給eureka-client服務;以/ribbonapi/開頭的請求都轉發給eureka-ribbon服務;apache

配置好信息後,依次啓動這幾個工程,記得eureka-client要改端口 (1112,1113) 啓動兩次,而後打開瀏覽器,屢次訪問 http://localhost:1116/clientapi/hello,會發現瀏覽器反覆顯示api

hello : 1112 
hello : 1113

一樣,屢次訪問 http://localhost:1116/ribbonapi/consumer ,瀏覽器會顯示相同的結果,說明zuul的確起到了路由轉發的做用。瀏覽器

服務過濾

zuul除了能作路由轉發以外,還能實現過濾做用,作一些安全的驗證功能,下面咱們來改造一下zuul-service工程。在工程中建立一個過濾器繼承ZuulFilter ,並實現類中的方法,具體實現以下功能;安全

若是請求地址中有帶token,那麼過濾器就不作攔截,不然攔截並輸出 token is empty,下面是具體代碼:

@Component
public class MyFilter extends ZuulFilter { 
 
   
    @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();
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            ctx.setSendZuulResponse(false);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            }catch (Exception e){}

            return null;
        }
        return null;
    }
}

filterType:返回一個字符串表明過濾器的類型,在zuul中定義了四種不一樣生命週期的過濾器類型,具體以下:

  • pre:路由以前
  • routing:路由之時
  • post: 路由以後
  • error:發送錯誤調用
  • filterOrder:過濾的順序
  • shouldFilter:這裏能夠寫邏輯判斷,是否要過濾,本文true,永遠過濾。
  • run:過濾器的具體邏輯。可用很複雜,包括查sql,nosql去判斷該請求到底有沒有權限訪問。

寫好代碼後,重啓服務,訪問 http://localhost:1116/ribbonapi/consumer ,發現瀏覽器返回

token is empty

加上參數token,從新訪問 http://localhost:1116/ribbonapi/consumer?token=11,發現瀏覽器正常輸出

hello : 1112 
hello : 1113

至此,zuul的過濾工程成功實現。

總結

zuul做爲微服務系統的服務網關,起到了相當重要的做用,因此,通常來講,在生產上的微服務系統中,zuul服務須要作集羣分佈,避免服務掛了網關失效的狀況。

本文源碼地址:

https://github.com/Taoxj/SpringCloudDemo/tree/master/zuul

本文分享 CSDN - 鄙人薛某。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索