前言

在微服務(wù)架構(gòu)中，后端服務(wù)往往不直接開放給調(diào)用端，而是通過一個(gè)公共網(wǎng)關(guān)根據(jù)請求的url，路由到相應(yīng)的服務(wù)。
在網(wǎng)關(guān)中可以做一些服務(wù)調(diào)用的前置處理，比如權(quán)限驗(yàn)證。也可以通過動(dòng)態(tài)路由，提供多個(gè)版本的api接口。
spring cloud 提供的技術(shù)棧中，使用netflix zuul來作為服務(wù)網(wǎng)關(guān)。

創(chuàng)建服務(wù)網(wǎng)關(guān)

新建一個(gè)maven工程，修改pom.xml引入 spring cloud 依賴:

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>1.4.2.RELEASE</version>
</parent>

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

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>Camden.SR2</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

在 resources 目錄中創(chuàng)建 application.yml 配置文件，在配置文件內(nèi)容:

spring:
  application:
    name: @project.artifactId@

server:
  port: 80

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

zuul:
  routes:
    add-service-demo:
      path: /add-service/**
      serviceId: add-service-demo

這里主要關(guān)注 zuul 相關(guān)的配置，path 定義了需要路由的url，serviceId 和注冊中心中的application 相對應(yīng)，定義了路由到哪個(gè)服務(wù)。(這里 serviceId 應(yīng)該換行和 path 同級(jí)，oschina 的markdown格式顯示有問題)
在 java 目錄中創(chuàng)建一個(gè)包 demo ，在包中創(chuàng)建啟動(dòng)入口 ServiceGatewayApplication.java

@EnableDiscoveryClient
@SpringBootApplication
@EnableZuulProxy
public class ServiceGatewayApplication {

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

}

到這里一個(gè)簡單的服務(wù)網(wǎng)關(guān)就配置好了，先啟動(dòng)注冊中心 service-registry-demo，然后啟動(dòng)兩個(gè) add-service-demo 工程，分別映射到 8100 和 8101 端口，然后再啟動(dòng)剛剛配置好的服務(wù)網(wǎng)關(guān) service-gateway-demo。
啟動(dòng)完成后訪問注冊中心頁面 http://localhost:8000，可以看到注冊了兩個(gè) add-service-demo 和一個(gè) service-gateway-demo：

服務(wù)注冊中心

在瀏覽器中訪問 http://localhost/add-service/add?a=1&b=2，可以看到返回結(jié)果：

{
    msg: "操作成功",
    result: 3,
    code: 200
}

多次訪問，查看 add-service-demo 的控制臺(tái)輸出，可以看到服務(wù)網(wǎng)關(guān)對請求分發(fā)做了負(fù)載均衡。

使用corsFilter解決前端跨域問題

在對外提供rest接口時(shí)，經(jīng)常會(huì)遇到跨域問題，尤其是使用前后端分離架構(gòu)時(shí)。
可以在服務(wù)端使用cors技術(shù)，解決前端的跨域問題。這里我們在網(wǎng)關(guān)層解決跨域問題。
修改 ServiceGatewayApplication.java ，增加一個(gè)CorsFilter，代碼如下：

[@Bean](https://my.oschina.net/bean)
public CorsFilter corsFilter() {
    final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
    final CorsConfiguration config = new CorsConfiguration();
    config.setAllowCredentials(true);
    config.addAllowedOrigin("*");
    config.addAllowedHeader("*");
    config.addAllowedMethod("OPTIONS");
    config.addAllowedMethod("HEAD");
    config.addAllowedMethod("GET");
    config.addAllowedMethod("PUT");
    config.addAllowedMethod("POST");
    config.addAllowedMethod("DELETE");
    config.addAllowedMethod("PATCH");
    source.registerCorsConfiguration("/**", config);
    return new CorsFilter(source);
}

這樣服務(wù)端的接口就可以支持跨域訪問了。

使用自定義filter過濾請求

自定義filter也很簡單，只需要繼承 ZuulFilter 就可以了。
在demo包下新建一個(gè)filter的子包，用來存放自定義的filter類。新建一個(gè)filter類 MyFilter 繼承 ZuulFilter：

@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() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();

        String ip = getIpAddr(request);

        System.out.println("收到來自IP為: '" + ip + "'的請求");
        return null;
    }

    private String getIpAddr(HttpServletRequest request) {
        String ip = request.getHeader("x-forwarded-for");
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getHeader("WL-Proxy-Client-IP");
        }
        if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) {
            ip = request.getRemoteAddr();
        }
        return ip;
    }
}

這個(gè)filter的邏輯很簡單，就是從 HttpServletRequest 對象中獲取請求IP，并打印出來。
然后在 ServiceGatewayApplication.java 中增加 MyFilter 的配置：

@Bean
public MyFilter myFilter() {
    return new MyFilter();
}

重新啟動(dòng) service-gateway-demo，再次發(fā)起請求，會(huì)看到控制臺(tái)打印的IP。

我們回過頭看一下，MyFilter 這個(gè)類從 ZuulFilter 繼承之后做了哪些處理。
首先覆寫 ZuulFilter 中的4個(gè)方法，分別為 filterType、filterOrder、 shouldFilter、 run。這4個(gè)方法看名字就知道有什么作用：

• filterType 定義了filter的類型
  • pre 表示在請求被路由之前調(diào)用
  • route 請求被路由時(shí)調(diào)用，時(shí)機(jī)比pre晚
  • post 在路由完成后調(diào)用
  • error 發(fā)生錯(cuò)誤時(shí)調(diào)用
• filterOrder 定義過濾器的執(zhí)行順序，值小的先執(zhí)行
• shouldFilter 是否需要過濾
• run 過濾器的具體執(zhí)行邏輯

demo源碼 spring-cloud-1.0/service-gateway-demo

使用docker-maven-plugin打包并生成docker鏡像

復(fù)制 application.yml，重命名為 application-docker.yml，修改 defaultZone為：

eureka:
  client:
    serviceUrl:
      defaultZone: http://service-registry:8000/eureka/

這里修改了 defaultZone 的訪問url，如何修改取決于部署docker容器時(shí)的 --link 參數(shù)， --link 可以讓兩個(gè)容器之間互相通信。

修改 application.yml 中的 spring 節(jié)點(diǎn)為：

spring:
  application:
    name: @project.artifactId@
  profiles:
    active: @activatedProperties@

這里增加了 profiles 的配置，在maven打包時(shí)選擇不同的profile，加載不同的配置文件。

在pom.xml文件中增加：

<properties>
    <java.version>1.8</java.version> <!-- 指定java版本 -->
    <!-- 鏡像前綴，推送鏡像到遠(yuǎn)程庫時(shí)需要，這里配置了一個(gè)阿里云的私有庫 -->
    <docker.image.prefix>
        registry.cn-hangzhou.aliyuncs.com/ztecs
    </docker.image.prefix>
    <!-- docker鏡像的tag -->
    <docker.tag>demo</docker.tag>

    <!-- 激活的profile -->
    <activatedProperties></activatedProperties>
</properties>

<profiles>
    <!-- docker環(huán)境 -->
    <profile>
        <id>docker</id>

        <properties>
            <activatedProperties>docker</activatedProperties>
            <docker.tag>docker-demo-${project.version}</docker.tag>
        </properties>
    </profile>
</profiles>

<build>
    <defaultGoal>install</defaultGoal>
    <finalName>${project.artifactId}</finalName>

    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
    </resources>

    <plugins>
        <!-- 配置spring boot maven插件，把項(xiàng)目打包成可運(yùn)行的jar包 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <executable>true</executable>
            </configuration>
        </plugin>

        <!-- 打包時(shí)跳過單元測試 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-surefire-plugin</artifactId>
            <configuration>
                <skipTests>true</skipTests>
            </configuration>
        </plugin>

        <!-- 配置docker maven插件，綁定install生命周期，在運(yùn)行maven install時(shí)生成docker鏡像 -->
        <plugin>
            <groupId>com.spotify</groupId>
            <artifactId>docker-maven-plugin</artifactId>
            <version>0.4.13</version>
            <executions>
                <execution>
                    <phase>install</phase>
                    <goals>
                        <goal>build</goal>
                        <goal>tag</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <!-- 修改這里的docker節(jié)點(diǎn)ip，需要打開docker節(jié)點(diǎn)的遠(yuǎn)程管理端口2375，
                具體如何配置可以參照之前的docker安裝和配置的文章 -->
                <dockerHost>http://docker節(jié)點(diǎn)ip:2375</dockerHost>
                <imageName>${docker.image.prefix}/${project.build.finalName}</imageName>
                <baseImage>java</baseImage>
                <!-- 這里的entryPoint定義了容器啟動(dòng)時(shí)的運(yùn)行命令，容器啟動(dòng)時(shí)運(yùn)行
                java -jar 包名 , -Djava.security.egd這個(gè)配置解決tomcat8啟動(dòng)時(shí)，
因?yàn)樾枰占h(huán)境噪聲來生成安全隨機(jī)數(shù)導(dǎo)致啟動(dòng)過慢的問題-->
                <entryPoint>
                    ["java", "-Djava.security.egd=file:/dev/./urandom", "-jar", "/${project.build.finalName}.jar"]
                </entryPoint>
                <resources>
                    <resource>
                        <targetPath>/</targetPath>
                        <directory>${project.build.directory}</directory>
                        <include>${project.build.finalName}.jar</include>
                    </resource>
                </resources>
                <image>${docker.image.prefix}/${project.build.finalName}</image>
                <newName>${docker.image.prefix}/${project.build.finalName}:${docker.tag}</newName>
                <forceTags>true</forceTags>
                <!-- 如果需要在生成鏡像時(shí)推送到遠(yuǎn)程庫，pushImage設(shè)為true -->
                <pushImage>false</pushImage>
            </configuration>
        </plugin>
    </plugins>
</build>

選擇 docker profile，運(yùn)行 mvn install -P docker ，打包項(xiàng)目并生成docker鏡像，注意docker-maven-plugin中的 <entryPoint> 標(biāo)簽里的內(nèi)容不能換行，否則在生成docker鏡像的時(shí)候會(huì)報(bào)錯(cuò)。
運(yùn)行成功后，登錄docker節(jié)點(diǎn)，運(yùn)行 docker images 應(yīng)該可以看到剛才打包生成的鏡像了。

啟動(dòng)docker容器并注冊服務(wù)

在前一篇中，已經(jīng)啟動(dòng)了 service-registry-demo 和 add-service-demo，并且在兩個(gè)容器之間建立了連接。這里啟動(dòng) service-gateway-demo

docker run -d --name service-gateway-demo --publish 80:80 --link service-registry-demo:service-registry \
 --link add-service-demo --volume /etc/localtime:/etc/localtime \
 registry.cn-hangzhou.aliyuncs.com/ztecs/service-gateway-demo:docker-demo-1.0

這里比起上一篇啟動(dòng) add-service-demo 容器的命令，有兩個(gè) --link ，分別連接了 service-registry-demo 和 add-service-demo，因?yàn)榉?wù)網(wǎng)關(guān)不僅需要注冊到服務(wù)注冊中心，還需要和后端提供的服務(wù)進(jìn)行連接。
啟動(dòng)完成之后，訪問注冊中心的頁面 http://宿主機(jī)IP:8000 查看服務(wù)注冊信息，可以發(fā)現(xiàn) service-gateway-demo 也注冊成功了。
這時(shí)候就可以通過網(wǎng)關(guān)訪問 add-service-demo 提供的服務(wù)了。
注意：在前一篇啟動(dòng) add-service-demo 時(shí)使用了 --publish把端口映射到了宿主機(jī)，在部署服務(wù)網(wǎng)關(guān)的情況下，后端服務(wù)就不需要映射到宿主機(jī)了，所有對服務(wù)的訪問都通過網(wǎng)關(guān)進(jìn)行路由，避免透過網(wǎng)關(guān)直接訪問。
可以把3條啟動(dòng)命令封裝到一個(gè)shell里：

docker run -d --name service-registry-demo --publish 8000:8000 \
 --volume /etc/localtime:/etc/localtime \
 registry.cn-hangzhou.aliyuncs.com/ztecs/service-registry-demo:docker-demo-1.0

echo 'sleep 30s to next step...'
sleep 30s

docker run -d --name add-service-demo --link service-registry-demo:service-registry \
 --volume /etc/localtime:/etc/localtime \
 registry.cn-hangzhou.aliyuncs.com/ztecs/add-service-demo:docker-demo-1.0

docker run -d --name service-gateway-demo --publish 80:80 --link service-registry-demo:service-registry \
 --link add-service-demo --volume /etc/localtime:/etc/localtime \
 registry.cn-hangzhou.aliyuncs.com/ztecs/service-gateway-demo:docker-demo-1.0

這里的 sleep 30s 是為了讓 service-registry-demo 啟動(dòng)完成之后再啟動(dòng) add-service-demo 和 service-gateway-demo。
在啟動(dòng)完成之后，通過網(wǎng)關(guān)訪問接口時(shí)，可能會(huì)報(bào)錯(cuò)
Load balancer does not have available server for client: add-service-demo
這是因?yàn)?service-gateway-demo 和 add-service-demo 同時(shí)啟動(dòng)，service-gateway-demo 在向注冊中心注冊時(shí)，add-service-demo 可能還沒有來得及注冊，導(dǎo)致 service-gateway-demo 獲取不到 add-service-demo 的注冊信息，過個(gè)幾十秒再訪問就可以了。

最后

目前我們已經(jīng)成功搭建了 服務(wù)注冊中心、 服務(wù)網(wǎng)關(guān)、 后端服務(wù)，也創(chuàng)建了兩個(gè)服務(wù)調(diào)用者 ribbon 和 feign。
配置中心 和 斷路器 還沒有涉及，配置中心 由于 spring cloud bus 需要用到消息隊(duì)列 rabbitmq 或 kafka，在進(jìn)行配置中心的開發(fā)之前，需要先部署消息隊(duì)列。
斷路器 的功能會(huì)和 hystrix-dashboard 斷路監(jiān)控一起放出，包括 turbine 、 zipkin、 spring cloud sleuth 服務(wù)調(diào)用追蹤，這些都屬于服務(wù)端異常監(jiān)控范疇。
由于配置中心和服務(wù)追蹤都涉及到消息隊(duì)列，下一篇先脫離 spring cloud，介紹一下 docker 環(huán)境下的 rabbitmq 部署、AMQP 協(xié)議、以及使用 spring AMQP 進(jìn)行消息收發(fā)。