Spring Cloud 入門教程(九)： 路由網關zuul

在微服務架構中，需要幾個關鍵的組件，服務注冊與發現、服務消費、負載均衡、斷路器、智能路由、配置管理等，由這幾個組件可以組建一個簡單的微服務架構。客戶端的請求首先經過負載均衡（zuul、Ngnix），再到達服務網關（zuul集群），然后再到具體的服務，服務統一注冊到高可用的服務注冊中心集群，服務的所有的配置文件由配置服務管理（下一篇文章講述），配置服務的配置文件放在Git倉庫，方便開發人員隨時改配置。

1. Zuul介紹

Zuul的主要功能是路由和過濾器。路由功能是微服務的一部分，比如／api/user映射到user服務，/api/shop映射到shop服務。zuul實現了負載均衡。以下是微服務結構中，Zuul的基本流程。在接下來的步驟中，我們來創建一個zuul服務， 將/api-feign/**映射到我們之前創建feign-service, 將/api-ribbon/**映射到之前的ribbon-service服務。

 2. 創建Zuul的Maven工程，其中關於zuul的依賴是

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

 完整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>cm.chry</groupId>
    <artifactId>spring.helloworld.zuul.service</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring.helloworld.zuul.service</name>
    <description>zuul service demo</description>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.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>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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>Dalston.RC1</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>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
</project>

3. 創建啟動類: 使用@EnableZuulProxy注解

package spring.helloworld.zuul.service;

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;

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

4. 編寫zuul服務配置：

簡單配置兩個路由， 一個路由到ribbon，一個路由到feign； 由於都注冊到eureka服務中心，所以都用通過serviceId來發現服務具體地址， path是路由的地址映射關系

eureka:
    client:
        serviceUrl:
            defaultZone: http://localhost:8761/eureka/
server:
    port: 8904
spring:
    application:
        name: service-zuul
zuul:
 routes:
    ribbo:
      path: /api-ribbon/**
      serviceId: service-ribbon
    feign:
      path: /api-feign/**
      serviceId: service-feign

這時啟動zuul服務， 然后訪問http://localhost:8904/api-ribbon可直接路由到http://localhost:8901/.  

http://localhost:8904/api-feign/hello可路由到http://localhost:8902/hello

5. Zuul過濾器

zuul還提供了過濾功能， 只要實現接口ZuulFilter即可對請求先進行篩選和過濾之后再路由到具體服務。

package spring.helloworld.zuul.service;

import javax.servlet.http.HttpServletRequest;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

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

@Component
public class DemoFilter extends ZuulFilter {
    private static Logger log = LoggerFactory.getLogger(DemoFilter.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();
        String s = String.format("%s >>> %s", request.getMethod(), request.getRequestURL().toString());
        log.info(s);
        return null;
    }
}

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

• pre：路由之前
• routing：路由之時
• post： 路由之后
• error：發送錯誤調用

filterOrder：過濾的順序 

• pre：路由之前
• routing：路由之時
• post： 路由之后
• error：發送錯誤調用

shouldFilter：這里可以寫邏輯判斷，是否要過濾，本文true,永遠過濾。 

run：過濾器的具體邏輯，這里只是將請求的URL簡單些到日志中

上一篇：Spring Cloud 入門教程(八)： 斷路器指標數據監控Hystrix Dashboard 和 Turbine

下一篇：Spring Cloud 入門教程(十)：和RabbitMQ的整合 -- 消息總線Spring Cloud Netflix Bus

隨筆 - 35, 文章 - 2, 評論 - 6, 引用 - 0