服務(wù)網(wǎng)關(guān)Spring?Cloud?Zuul的示例分析

這篇文章主要為大家展示了“服務(wù)網(wǎng)關(guān)Spring Cloud Zuul的示例分析”，內(nèi)容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“服務(wù)網(wǎng)關(guān)Spring Cloud Zuul的示例分析”這篇文章吧。

一、Zuul簡介

Zuul作為微服務(wù)系統(tǒng)的網(wǎng)關(guān)組件，用于構(gòu)建邊界服務(wù)（Edge Service），致力于動(dòng)態(tài)路由、過濾、監(jiān)控、彈性伸縮和安全。其在微服務(wù)架構(gòu)中有著重要的作用，主要體現(xiàn)在以下六個(gè)方面：

Zull、Ribbon以及Eureka相結(jié)合可以實(shí)現(xiàn)智能路由和負(fù)載均衡的功能，Zull可以按照某種策略將請求分發(fā)到不同的實(shí)例上；

網(wǎng)關(guān)作為邊界服務(wù)，將內(nèi)部服務(wù)的API接口進(jìn)行聚合并統(tǒng)一對外暴露接口。保護(hù)內(nèi)部服務(wù)的API接口，防止內(nèi)部服務(wù)被外界調(diào)用泄露敏感信息；

網(wǎng)關(guān)可以對用戶的身份權(quán)限進(jìn)行認(rèn)證，防止非法請求API接口；

網(wǎng)關(guān)可以實(shí)現(xiàn)監(jiān)控功能，實(shí)時(shí)日志輸出，對請求進(jìn)行記錄；

網(wǎng)關(guān)可以用來實(shí)現(xiàn)流量監(jiān)控，在高流量的情況下，對服務(wù)進(jìn)行降級(jí)；

API接口從內(nèi)部服務(wù)分離出來，便于測試

二、請求路由

使用Spring Cloud Zuul實(shí)現(xiàn)路由的規(guī)則是十分簡單的。路由方式包括兩種：傳統(tǒng)路由方式，面向服務(wù)的路由方式。

2.1 傳統(tǒng)路由

下面我們看以下配置：

