1.Zuul網(wǎng)關(guān)

通過(guò)前面的學(xué)習(xí)顽照，使用Spring Cloud實(shí)現(xiàn)微服務(wù)的架構(gòu)基本成型，大致是這樣的：

1525674644660.png

我們使用Spring Cloud Netflix中的Eureka實(shí)現(xiàn)了服務(wù)注冊(cè)中心以及服務(wù)注冊(cè)與發(fā)現(xiàn)闽寡；而服務(wù)間通過(guò)Ribbon或Feign實(shí)現(xiàn)服務(wù)的消費(fèi)以及均衡負(fù)載代兵；通過(guò)Spring Cloud Config實(shí)現(xiàn)了應(yīng)用多環(huán)境的外部化配置以及版本管理。為了使得服務(wù)集群更為健壯爷狈，使用Hystrix的融斷機(jī)制來(lái)避免在微服務(wù)架構(gòu)中個(gè)別服務(wù)出現(xiàn)異常時(shí)引起的故障蔓延植影。

在該架構(gòu)中图云，我們的服務(wù)集群包含：內(nèi)部服務(wù)Service A和Service B莱找，他們都會(huì)注冊(cè)與訂閱服務(wù)至Eureka Server蛤铜，而Open Service是一個(gè)對(duì)外的服務(wù)乍钻，通過(guò)均衡負(fù)載公開(kāi)至服務(wù)調(diào)用方莺禁。我們把焦點(diǎn)聚集在對(duì)外服務(wù)這塊石洗，直接暴露我們的服務(wù)地址循诉，這樣的實(shí)現(xiàn)是否合理贤斜，或者是否有更好的實(shí)現(xiàn)方式呢拷淘？

先來(lái)說(shuō)說(shuō)這樣架構(gòu)需要做的一些事兒以及存在的不足：

• 首先各墨，破壞了服務(wù)無(wú)狀態(tài)特點(diǎn)。
  • 為了保證對(duì)外服務(wù)的安全性启涯，我們需要實(shí)現(xiàn)對(duì)服務(wù)訪(fǎng)問(wèn)的權(quán)限控制贬堵，而開(kāi)放服務(wù)的權(quán)限控制機(jī)制將會(huì)貫穿并污染整個(gè)開(kāi)放服務(wù)的業(yè)務(wù)邏輯，這會(huì)帶來(lái)的最直接問(wèn)題是结洼，破壞了服務(wù)集群中REST API無(wú)狀態(tài)的特點(diǎn)黎做。
  • 從具體開(kāi)發(fā)和測(cè)試的角度來(lái)說(shuō)，在工作中除了要考慮實(shí)際的業(yè)務(wù)邏輯之外松忍，還需要額外考慮對(duì)接口訪(fǎng)問(wèn)的控制處理蒸殿。
• 其次，無(wú)法直接復(fù)用既有接口鸣峭。
  • 當(dāng)我們需要對(duì)一個(gè)即有的集群內(nèi)訪(fǎng)問(wèn)接口宏所，實(shí)現(xiàn)外部服務(wù)訪(fǎng)問(wèn)時(shí)，我們不得不通過(guò)在原有接口上增加校驗(yàn)邏輯摊溶，或增加一個(gè)代理調(diào)用來(lái)實(shí)現(xiàn)權(quán)限控制爬骤，無(wú)法直接復(fù)用原有的接口。

面對(duì)類(lèi)似上面的問(wèn)題莫换，我們要如何解決呢霞玄？答案是：服務(wù)網(wǎng)關(guān)骤铃！

為了解決上面這些問(wèn)題，我們需要將權(quán)限控制這樣的東西從我們的服務(wù)單元中抽離出去坷剧，而最適合這些邏輯的地方就是處于對(duì)外訪(fǎng)問(wèn)最前端的地方劲厌，我們需要一個(gè)更強(qiáng)大一些的均衡負(fù)載器的 服務(wù)網(wǎng)關(guān)。

