##  什麼是服務閘道器

前文我們已經瞭解了構建微服務的基礎springboot，同時也能使用springboot構建服務。接下來我們就基於springboot聊一下springcloud。這個springcloud並不是一個特定的技術，它指的是微服務中一個生態體系。比如包括閘道器，註冊中心，配置中心等。今天我們就先了解一下微服務閘道器，微服務閘道器有很多種我們這次採用現在主流的spring cloud gateway來講解說明。 在微服務體系中，每個服務都是一個獨立的模組都是一個獨立執行的元件，一個完整的微服務體系是由若干個獨立的服務組成，每個服務完成自己業務模組功能。比如使用者服務提供使用者資訊相關的服務和功能，支付模組提供支付相關的功能。各個服務之間透過REST API或者RPC（以後講）進行通訊，並且一般我們微服務要做到無狀態的通訊。 我們實現微服務之後在一些方面也會帶來不方便的地方，如果網頁端或者app端需要請求修改送貨地址，還有購物之後要付款在這個場景下：

![](https://img-blog.csdnimg.cn/img_convert/5260d8667a8d74de98b89ad2dd5a8a21.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

如上圖會出現一些問題：

*   客戶端要發起多次請求，請求不同域名對應的服務，增加了通訊成本以及對客戶端程式碼的維護增加了複雜性。
*   服務驗證會在每個服務裡面單獨做，如果每個服務驗證鑑權邏輯不同就會導致客戶端反覆驗證。
*   另外如果各個服務採用的協議不同那麼對於客戶端來講那就是災難性的。

基於上面所以我們就需要一箇中間層，讓客戶端去請求中間層，至於需要請求那個服務由中介軟體去請求，最後將結果彙總返回給客戶端，這個中間層就是閘道器。

![](https://img-blog.csdnimg.cn/img_convert/42e41a81059dbde0089217705bec7bea.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

## 為什麼要使用閘道器

使用閘道器有幾個作用：

### 統一鑑權

一般我們在閘道器上進行鑑權有兩種：1，是對於請求的客戶端身份的認證。2，訪問許可權控制就是當確認使用者身份之後判斷是否有某個資源的訪問許可權。 曾經我們在單體應用中，客戶端請求驗證身份和對於資源許可權的約束比較簡單，透過請求的session就可以獲取對應的使用者以及許可權資訊，但是在微服務架構下，所有的服務都被拆成單個微服務而且還是叢集部署這種情況就會變得複雜，因為如果還是使用session的話在分散式情況每次請求不一定會落在同一臺機器上，這樣就會導致session無效。就需要我們進行額外的工作保證叢集中的session是一致的。所以我們在閘道器層進行統一的處理認證：

![](https://img-blog.csdnimg.cn/img_convert/522b5b9910cf0b72f16979422cfaa209.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

### 日誌記錄

當客戶端請求進來之後我們需要記錄當前請求的時間依賴來源地址，ip等資訊，這樣我們就可以統一的在閘道器層面上進行攔截獲取，之後輸出到日誌檔案中透過ELK元件進行輸出，記錄內容可以多維度多資訊統一記錄而不需要到具體每個服務中進行分別記錄。

### 請求分發和過濾

對於閘道器來講這個請求匹配分發是最重要的功能，我們常見的nginx其實他這個元件就有請求轉發和過濾的功能，對於閘道器來講可以對請求進行前置和後置的過濾。

*   請求分發：接收客戶端的請求，將請求對應到後面的各個微服務上並請求微服務，因為微服務粒度比較細，所以這個閘道器就可以對各個微服務進行功能性的整合最終給回客戶端。
*   過濾：閘道器會攔截所有請求，相當於spring中AOP一個橫向的切面，在這個切面上進行鑑權，限流，認證等操作。

### 灰度釋出

一般公司的網際網路產品都是迭代非常快的，基本都是小步快跑。基本是一個周釋出一個版本迭代。在這種情況下就會出現風險，比如相容性，功能完整度，時間比較短會存在bug最終產生事故等問題。這樣一般我們釋出的時候會將新的功能釋出到指定的機器上分過去一小部分流量來觀察具體情況。所以閘道器作為請求的入口就正好可以完成這個功能。

![](https://img-blog.csdnimg.cn/img_convert/c9d534526724bb2365ae3a492e1d612d.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

## 常用閘道器解決方案

一般我們常用的閘道器有幾種比如：OpenResty、Zuul、Gateway、Kong、Tyk等。我們主要是用spring體系的框架，所以我們本文針對Gateway進行講解，其它幾種閘道器實現不做重點說明，OpenResty是有nginx+lua整合的web伺服器，整合了許多三方庫和模組。Zuul其實springcloud前期也是在整合使用，到那時由於他的執行緒模型策略可能導致的效能問題最終spring選擇了自己研發的spring cloud gateway。

## 環境準備

本文我們使用一個簡單的案例來演示一下spring cloud gateway的使用方法，首先我們需要住呢比2個spring boot的應用，具體建立方式請參考我們本專題第二篇文章。

*   spring-cloud-gateway-service1  這個是一個微服務
*   Spring-cloud-gateway-wangguan  閘道器微服務

我們根據以前專題建立了2個服務第一個服務我們新增一個controller

```
@RequestMapping(value = {"/getUser"}, method = RequestMethod.GET)
    public String getUser() {
        Map<string> user = new HashMap<>();
        user.put("name", "張三");
        user.put("age", "45");
        String s = JSONObject.toJSONString(user);
        return s;
    }
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

第二個閘道器服務我們增加pom依賴

```
        <dependency>
            <groupid>org.springframework.cloud</groupid>
            spring-cloud-starter-gateway
            <version>2.0.4.RELEASE</version>
        </dependency>
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

在application.yml中新增gateway路由

```
spring:
  cloud:
    gateway:
      routes:
      - predicates:
            - Path =/gateway/**  #匹配規則
        uri: http://localhost:8099/getUser    #服務1的訪問地址
        filters:
            - StripRrefix: 1 #去掉字首
 server：
    port: 8077
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

針對上面配置含義說明：

*   uri：目標服務地址，可配置uri和lb：//應用服務名稱
*   predicates：匹配條件，根據規則匹配是否請求該路由
*   filters: 過濾規則，這個過濾包含前置過濾和後置過濾，
*   StripPrefix=1，表示去掉字首，即在轉發目標url的時候去掉’gateway'

這個時候我們啟動服務之後發現服務啟動日誌：Netty started on port(s): 8077.說明我們服務成功了，並且閘道器依賴的是nettyserver啟動幾個服務監聽。 我們訪問：

> curl [http://localhost:8077/gateway/getUser](https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8077%2Fgateway%2FgetUser "http://localhost:8077/gateway/getUser")

在配置正確的情況下將會返回服務返回的結果。

## spring cloud gateway原理

![](https://img-blog.csdnimg.cn/img_convert/f9b8817ac880ee686bde16f70fe3c81e.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

上圖是gateway官方給出的原理圖，可能不太好理解，我們自己畫個圖輔助理解一下： 如上圖有幾個概念先說明一下：

*   路由（Route）：是閘道器的元件之一，由id ，uri ，predicate ，filter組成。
*   斷言（Predicate）：匹配http請求中的內容。如果返回結果是true則就按當前的router進行轉發。
*   過濾器（Filter）：為請求提供前置和後置的過濾。

當客戶端傳送請求到閘道器時，閘道器會根據一系列的Predicate的匹配結果來決定訪問哪個route路由，然後根據過濾器進行請求處理，過濾器可以在請求傳送到後端服務之前和之後執行。

## 路由規則

spring cloud gateway中提供了路由匹配機制，比如我們前文配置的Path=/gateway/** . 意思就是透過Path的屬性來匹配URL字首是/gateway/的請求。其實spring cloud gateway給我們提供了很多規則供我們使用。 每一個Predicate的使用，你可以理解為：當滿足這種條件後才會被轉發，如果是多個，那就是都滿足的情況下被轉發。這些Predict的原始碼在org.springframework.cloud.gateway.handler.predicate包中我們簡單看一下：

![](https://img-blog.csdnimg.cn/img_convert/35b32b711fdfc3f10eeef6fec5a85ee8.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

## 動態路由

gateway配置路由主要有兩種方式，1.用yml配置檔案，2.寫在程式碼裡。而無論是 yml，還是程式碼配置，啟動閘道器後將無法修改路由配置，如有新服務要上線，則需要先把閘道器下線，修改 yml 配置後，再重啟閘道器。這種方式如果在閘道器上沒有優雅停機就會出現服務間斷，這無疑是不能被接受的。gateway閘道器啟動時，路由資訊預設會載入記憶體中，路由資訊被封裝到 RouteDefinition 物件中，配置多個RouteDefinition組成gateway的路由系統，RouteDefinition中的屬性與上面程式碼配置的屬性一一對應:

![](https://img-blog.csdnimg.cn/img_convert/9dade665b92d062479dbdc2a658a2c8c.webp?x-oss-process=image/format,png)

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

那麼就需要我們的動態路由來解決這個問題了。Spring Cloud Gateway 提供了 Endpoint 端點，暴露路由資訊，有獲取所有路由、重新整理路由、檢視單個路由、刪除路由等方法，具體實現類org.springframework.cloud.gateway.actuate.GatewayControllerEndpoint ，想訪問端點中的方法需要新增 spring-boot-starter-actuator 註解，並在配置檔案中暴露所有端點。編寫動態路由實現類，需實現ApplicationEventPublisherAware介面。

```
/**
 * 動態路由服務
 */
@Service
public class GoRouteServiceImpl implements ApplicationEventPublisherAware {
    @Autowired
    private RouteDefinitionWriter routeDefinitionWriter;
    private ApplicationEventPublisher publisher;
    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.publisher = applicationEventPublisher;
    }
    //增加路由
    public String add(RouteDefinition definition) {
        routeDefinitionWriter.save(Mono.just(definition)).subscribe();
        this.publisher.publishEvent(new RefreshRoutesEvent(this));
        return "success";
    }
    //更新路由
    public String update(RouteDefinition definition) {
        try {
            delete(definition.getId());
        } catch (Exception e) {
            return "update fail,not find route  routeId: "+definition.getId();
        }
        try {
            routeDefinitionWriter.save(Mono.just(definition)).subscribe();
            this.publisher.publishEvent(new RefreshRoutesEvent(this));
            return "success";
        } catch (Exception e) {
            return "update route  fail";
        }
    }
    //刪除路由
    public Mono<responseentity>> delete(String id) {
        return this.routeDefinitionWriter.delete(Mono.just(id)).then(Mono.defer(() -> {
            return Mono.just(ResponseEntity.ok().build());
        })).onErrorResume((t) -> {
            return t instanceof NotFoundException;
        }, (t) -> {
            return Mono.just(ResponseEntity.notFound().build());
        });
    }
}
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

編寫 Rest介面，透過這些介面實現動態路由功能.

```
@RestController
@RequestMapping("/changeRoute")
public class ChangeRouteController {
    @Autowired
    private GoRouteServiceImpl goRouteServiceImpl;
    //增加路由
    @PostMapping("/add")
    public String add(@RequestBody GatewayRouteDefinition gwdefinition) {
        String flag = "fail";
        try {
            RouteDefinition definition = assembleRouteDefinition(gwdefinition);
            flag = this.goRouteService.add(definition);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return flag;
    }
    //刪除路由
    @DeleteMapping("/routes/{id}")
    public Mono<responseentity>> delete(@PathVariable String id) {
        try {
            return this.goRouteService.delete(id);
        }catch (Exception e){
            e.printStackTrace();
        }
        return null;
    }
    //更新路由
    @PostMapping("/update")
    public String update(@RequestBody GatewayRouteDefinition gwdefinition) {
        RouteDefinition definition = assembleRouteDefinition(gwdefinition);
        return this.goRouteService.update(definition);
    }
    //把傳遞進來的引數轉換成路由物件
    private RouteDefinition assembleRouteDefinition(GatewayRouteDefinition gwdefinition) {
        RouteDefinition definition = new RouteDefinition();
        definition.setId(gwdefinition.getId());
        definition.setOrder(gwdefinition.getOrder());
        //設定斷言
        List<predicatedefinition> pdList=new ArrayList<>();
        List<gatewaypredicatedefinition> gatewayPredicateDefinitionList=gwdefinition.getPredicates();
        for (GatewayPredicateDefinition gpDefinition: gatewayPredicateDefinitionList) {
            PredicateDefinition predicate = new PredicateDefinition();
            predicate.setArgs(gpDefinition.getArgs());
            predicate.setName(gpDefinition.getName());
            pdList.add(predicate);
        }
        definition.setPredicates(pdList);
        //設定過濾器
        List<filterdefinition> filters = new ArrayList();
        List<gatewayfilterdefinition> gatewayFilters = gwdefinition.getFilters();
        for(GatewayFilterDefinition filterDefinition : gatewayFilters){
            FilterDefinition filter = new FilterDefinition();
            filter.setName(filterDefinition.getName());
            filter.setArgs(filterDefinition.getArgs());
            filters.add(filter);
        }
        definition.setFilters(filters);
        URI uri = null;
        if(gwdefinition.getUri().startsWith("http")){
            uri = UriComponentsBuilder.fromHttpUrl(gwdefinition.getUri()).build().toUri();
        }else{
            // uri為 lb://consumer-service 時使用下面的方法
            uri = URI.create(gwdefinition.getUri());
        }
        definition.setUri(uri);
        return definition;
    }
}
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

其實一般我們很少透過API去呼叫rest服務去增刪路由資訊，一般我們主流都是透過整合nacos的config功能動態增添路由。與nacos整合我們後面在講。

## 過濾器

閘道器過濾器Filter分為Pre和Post即前置過濾和後置過濾器。分別為在具體請求轉發到後端微服務之前執行和將結果返回給客戶端之前執行。 內建的GatewayFilter比較多大概有19種，如：

*   AddRequestHeader GatewayFilter Factory ，
*   AddRequestParameter GatewayFilter Factory ，
*   AddResponseHeader GatewayFilter Factory

就不過多舉例了，使用起來也比較簡單，我們著重看一下如何自定義過濾器：

1.  全域性過濾器：全域性過濾器，對所有的路由都有效，所有不用在配置檔案中配置，主要實現了GlobalFilter 和 Ordered介面，並將過濾器註冊到spring 容器。

```
@Service
@Slf4j
public class AllDefineFilter implements GlobalFilter,Ordered{
    @Override
    public Mono<void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("[pre]-Enter AllDefineFilter");
        return chain.filter(exchange).then(Mono.fromRunnable(()->{
            log.info("[post]-Return Result");
        }));
    }
    @Override
    public int getOrder() {
        return 0;
    }
}
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

1.  區域性過濾器：需要在配置檔案中配置，如果配置，則該過濾器才會生效。主要實現GatewayFilter, Ordered介面，並透過AbstractGatewayFilterFactory的子類註冊到spring容器中，當然也可以直接繼承AbstractGatewayFilterFactory，在裡面寫過濾器邏輯，還可以從配置檔案中讀取外部資料。

```
@Component
@Slf4j
public class UserDefineGatewayFilter extends AbstractGatewayFilterFactory<userdefinegatewayfilter.gpconfig>{

public UserDefineGatewayFilter(){
        super(GpConfig.class);
    }

@Override
    public GatewayFilter apply(GpConfig config) {
        return ((exchange, chain) -> {
            log.info("[Pre] Filter Request,name:"+config.getName());
            return chain.filter(exchange).then(Mono.fromRunnable(()->{
                log.info("[Post] Response Filter");
            }));
        });
    }

public static class UserConfig{
        private String name;

public String getName() {
            return name;
        }

public void setName(String name) {
            this.name = name;
        }
    }
}
複製程式碼
```

![](data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== "點選並拖拽以移動")

這塊需要有注意的地方：

*   類名必須要統一以GatewayFiterFactory結尾，因為預設情況下過濾器的name會採用該自定義類的字首。這裡的name=UserDefine，也就是在yml中filters中的name值。
*   在apply方法中，同時包含Pre和Post過濾。在then方法中是請求執行結束之後的後置處理。
*   UserConfig是一個配置類，該類中只有一個屬性name。這個屬性可以在ym檔案中使用。
*   該類需要裝載到Spring IoC容器，此處使用@Component註解實現。

其實整個spring cloud gateway 與spring cloud alibaba整合的很好，可以與nacos整合可以與sentinel整合進行限流，這個後期我們單獨進行講解。

作者：我是大明哥
連結：https://juejin.cn/post/6923100060913926157
來源：稀土掘金
著作權歸作者所有。商業轉載請聯絡作者獲得授權，非商業轉載請註明出處。

</userdefinegatewayfilter.gpconfig></void></gatewayfilterdefinition></filterdefinition></gatewaypredicatedefinition></predicatedefinition></responseentity></responseentity></string>

深入Java微服務之閘道器係列2：常見Java閘道器實現方案對比

相關文章