zuul.routes.holiday.path=/holiday/**
zuul.routes.holiday.url=http://localhosst:8080/

該規(guī)則配置表示所有符合/holiday/** 規(guī)則的訪問都會(huì)被路由轉(zhuǎn)發(fā)到http://localhosst:8080/地址上，例如：當(dāng)我們訪問http://localhost:5555/holiday/getAllDays,API網(wǎng)關(guān)就會(huì)將請求轉(zhuǎn)發(fā)到http://localhost:8080/holiday/getAllDays提供的微服務(wù)接口上。其中holiday為微服務(wù)的名稱，可以任意定義，但是一組path和url映射關(guān)系的路由名稱必須相同，下面面向服務(wù)的路由方式也是如此。

2.2 面向服務(wù)的路由

Spring Cloud Zuul 與 Spring Cloud Eureka 可以實(shí)現(xiàn)無縫對接實(shí)現(xiàn)面向服務(wù)的路由。我們讓路由的path映射到具體的服務(wù)上，而具體的url交由Eureka的服務(wù)發(fā)現(xiàn)機(jī)制去自動(dòng)維護(hù)。具體配置如下（其他配置參考下面的實(shí)戰(zhàn)）：

zuul.routes.holiday.path=/holiday/**
zuul.routes.holiday.service-id=holiday

通過上面的配置，我們不需要維護(hù)具體實(shí)例的位置,是得維護(hù)工作十分簡單。另外，面向服務(wù)打的路由默認(rèn)實(shí)現(xiàn)了負(fù)載均衡，而傳統(tǒng)路由還需要手動(dòng)添加所有實(shí)例的位置。

三、路由規(guī)則

Spring Cloud Zuul提供了默認(rèn)的路由規(guī)則，當(dāng)然我們也可以修改這個(gè)路由規(guī)則。

3.1 默認(rèn)路由規(guī)則

Zull與Eureka的配合使用后，Zull會(huì)默認(rèn)配置一個(gè)路由規(guī)則，這些默認(rèn)規(guī)則的path會(huì)使用service-id配置的服務(wù)名作為請求的前綴。例如：有holiday服務(wù)，他的默認(rèn)規(guī)則如下

zuul.routes.holiday.path=/holiday/**
zuul.routes.holiday.service-id=holiday

由于默認(rèn)情況下所有Eureka上的服務(wù)都會(huì)被Zuul自動(dòng)創(chuàng)建映射關(guān)系進(jìn)行路由，這會(huì)使得一些我們不希望對外開放的服務(wù)也被外部訪問到。這個(gè)時(shí)候我們可以配置zuul.ignored-services參數(shù)來設(shè)置一個(gè)服務(wù)名匹配表達(dá)式進(jìn)行判斷，如果服務(wù)名匹配表達(dá)式，那么Zull將跳過這個(gè)服務(wù)，不為其創(chuàng)建路由規(guī)則。例如：zuul.ignored-services=*表示對所有的服務(wù)不自動(dòng)創(chuàng)建路由規(guī)則，這樣我們就需要為每個(gè)服配置路由規(guī)則。

3.2 自定義路由規(guī)則

有這樣一個(gè)場景，由于業(yè)務(wù)的擴(kuò)展，版本的升級(jí)，服務(wù)存在不同的版本。比如我們有這樣的命名：holiday-v1、holiday-v2，默認(rèn)情況下，Zuul自動(dòng)為服務(wù)創(chuàng)建的路由表達(dá)式會(huì)采用服務(wù)名做前綴，針對holiday-v1就會(huì)產(chǎn)生/holiday-v1,/holiday-v2兩個(gè)路徑來做映射，但這樣生成的表達(dá)式規(guī)則較為單一，不利于路徑規(guī)則的管理。

通常,對于上面這種情況，我們希望是生成的路徑為/v1/holiday，/v2/holiday。我們可以通過自定義路由規(guī)則來實(shí)現(xiàn)，具體代碼如下：

@Bean
public PatternServiceRouteMapper serviceRouteMapper(){
  return new PatternServiceRouteMapper(
    "(?<name>^.+)-(?<version>v.+$)",
    "${version}/${name}");
}

PatternServiceRouteMapper對象可以讓開發(fā)者通過正則表達(dá)式來自定義服務(wù)于路由映射的生成關(guān)系。

四、Zuul的過濾器

Zull有請求過濾的功能,其過濾器可以在Http請求的發(fā)起和響應(yīng)返回期間執(zhí)行一系列的過濾器。

Zuul包擴(kuò)以下四種過濾器：

• PRE：該類型的filters在Request routing到源web-service之前執(zhí)行。可以進(jìn)行一些權(quán)限認(rèn)證，日志記錄，或者額外給Request增加一些屬性供后續(xù)的filter使用;

• ROUTING：該類型的filters用于把Request routing到源web-service，源web-service是實(shí)現(xiàn)業(yè)務(wù)邏輯的服務(wù)。這里使用HttpClient請求web-service;

• POST：該類型的filters在ROUTING返回Response后執(zhí)行。用來實(shí)現(xiàn)對Response結(jié)果進(jìn)行修改，收集統(tǒng)計(jì)數(shù)據(jù)以及把Response傳輸會(huì)客戶端;

• ERROR：上面三個(gè)過程中任何一個(gè)出現(xiàn)錯(cuò)誤都交由ERROR類型的filters進(jìn)行處理。

Zuul過濾器具有以下關(guān)鍵特性：

• Type(類型)：Zuul過濾器的類型，這個(gè)類型決定過濾器在哪個(gè)階段執(zhí)行，例如：pre，post等階段；

• Execution Order(執(zhí)行順序)：規(guī)定了過濾器的執(zhí)行順序，Order的值越小，越先執(zhí)行；

• Criteria(標(biāo)準(zhǔn))：Filters執(zhí)行所需條件

• Action(行動(dòng))：如果符合執(zhí)行條件，則執(zhí)行Action（具體邏輯代碼）

示例如下：

public class MyFilter extends ZuulFilter {
    @Override
    public Object run() {
            RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        System.out.println(String.format("%s AccessUserNameFilter request to %s", request.getMethod(), request.getRequestURL().toString()));
        // 獲取請求的參數(shù)
        String username = request.getParameter("username");
        // 如果請求的參數(shù)不為空，且值為chhliu時(shí)，則通過
        if(null != username && username.equals("chhliu")) {
          // 對該請求進(jìn)行路由
            ctx.setSendZuulResponse(true);
            ctx.setResponseStatusCode(200);
            // 設(shè)值，讓下一個(gè)Filter看到上一個(gè)Filter的狀態(tài)
            ctx.set("isSuccess", true);
            return null;
        }else{
          // 過濾該請求，不對其進(jìn)行路由
            ctx.setSendZuulResponse(false);
            // 返回錯(cuò)誤碼
            ctx.setResponseStatusCode(401);
            // 返回錯(cuò)誤內(nèi)容
            ctx.setResponseBody("{\"result\":\"username is not correct!\"}");
            ctx.set("isSuccess", false);
            return null;
        }
    }
    @Override
    public boolean shouldFilter() {
    // 是否執(zhí)行該過濾器，此處為true，說明需要過濾
        return true;
    }
    @Override
    public int filterOrder() {
    // 優(yōu)先級(jí)為0，數(shù)字越大，優(yōu)先級(jí)越低
        return 0;
    }
    @Override
    public String filterType() {
    // 前置過濾器
        return "pre";
    }
}

Zuul請求的生命周期如圖所示：

五、設(shè)置熔斷

通常在服務(wù)無法提供服務(wù)的時(shí)候，需要執(zhí)行熔斷。zuul上實(shí)現(xiàn)熔斷需要實(shí)現(xiàn)FallbackProvider的接口。實(shí)現(xiàn)接口中的兩個(gè)方法:getRoute()用于指定應(yīng)用在哪個(gè)服務(wù)上；fallbackResponse()進(jìn)入熔斷功能的執(zhí)行邏輯。示例如下：

@Component
public class CustomZuulFallbackHandler implements FallbackProvider {
  private final Logger logger = LoggerFactory.getLogger(FallbackProvider.class);
  /**
   * 指定處理的service
   *
   * @return
   */
  @Override
  public String getRoute() {
    return "*";
  }
  public ClientHttpResponse fallbackResponse(String route) {
    return new ClientHttpResponse() {
      @Override
      public HttpStatus getStatusCode() throws IOException {
        return HttpStatus.OK;
      }
      @Override
      public int getRawStatusCode() throws IOException {
        return 200;
      }
      @Override
      public String getStatusText() throws IOException {
        return "OK";
      }
      @Override
      public void close() {
      }
      @Override
      public InputStream getBody() throws IOException {
        return new ByteArrayInputStream((route+" is unavailable.").getBytes());
      }
      @Override
      public HttpHeaders getHeaders() {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        return headers;
      }
    };
  }
  @Override
  public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
    if (cause != null) {
      String reason = cause.getMessage();
      logger.info("Excption {}",reason);
    }
    return fallbackResponse(route);
  }
}

