服務網關zuul之一：入門介紹

阿新 • • 發佈：2017-09-15

cse 服務註冊總結測試的 ext 消費簡單的 ase 功能

通過之前幾篇Spring Cloud中幾個核心組件的介紹，我們已經可以構建一個簡略的（不夠完善）微服務架構了。比如下圖所示：

技術分享

我們使用Spring Cloud Netflix中的Eureka實現了服務註冊中心以及服務註冊與發現；而服務間通過Ribbon或Feign實現服務的消費以及均衡負載；通過Spring Cloud Config實現了應用多環境的外部化配置以及版本管理。為了使得服務集群更為健壯，使用Hystrix的融斷機制來避免在微服務架構中個別服務出現異常時引起的故障蔓延。

在該架構中，我們的服務集群包含：內部服務Service A和Service B，他們都會註冊與訂閱服務至Eureka Server，而Open Service是一個對外的服務，通過均衡負載公開至服務調用方。本文我們把焦點聚集在對外服務這塊，這樣的實現是否合理，或者是否有更好的實現方式呢？

先來說說這樣架構需要做的一些事兒以及存在的不足：

首先，破壞了服務無狀態特點。為了保證對外服務的安全性，我們需要實現對服務訪問的權限控制，而開放服務的權限控制機制將會貫穿並汙染整個開放服務的業務邏輯，這會帶來的最直接問題是，破壞了服務集群中REST API無狀態的特點。從具體開發和測試的角度來說，在工作中除了要考慮實際的業務邏輯之外，還需要額外可續對接口訪問的控制處理。
其次，無法直接復用既有接口。當我們需要對一個即有的集群內訪問接口，實現外部服務訪問時，我們不得不通過在原有接口上增加校驗邏輯，或增加一個代理調用來實現權限控制，無法直接復用原有的接口。

面對類似上面的問題，我們要如何解決呢？下面進入本文的正題：服務網關！

為了解決上面這些問題，我們需要將權限控制這樣的東西從我們的服務單元中抽離出去，而最適合這些邏輯的地方就是處於對外訪問最前端的地方，我們需要一個更強大一些的均衡負載器，它就是本文將來介紹的：服務網關。

服務網關是微服務架構中一個不可或缺的部分。通過服務網關統一向外系統提供REST API的過程中，除了具備服務路由、均衡負載功能之外，它還具備了權限控制等功能。Spring Cloud Netflix中的Zuul就擔任了這樣的一個角色，為微服務架構提供了前門保護的作用，同時將權限控制這些較重的非業務邏輯內容遷移到服務路由層面，使得服務集群主體能夠具備更高的可復用性和可測試性。

下面我們通過實例例子來使用一下Zuul來作為服務的路有功能。

準備工作

在使用Zuul之前，我們先構建一個服務註冊中心、以及兩個簡單的服務，比如：我構建了一個service-A，一個service-B。然後啟動eureka-server和這兩個服務。通過訪問eureka-server，我們可以看到service-A和service-B已經註冊到了服務中心。

compute-service：見《服務註冊發現Eureka之一：Spring Cloud Eureka的服務註冊與發現》

1 主啟動程序：

package com.dxz.service;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class SCserviceAApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SCserviceAApplication.class).web(true).run(args);
    }
}

2service類

package com.dxz.service.controler;

import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ServiceAController {
    private final Logger logger = Logger.getLogger(getClass());
    @Autowired
    private DiscoveryClient client;

    @RequestMapping(value = "/add", method = RequestMethod.GET)
    public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
        ServiceInstance instance = client.getLocalServiceInstance();
        Integer r = a + b;
        logger.info("/add, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
        return r;
    }
}

3配置信息

spring.application.name=ServiceA
server.port=2226
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

service-B：新建maven工程SCserviceB

1 主啟動程序：

package com.dxz.service;

import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

@EnableDiscoveryClient
@SpringBootApplication
public class SCserviceBApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(SCserviceBApplication.class).web(true).run(args);
    }
}

2service服務類

package com.dxz.service.controler;

import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ServiceBController {
    private final Logger logger = Logger.getLogger(getClass());
    @Autowired
    private DiscoveryClient client;

    @RequestMapping(value = "/minus", method = RequestMethod.GET)
    public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
        ServiceInstance instance = client.getLocalServiceInstance();
        Integer r = a - b;
        logger.info("/minus, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
        return r;
    }
}

3配置信息

spring.application.name=ServiceB
server.port=2227
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

技術分享

如果您還不熟悉如何構建服務中心和註冊服務，請先閱讀《Spring Cloud構建微服務架構（一）服務註冊與發現》。

如果您不想自己動手準備，可以從這裏獲取示例代碼：http://git.oschina.net/didispace/SpringBoot-Learning

開始使用Zuul