服務(wù)網(wǎng)關(guān)是微服務(wù)架構(gòu)中一個(gè)不可或缺的部分听隐。通過(guò)服務(wù)網(wǎng)關(guān)統(tǒng)一向外系統(tǒng)提供REST API的過(guò)程中，除了具備服務(wù)路由哄啄、均衡負(fù)載功能之外雅任，它還具備了權(quán)限控制等功能。Spring Cloud Netflix中的Zuul就擔(dān)任了這樣的一個(gè)角色咨跌，為微服務(wù)架構(gòu)提供了前門(mén)保護(hù)的作用沪么，同時(shí)將權(quán)限控制這些較重的非業(yè)務(wù)邏輯內(nèi)容遷移到服務(wù)路由層面，使得服務(wù)集群主體能夠具備更高的可復(fù)用性和可測(cè)試性锌半。

1.1.簡(jiǎn)介

官網(wǎng)：https://github.com/Netflix/zuul

1525675168152.png

1.2.Zuul加入后的架構(gòu)

1525675648881.png

• 不管是來(lái)自于客戶(hù)端（PC或移動(dòng)端）的請(qǐng)求禽车，還是服務(wù)內(nèi)部調(diào)用。一切對(duì)服務(wù)的請(qǐng)求都會(huì)經(jīng)過(guò)Zuul這個(gè)網(wǎng)關(guān)刊殉，然后再由網(wǎng)關(guān)來(lái)實(shí)現(xiàn) 鑒權(quán)殉摔、動(dòng)態(tài)路由等等操作。Zuul就是我們服務(wù)的統(tǒng)一入口记焊。

1.3.快速入門(mén)

1.3.1.新建工程

添加Zuul依賴(lài)：

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

1.3.2.編寫(xiě)啟動(dòng)類(lèi)

通過(guò)@EnableZuulProxy注解開(kāi)啟Zuul的功能：