六、實(shí)戰(zhàn)

6.1 pom文件

<?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">
    <parent>
        <groupId>com.southgis.ibase.parent</groupId>
        <artifactId>parentWebService</artifactId>
        <version>2.0.1-SNAPSHOT</version>
        <relativePath>../../parent/parentWebService/pom.xml</relativePath>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api-gateway</artifactId>
    <groupId>com.southgis.ibase.systemassistance</groupId>
    <version>2.0.1-SNAPSHOT</version>
    <packaging>war</packaging>
    <description>網(wǎng)關(guān)服務(wù)</description>
    <dependencies>
      <!--服務(wù)注冊與發(fā)現(xiàn)-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
        </dependency>
        <!--配置中心-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-client</artifactId>
        </dependency>
        <!--路由網(wǎng)關(guān)-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
        </dependency>
        <!--cas 客戶端-->
        <dependency>
            <groupId>org.jasig.cas.client</groupId>
            <artifactId>cas-client-core</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
    <build>
        <finalName>apiGateway</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <mainClass>com.southgis.ibase.systemassistance.ApiGatewayCustomApplication</mainClass>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>
</project>

6.2 配置文件

bootstrap.properties

#服務(wù)名 對應(yīng)配置文件中的{application}部分
spring.application.name=apiGateway
#對應(yīng)前配置文件中的{profile}部分
spring.cloud.config.profile=dev2
#配置訪問路徑
server.servlet.context-path=/eureka-server
#注冊中心
eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka-server/eureka
#為監(jiān)控端點(diǎn) /info和/health端點(diǎn)也加上類似的前綴
management.server.servlet.context-path=/apiGateway
eureka.instance.statusPageUrlPath=${management.server.servlet.context-path}/actuator/info
eureka.instance.healthCheckUrlPath=${management.server.servlet.context-path}/actuator/health
#通過服務(wù)連接配置中心
#spring.cloud.config.discovery.enabled=true
#spring.cloud.config.discovery.serviceId=config-server
spring.cloud.config.uri = http://localhost:8080/config-server
#配置文件獲取失敗快速返回
spring.cloud.config.failFast=true
#日志配置
#logging.config=classpath:logback-spring.xml
#logging.path=D:/ibase/logs/holiday
#logging.pattern.console=[%d{yyyy-MM-dd HH:mm:ss}] -- [%-5p]: [%c] -- %m%n
#logging.pattern.file=[%d{yyyy-MM-dd HH:mm:ss}] -- [%-5p]: [%c] -- %m%n