引入依賴spring-cloud-starter-zuul、spring-cloud-starter-eureka，如果不是通過指定serviceId的方式，eureka依賴不需要，但是為了對服務集群細節的透明性，還是用serviceId來避免直接引用url的方式吧。

<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.dxz</groupId>
    <artifactId>SCzull</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.3.5.RELEASE</version>   <!--配合spring cloud版本 -->
        <relativePath /> <!-- lookup parent from repository -->
    </parent>
    <properties>
        <!--設置字符編碼及java版本 -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
            <version>1.2.6.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
            <version>1.2.6.RELEASE</version>
        </dependency>
    </dependencies>
    
    <!--依賴管理，用於管理spring-cloud的依賴 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-parent</artifactId>
                <version>Brixton.SR3</version>   <!--官網為Angel.SR4版本，但是我使用的時候總是報錯 -->
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

package com.dxz;應用主類使用@EnableZuulProxy註解開啟Zuul

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

@EnableZuulProxy
@SpringCloudApplication
public class SCzullApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCzullApplication.class).web(true).run(args);
    }
}

application.properties中配置Zuul應用的基礎信息，如：應用名、服務端口等。這裏用了@SpringCloudApplication註解，之前沒有提過，通過源碼我們看到，它整合了@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker，主要目的還是簡化配置。這幾個註解的具體作用這裏就不做詳細介紹了，之前的文章已經都介紹過。

1 2	spring.application.name=api-gateway server.port=5555

Zuul配置

完成上面的工作後，Zuul已經可以運行了，但是如何讓它為我們的微服務集群服務，還需要我們另行配置，下面詳細的介紹一些常用配置內容。

服務路由

通過服務路由的功能，我們在對外提供服務的時候，只需要通過暴露Zuul中配置的調用地址就可以讓調用方統一的來訪問我們的服務，而不需要了解具體提供服務的主機信息了。

在Zuul中提供了兩種映射方式：

通過url直接映射，我們可以如下配置：

1 2 3

# routes to url zuul.routes.api-a-url.path=/api-a-url/** zuul.routes.api-a-url.url=http://localhost:2222/