@SpringBootApplication
@EnableZuulProxy // 開(kāi)啟Zuul的網(wǎng)關(guān)功能
public class ZuulDemoApplication {

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

1.3.3.編寫(xiě)配置

server:
  port: 6003#服務(wù)端口
spring: 
  application:  
    name: zuul-demo#指定服務(wù)名

1.3.4.編寫(xiě)路由規(guī)則

映射規(guī)則：

zuul:
  routes:
    account-demo: # 這里是路由id逸月，隨意寫(xiě)
      path: /account-demo/** # 這里是映射路徑
      url: http://127.0.0.1:6060# 映射路徑對(duì)應(yīng)的實(shí)際url地址

我們將符合path 規(guī)則的一切請(qǐng)求，都代理到 url參數(shù)指定的地址

本例中遍膜，我們將 /account-demo/**開(kāi)頭的請(qǐng)求碗硬，代理到http://127.0.0.1:6060

1.3.5.啟動(dòng)測(cè)試：

訪(fǎng)問(wèn)的路徑中需要加上配置規(guī)則的映射路徑，我們?cè)L問(wèn)：http://127.0.0.1:6003/account-demo/account/get/2

image.png

1.4.面向服務(wù)的路由

在剛才的路由規(guī)則中瓢颅，我們把路徑對(duì)應(yīng)的服務(wù)地址寫(xiě)死了恩尾！如果同一服務(wù)有多個(gè)實(shí)例的話(huà)，這樣做顯然就不合理了挽懦。

我們應(yīng)該根據(jù)服務(wù)的名稱(chēng)翰意，去Eureka注冊(cè)中心查找 服務(wù)對(duì)應(yīng)的所有實(shí)例列表，然后進(jìn)行動(dòng)態(tài)路由才對(duì)信柿！

1.4.1.添加Eureka客戶(hù)端依賴(lài)

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

1.4.2.開(kāi)啟Eureka客戶(hù)端發(fā)現(xiàn)功能

@SpringBootApplication
@EnableZuulProxy // 開(kāi)啟Zuul的網(wǎng)關(guān)功能
@EnableDiscoveryClient
public class ZuulDemoApplication {

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

1.4.3.添加Eureka配置猎物，獲取服務(wù)信息

eureka:
  client:
    registry-fetch-interval-seconds: 5 # 獲取服務(wù)列表的周期：5s
    service-url:
      defaultZone: http://127.0.0.1:6001/eureka/,http://127.0.0.1:6002/eureka/
  instance:
    prefer-ip-address: true
    ip-address: 127.0.0.1

1.4.4.修改映射配置，通過(guò)服務(wù)名稱(chēng)獲取

因?yàn)橐呀?jīng)有了Eureka客戶(hù)端角塑，我們可以從Eureka獲取服務(wù)的地址信息蔫磨，因此映射時(shí)無(wú)需指定IP地址，而是通過(guò)服務(wù)名稱(chēng)來(lái)訪(fǎng)問(wèn)圃伶，而且Zuul已經(jīng)集成了Ribbon的負(fù)載均衡功能堤如。

zuul:
  routes:
    account-demo: # 這里是路由id蒲列，隨意寫(xiě)
      path: /account-demo/** # 這里是映射路徑
      serviceId: account-demo # 指定服務(wù)名稱(chēng)

1.5.簡(jiǎn)化的路由配置

在剛才的配置中，我們的規(guī)則是這樣的：

• zuul.routes.<route>.path=/xxx/**： 來(lái)指定映射路徑搀罢。<route>是自定義的路由名
• zuul.routes.<route>.serviceId=/account-demo：來(lái)指定服務(wù)名蝗岖。

而大多數(shù)情況下，我們的<route>路由名稱(chēng)往往和 服務(wù)名會(huì)寫(xiě)成一樣的榔至。因此Zuul就提供了一種簡(jiǎn)化的配置語(yǔ)法：zuul.routes.<serviceId>=<path>

比方說(shuō)上面我們關(guān)于account-demo的配置可以簡(jiǎn)化為一條：

zuul:
  routes:
    account-demo: /account-demo/** # 這里是映射路徑

省去了對(duì)服務(wù)名稱(chēng)的配置抵赢。

1.6.默認(rèn)的路由規(guī)則

在使用Zuul的過(guò)程中，上面講述的規(guī)則已經(jīng)大大的簡(jiǎn)化了配置項(xiàng)唧取。但是當(dāng)服務(wù)較多時(shí)铅鲤，配置也是比較繁瑣的。因此Zuul就指定了默認(rèn)的路由規(guī)則：

• 默認(rèn)情況下枫弟，一切服務(wù)的映射路徑就是服務(wù)名本身邢享。
  • 例如服務(wù)名為：account-demo，則默認(rèn)的映射路徑就是：/account-demo/**

也就是說(shuō)淡诗，剛才的映射規(guī)則我們完全不配置也是OK的骇塘，不信就試試看。

1.7.路由前綴

配置示例：

zuul:
  prefix: /api # 添加路由前綴
  routes:
      account-demo: # 這里是路由id韩容，隨意寫(xiě)
        path: /account-demo/** # 這里是映射路徑
        service-id: account-demo # 指定服務(wù)名稱(chēng)

我們通過(guò)zuul.prefix=/api來(lái)指定了路由的前綴款违，這樣在發(fā)起請(qǐng)求時(shí)，路徑就要以/api開(kāi)頭群凶。

路徑/api/account-demo/account/get/1將會(huì)被代理到account-demo/account/get/1

1.8.過(guò)濾器

Zuul作為網(wǎng)關(guān)的其中一個(gè)重要功能奠货，就是實(shí)現(xiàn)請(qǐng)求的鑒權(quán)。而這個(gè)動(dòng)作我們往往是通過(guò)Zuul提供的過(guò)濾器來(lái)實(shí)現(xiàn)的座掘。

1.8.1.ZuulFilter

ZuulFilter是過(guò)濾器的頂級(jí)父類(lèi)递惋。在這里我們看一下其中定義的4個(gè)最重要的方法：

public abstract ZuulFilter implements IZuulFilter{

    abstract public String filterType();

    abstract public int filterOrder();
    
    boolean shouldFilter();// 來(lái)自IZuulFilter

    Object run() throws ZuulException;// IZuulFilter
}

• shouldFilter：返回一個(gè)Boolean值，判斷該過(guò)濾器是否需要執(zhí)行溢陪。返回true執(zhí)行萍虽，返回false不執(zhí)行。
• run：過(guò)濾器的具體業(yè)務(wù)邏輯形真。
• filterType：返回字符串杉编，代表過(guò)濾器的類(lèi)型。包含以下4種：
  • pre：請(qǐng)求在被路由之前執(zhí)行
  • routing：在路由請(qǐng)求時(shí)調(diào)用
  • post：在routing和errror過(guò)濾器之后調(diào)用
  • error：處理請(qǐng)求時(shí)發(fā)生錯(cuò)誤調(diào)用
• filterOrder：通過(guò)返回的int值來(lái)定義過(guò)濾器的執(zhí)行順序咆霜，數(shù)字越小優(yōu)先級(jí)越高邓馒。

1.8.2.過(guò)濾器執(zhí)行生命周期：

這張是Zuul官網(wǎng)提供的請(qǐng)求生命周期圖，清晰的表現(xiàn)了一個(gè)請(qǐng)求在各個(gè)過(guò)濾器的執(zhí)行順序蛾坯。

image.png

• 正常流程：
  • 請(qǐng)求到達(dá)首先會(huì)經(jīng)過(guò)pre類(lèi)型過(guò)濾器光酣，而后到達(dá)routing類(lèi)型，進(jìn)行路由脉课，請(qǐng)求就到達(dá)真正的服務(wù)提供者救军，執(zhí)行請(qǐng)求财异，返回結(jié)果后，會(huì)到達(dá)post過(guò)濾器唱遭。而后返回響應(yīng)戳寸。
• 異常流程：
  • 整個(gè)過(guò)程中，pre或者routing過(guò)濾器出現(xiàn)異常拷泽，都會(huì)直接進(jìn)入error過(guò)濾器疫鹊，再error處理完畢后，會(huì)將請(qǐng)求交給POST過(guò)濾器司致，最后返回給用戶(hù)拆吆。
  • 如果是error過(guò)濾器自己出現(xiàn)異常，最終也會(huì)進(jìn)入POST過(guò)濾器蚌吸，而后返回。
  • 如果是POST過(guò)濾器出現(xiàn)異常砌庄，會(huì)跳轉(zhuǎn)到error過(guò)濾器羹唠，但是與pre和routing不同的時(shí)，請(qǐng)求不會(huì)再到達(dá)POST過(guò)濾器了娄昆。

所有內(nèi)置過(guò)濾器列表：

image.png

1.8.3.使用場(chǎng)景

場(chǎng)景非常多：

• 請(qǐng)求鑒權(quán)：一般放在pre類(lèi)型佩微，如果發(fā)現(xiàn)沒(méi)有訪(fǎng)問(wèn)權(quán)限，直接就攔截了
• 異常處理：一般會(huì)在error類(lèi)型和post類(lèi)型過(guò)濾器中結(jié)合來(lái)處理萌焰。
• 服務(wù)調(diào)用時(shí)長(zhǎng)統(tǒng)計(jì)：pre和post結(jié)合使用哺眯。

1.9.自定義過(guò)濾器

接下來(lái)我們來(lái)自定義一個(gè)過(guò)濾器，模擬一個(gè)登錄的校驗(yàn)扒俯∧套浚基本邏輯：如果請(qǐng)求中有access-token參數(shù)，則認(rèn)為請(qǐng)求有效撼玄，放行夺姑。

1.9.1.定義過(guò)濾器類(lèi)

@Component
public class LoginFilter extends ZuulFilter{
    @Override
    public String filterType() {
        // 登錄校驗(yàn)，肯定是在前置攔截
        return "pre";
    }

    @Override
    public int filterOrder() {
        // 順序設(shè)置為1
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        // 返回true掌猛，代表過(guò)濾器生效盏浙。
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        // 登錄校驗(yàn)邏輯。
        // 1）獲取Zuul提供的請(qǐng)求上下文對(duì)象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2) 從上下文中獲取request對(duì)象
        HttpServletRequest req = ctx.getRequest();
        // 3) 從請(qǐng)求中獲取token
        String token = req.getParameter("access-token");
        // 4) 判斷
        if(token == null || "".equals(token.trim())){
            // 沒(méi)有token荔茬，登錄校驗(yàn)失敗废膘，攔截
            ctx.setSendZuulResponse(false);
            // 返回401狀態(tài)碼。也可以考慮重定向到登錄頁(yè)慕蔚。
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校驗(yàn)通過(guò)丐黄，可以考慮把用戶(hù)信息放入上下文，繼續(xù)向后執(zhí)行
        return null;
    }
}

1.9.2.測(cè)試

沒(méi)有token參數(shù)時(shí)孔飒，訪(fǎng)問(wèn)失敺趸：

image.png

添加token參數(shù)后：

image.png

1.10.負(fù)載均衡和熔斷

Zuul中默認(rèn)就已經(jīng)集成了Ribbon負(fù)載均衡和Hystix熔斷機(jī)制许起。但是所有的超時(shí)策略都是走的默認(rèn)值，比如熔斷超時(shí)時(shí)間只有1S菩鲜，很容易就觸發(fā)了园细。因此建議我們手動(dòng)進(jìn)行配置：

zuul:
  retryable: true
ribbon:
  ConnectTimeout: 250 # 連接超時(shí)時(shí)間(ms)
  ReadTimeout: 2000 # 通信超時(shí)時(shí)間(ms)
  OkToRetryOnAllOperations: true # 是否對(duì)所有操作重試
  MaxAutoRetriesNextServer: 2 # 同一服務(wù)不同實(shí)例的重試次數(shù)
  MaxAutoRetries: 1 # 同一實(shí)例的重試次數(shù)
hystrix:
  command:
    default:
        execution:
          isolation:
            thread:
              timeoutInMillisecond: 6000 # 熔斷超時(shí)時(shí)長(zhǎng)：6000ms

1.11完整配置

spring:
  application:
    name: zuul-demo
server:
  port: 6003


logging:
  level:
    com.d4c: debug


eureka:
  instance:
    prefer-ip-address: false
  client:
    registry-fetch-interval-seconds: 5 # 獲取服務(wù)列表的周期：5s
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://peer1:6001/eureka/,http://peer2:6002/eureka/
#zuul:
#  routes:
#    account-demo: # 這里是路由id，隨意寫(xiě)
#      path: /account-demo/** # 這里是映射路徑
#      url: http://127.0.0.1:6060 # 映射路徑對(duì)應(yīng)的實(shí)際url地址

#zuul:
#  routes:
#    account-demo: # 這里是路由id接校，隨意寫(xiě)
#      path: /account-demo/** # 這里是映射路徑
#      serviceId: account-demo # 指定服務(wù)名稱(chēng)

#zuul:
#  routes:
#    account-demo: /account-demo/** # 這里是映射路徑

#zuul:
#  prefix: /api # 添加路由前綴
#  routes:
#    account-demo: # 這里是路由id猛频，隨意寫(xiě)
#      path: /account-demo/** # 這里是映射路徑
#      service-id: account-demo # 指定服務(wù)名稱(chēng)


zuul:
  prefix: /api # 添加路由前綴
  retryable: true
ribbon:
  ConnectTimeout: 250 # 連接超時(shí)時(shí)間(ms)
  ReadTimeout: 2000 # 通信超時(shí)時(shí)間(ms)
  OkToRetryOnAllOperations: true # 是否對(duì)所有操作重試
  MaxAutoRetriesNextServer: 2 # 同一服務(wù)不同實(shí)例的重試次數(shù)
  MaxAutoRetries: 1 # 同一實(shí)例的重試次數(shù)
hystrix:
  command:
    default:
      execution:
        isolation:
          thread:
            timeoutInMillisecond: 6000 # 熔斷超時(shí)時(shí)長(zhǎng)：6000ms