apiGateway-dev2.properties

#訪問端口
server.port=8080
#設(shè)置session超時(shí)時(shí)間為540分鐘
server.servlet.session.timeout=PT540M
#zuul默認(rèn)為所有服務(wù)開啟默認(rèn)的路由，為了服務(wù)安全，此處關(guān)閉
zuul.ignored-services=*
#代碼字典服務(wù)路由
zuul.routes.codedict.path=/codedict/**
zuul.routes.codedict.service-id=codedict
#是否轉(zhuǎn)發(fā)后還帶轉(zhuǎn)發(fā)特征的字符
zuul.routes.codedict.strip-prefix=false
#行政區(qū)劃服務(wù)路由
zuul.routes.adminzone.path=/adminzone/**
zuul.routes.adminzone.service-id=adminzone
zuul.routes.adminzone.strip-prefix=false
#是否開啟路由重試
zuul.retryable=true
#對當(dāng)前服務(wù)的重試次數(shù)
ribbon.MaxAutoRetries=2
#切換實(shí)例的重試次數(shù)
ribbon.MaxAutoRetriesNextServer=0
#請求處理的超時(shí)時(shí)間
ribbon.ReadTimeout=6000
#請求連接的超時(shí)時(shí)間
ribbon.ConnectTimeout=6000
#對所有操作請求都進(jìn)行重試
ribbon.OkToRetryOnAllOperations=true
#將 hystrix 的超時(shí)時(shí)間設(shè)置成 5000 毫秒(hystrix超時(shí)時(shí)間小于ribbon連接超時(shí)時(shí)間，先走h(yuǎn)ystrix)
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds=5000

6.3 過濾器配置

@Configuration
public class ApiGatewayFilter 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 context = RequestContext.getCurrentContext();
    HttpServletRequest request = context.getRequest();
    Principal principal = request.getUserPrincipal();
    //獲取用戶的登錄id
    String userId = principal.getName();
    context.addZuulRequestHeader("X-AUTH-ID",userId);
    return null;
  }
}

在這里我們將獲取的登錄用戶id設(shè)置到了請求頭中傳遞給內(nèi)部服務(wù)，內(nèi)部服務(wù)可以通過下面的代碼進(jìn)行獲?。?/p>

String user = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getRequest().getHeader("X-AUTH-ID");

6.4 熔斷配置

@Component
public class CustomZuulFallbackHandler implements FallbackProvider {
  private final Logger logger = LoggerFactory.getLogger(FallbackProvider.class);
  /**
   * 指定處理的service
   *
   * @return
   */
  @Override
  public String getRoute() {
    return "*";
  }
  public ClientHttpResponse fallbackResponse(String route) {
    return new ClientHttpResponse() {
      @Override
      public HttpStatus getStatusCode() throws IOException {
        return HttpStatus.OK;
      }
      @Override
      public int getRawStatusCode() throws IOException {
        return 200;
      }
      @Override
      public String getStatusText() throws IOException {
        return "OK";
      }
      @Override
      public void close() {
      }
      @Override
      public InputStream getBody() throws IOException {
        return new ByteArrayInputStream((route+" is unavailable.").getBytes());
      }
      @Override
      public HttpHeaders getHeaders() {
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        return headers;
      }
    };
  }
  @Override
  public ClientHttpResponse fallbackResponse(String route, Throwable cause) {
    if (cause != null) {
      String reason = cause.getMessage();
      logger.info("Excption {}",reason);
    }
    return fallbackResponse(route);
  }
}

6.5 啟動(dòng)類

**
 * 路由網(wǎng)關(guān)服務(wù)部署啟動(dòng)類
 *
 * @author simon
 **/
@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
@EnableZuulProxy
@EnableEurekaClient
@SpringCloudApplication
public class ApiGatewayMicroApplication {
  public static void main(String[] args) {
    SpringApplication.run(ApiGatewayMicroApplication.class, args);
  }
}

以上是“服務(wù)網(wǎng)關(guān)Spring Cloud Zuul的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！