該配置，定義了，所有到Zuul的中規則為：/api-a-url/**的訪問都映射到http://localhost:2222/上，也就是說當我們訪問http://localhost:5555/api-a-url/add?a=1&b=2的時候，Zuul會將該請求路由到：http://localhost:2222/add?a=1&b=2上。

其中，配置屬性zuul.routes.api-a-url.path中的api-a-url部分為路由的名字，可以任意定義，但是一組映射關系的path和url要相同，下面講serviceId時候也是如此。

通過url映射的方式對於Zuul來說，並不是特別友好，Zuul需要知道我們所有為服務的地址，才能完成所有的映射配置。而實際上，我們在實現微服務架構時，服務名與服務實例地址的關系在eureka server中已經存在了，所以只需要將Zuul註冊到eureka server上去發現其他服務，我們就可以實現對serviceId的映射。例如，我們可以如下配置：

spring.application.name=api-gateway
server.port=5555



zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId=serviceA
zuul.routes.api-b.path=/api-b/**
zuul.routes.api-b.serviceId=serviceB
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

針對我們在準備工作中實現的兩個微服務service-A和service-B，定義了兩個路由api-a和api-b來分別映射。另外為了讓Zuul能發現service-A和service-B，也加入了eureka的配置。

接下來，我們將eureka-server、service-A、service-B以及這裏用Zuul實現的服務網關啟動起來，在eureka-server的控制頁面中，我們可以看到分別註冊了service-A、service-B以及api-gateway

技術分享

嘗試通過服務網關來訪問service-A和service-B，根據配置的映射關系，分別訪問下面的url

http://localhost:5555/api-a/add?a=1&b=2：通過serviceId映射訪問service-A中的add服務

技術分享

http://localhost:5555/api-b/add?a=1&b=2：通過serviceId映射訪問service-B中的add服務

技術分享

http://localhost:5555/api-a-url/add?a=1&b=2：通過url映射訪問service-A中的add服務

我測試訪問不了。

推薦使用serviceId的映射方式，除了對Zuul維護上更加友好之外，serviceId映射方式還支持了斷路器，對於服務故障的情況下，可以有效的防止故障蔓延到服務網關上而影響整個系統的對外服務

服務過濾

在完成了服務路由之後，我們對外開放服務還需要一些安全措施來保護客戶端只能訪問它應該訪問到的資源。所以我們需要利用Zuul的過濾器來實現我們對外服務的安全控制。

在服務網關中定義過濾器只需要繼承ZuulFilter抽象類實現其定義的四個抽象函數就可對請求進行攔截與過濾。

比如下面的例子，定義了一個Zuul過濾器，實現了在請求被路由之前檢查請求中是否有accessToken參數，若有就進行路由，若沒有就拒絕訪問，返回401 Unauthorized錯誤。

package com.dxz;

import javax.servlet.http.HttpServletRequest;

import org.apache.log4j.Logger;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;

public class AccessFilter extends ZuulFilter {

    private static Logger log = Logger.getLogger(AccessFilter.class);

    @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();

        log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));

        Object accessToken = request.getParameter("accessToken");
        if (accessToken == null) {
            log.warn("access token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            return null;
        }
        log.info("access token ok");
        return null;
    }

}

filterType：返回一個字符串代表過濾器的類型，在zuul中定義了四種不同生命周期的過濾器類型，具體如下：自定義過濾器的實現，需要繼承ZuulFilter，需要重寫實現下面四個方法：
- pre：可以在請求被路由之前調用
- routing：在路由請求時候被調用
- post：在routing和error過濾器之後被調用
- error：處理請求時發生錯誤時被調用
filterOrder：通過int值來定義過濾器的執行順序
shouldFilter：返回一個boolean類型來判斷該過濾器是否要執行，所以通過此函數可實現過濾器的開關。在上例中，我們直接返回true，所以該過濾器總是生效。
run：過濾器的具體邏輯。需要註意，這裏我們通過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進行路由，然後通過ctx.setResponseStatusCode(401)設置了其返回的錯誤碼，當然我們也可以進一步優化我們的返回，比如，通過ctx.setResponseBody(body)對返回body內容進行編輯等。

在實現了自定義過濾器之後，還需要實例化該過濾器才能生效，我們只需要在應用主類中增加如下內容：

package com.dxz;

import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.cloud.client.SpringCloudApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
import org.springframework.context.annotation.Bean;

@EnableZuulProxy
@SpringCloudApplication
public class SCzullApplication {
    public static void main(String[] args) {
        new SpringApplicationBuilder(SCzullApplication.class).web(true).run(args);
    }

    @Bean
    public AccessFilter accessFilter() {
        return new AccessFilter();
    }

}

啟動該服務網關後，訪問：

http://localhost:5555/api-a/add?a=1&b=2：返回401錯誤
http://localhost:5555/api-a/add?a=1&b=2&accessToken=token：正確路由到server-A，並返回計算內容

技術分享

對於其他一些過濾類型，這裏就不一一展開了，根據之前對filterType生命周期介紹，可以參考下圖去理解，並根據自己的需要在不同的生命周期中去實現不同類型的過濾器。

alt

最後，總結一下為什麽服務網關是微服務架構的重要部分，是我們必須要去做的原因：

不僅僅實現了路由功能來屏蔽諸多服務細節，更實現了服務級別、均衡負載的路由。
實現了接口權限校驗與微服務業務邏輯的解耦。通過服務網關中的過濾器，在各生命周期中去校驗請求的內容，將原本在對外服務層做的校驗前移，保證了微服務的無狀態性，同時降低了微服務的測試難度，讓服務本身更集中關註業務邏輯的處理。
實現了斷路器，不會因為具體微服務的故障而導致服務網關的阻塞，依然可以對外服務。

服務網關zuul之一：入門介紹

cse 服務註冊總結測試的 ext 消費簡單的 ase 功能通過之前幾篇Spring Cloud中幾個核心組件的介紹，我們已經可以構建一個簡略的（不夠完善）微服務架構了。比如下圖所示：我們使用Spring Cloud Netflix中的Eureka實現

服務網關zuul之一：入門介紹

準備工作

開始使用Zuul

Zuul配置

服務路由

服務過濾

服務網關zuul之一：入門介紹

Postman使用技巧之一：入門介紹

springcloud(十)：服務網關zuul初級篇

初識RabbitMQ系列之一：簡單介紹

團隊作業之一：團隊介紹及選題背景與意義

【第五章】API服務網關(Zuul) 上

SpringCloud系列研究---服務網關zuul

八、springcloud之服務網關zuul

九、springcloud之服務網關zuul（二）

MemCached學習筆記之一：入門極簡教程

遷移到 Linux ：入門介紹 | Linux 中國

java B2B2C電子商務平臺分析之十------服務網關zuul

Apache shiro：入門介紹

Asp.Net MVC4入門指南（1）：入門介紹

Spark MLlib系列(一)：入門介紹

DNS伺服器全攻略之一：基礎介紹（區域委派）

Linux驅動入門學習(一)：入門介紹

基於cygwin學習linux 學習筆記之一：入門篇

Matplotlib資料視覺化（1）：入門介紹

springCloud（13）：使用Zuul構建微服務網關-簡介

服務網關zuul之一：入門介紹

準備工作

開始使用Zuul

Zuul配置

服務路由

服務過濾

相關推薦