通過之前幾篇Spring Cloud中幾個核心元件的介紹，我們已經可以構建一個簡略的（不夠完善）微服務架構了。比如下圖所示： 願意瞭解原始碼的朋友直接求求交流分享技術 一零三八七七四六二六
在該架構中，我們的服務叢集包含：內部服務Service A和Service B，他們都會註冊與訂閱服務至Eureka Server，而Open Service是一個對外的服務，通過均衡負載公開至服務呼叫方。本文我們把焦點聚集在對外服務這塊，這樣的實現是否合理，或者是否有更好的實現方式呢？
先來說說這樣架構需要做的一些事兒以及存在的不足：
首先，破壞了服務無狀態特點。為了保證對外服務的安全性，我們需要實現對服務訪問的許可權控制，而開放服務的許可權控制機制將會貫穿並汙染整個開放服務的業務邏輯，這會帶來的最直接問題是，破壞了服務叢集中REST API無狀態的特點。從具體開發和測試的角度來說，在工作中除了要考慮實際的業務邏輯之外，還需要額外可續對介面訪問的控制處理。 其次，無法直接複用既有介面。當我們需要對一個即有的叢集內訪問介面，實現外部服務訪問時，我們不得不通過在原有介面上增加校驗邏輯，或增加一個代理呼叫來實現許可權控制，無法直接複用原有的介面。 面對類似上面的問題，我們要如何解決呢？下面進入本文的正題：服務閘道器！
為了解決上面這些問題，我們需要將許可權控制這樣的東西從我們的服務單元中抽離出去，而最適合這些邏輯的地方就是處於對外訪問最前端的地方，我們需要一個更強大一些的均衡負載器，它就是本文將來介紹的：服務閘道器。
服務閘道器是微服務架構中一個不可或缺的部分。通過服務閘道器統一向外系統提供REST API的過程中，除了具備服務路由、均衡負載功能之外，它還具備了許可權控制等功能。Spring Cloud Netflix中的Zuul就擔任了這樣的一個角色，為微服務架構提供了前門保護的作用，同時將許可權控制這些較重的非業務邏輯內容遷移到服務路由層面，使得服務叢集主體能夠具備更高的可複用性和可測試性。
下面我們通過例項例子來使用一下Zuul來作為服務的路有功能。
準備工作
在使用Zuul之前，我們先構建一個服務註冊中心、以及兩個簡單的服務，比如：我構建了一個service-A，一個service-B。然後啟動eureka-server和這兩個服務。通過訪問eureka-server，我們可以看到service-A和service-B已經註冊到了服務中心。
<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>
複製程式碼應用主類使用@EnableZuulProxy註解開啟Zuul
@EnableZuulProxy
@SpringCloudApplication
public class Application {
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
}
複製程式碼這裡用了@SpringCloudApplication註解，之前沒有提過，通過原始碼我們看到，它整合了@SpringBootApplication、@EnableDiscoveryClient、@EnableCircuitBreaker，主要目的還是簡化配置。這幾個註解的具體作用這裡就不做詳細介紹了，之前的文章已經都介紹過。
application.properties中配置Zuul應用的基礎資訊，如：應用名、服務埠等。
spring.application.name=api-gateway
server.port=5555
複製程式碼Zuul配置 完成上面的工作後，Zuul已經可以執行了，但是如何讓它為我們的微服務叢集服務，還需要我們另行配置，下面詳細的介紹一些常用配置內容。
服務路由 通過服務路由的功能，我們在對外提供服務的時候，只需要通過暴露Zuul中配置的呼叫地址就可以讓呼叫方統一的來訪問我們的服務，而不需要了解具體提供服務的主機資訊了。
在Zuul中提供了兩種對映方式：
通過url直接對映，我們可以如下配置：
# routes to url
zuul.routes.api-a-url.path=/api-a-url/**
zuul.routes.api-a-url.url=http://localhost:2222/
複製程式碼該配置，定義了，所有到Zuul的中規則為：/api-a-url/**的訪問都對映到http://localhost:2222/上，也就是說當我們訪問http://localhost:5555/api-a-url/add?a=1&b=2的時候，Zuul會將該請求路由到：http://localhost:2222/add?a=1&b=2上。
其中，配置屬性zuul.routes.api-a-url.path中的api-a-url部分為路由的名字，可以任意定義，但是一組對映關係的path和url要相同，下面講serviceId時候也是如此。
通過url對映的方式對於Zuul來說，並不是特別友好，Zuul需要知道我們所有為服務的地址，才能完成所有的對映配置。而實際上，我們在實現微服務架構時，服務名與服務例項地址的關係在eureka server中已經存在了，所以只需要將Zuul註冊到eureka server上去發現其他服務，我們就可以實現對serviceId的對映。例如，我們可以如下配置：
zuul.routes.api-a.path=/api-a/**
zuul.routes.api-a.serviceId=service-A
zuul.routes.api-b.path=/api-b/**
zuul.routes.api-b.serviceId=service-B
eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/
複製程式碼針對我們在準備工作中實現的兩個微服務service-A和service-B，定義了兩個路由api-a和api-b來分別對映。另外為了讓Zuul能發現service-A和service-B，也加入了eureka的配置。
接下來，我們將eureka-server、service-A、service-B以及這裡用Zuul實現的服務閘道器啟動起來，在eureka-server的控制頁面中，我們可以看到分別註冊了service-A、service-B以及api-gateway
http://localhost:5555/api-a/add?a=1&b=2： 通過serviceId對映訪問service-A中的add服務 http://localhost:5555/api-b/add?a=1&b=2： 通過serviceId對映訪問service-B中的add服務 http://localhost:5555/api-a-url/add?a=1&b=2： 通過url對映訪問service-A中的add服務
推薦使用serviceId的對映方式，除了對Zuul維護上更加友好之外，serviceId對映方式還支援了斷路器，對於服務故障的情況下，可以有效的防止故障蔓延到服務閘道器上而影響整個系統的對外服務
服務過濾 在完成了服務路由之後，我們對外開放服務還需要一些安全措施來保護客戶端只能訪問它應該訪問到的資源。所以我們需要利用Zuul的過濾器來實現我們對外服務的安全控制。
在服務閘道器中定義過濾器只需要繼承ZuulFilter抽象類實現其定義的四個抽象函式就可對請求進行攔截與過濾。
比如下面的例子，定義了一個Zuul過濾器，實現了在請求被路由之前檢查請求中是否有accessToken引數，若有就進行路由，若沒有就拒絕訪問，返回401 Unauthorized錯誤。
public class AccessFilter extends ZuulFilter {
private static Logger log = LoggerFactory.getLogger(AccessFilter.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();
log.info(String.format("%s request to %s", request.getMethod(), request.getRequestURL().toString()));
Object accessToken = request.getParameter("accessToken");
if(accessToken == null) {
log.warn("access token is empty");
ctx.setSendZuulResponse(false);
ctx.setResponseStatusCode(401);
return null;
}
log.info("access token ok");
return null;
}
}
複製程式碼自定義過濾器的實現，需要繼承ZuulFilter，需要重寫實現下面四個方法：
filterType：返回一個字串代表過濾器的型別，在zuul中定義了四種不同生命週期的過濾器型別，具體如下：
pre：可以在請求被路由之前呼叫
routing：在路由請求時候被呼叫
post：在routing和error過濾器之後被呼叫
error：處理請求時發生錯誤時被呼叫
filterOrder：通過int值來定義過濾器的執行順序
shouldFilter：返回一個boolean型別來判斷該過濾器是否要執行，所以通過此函式可實現過濾器的開關。在上例中，我們直接返回true，所以該過濾器總是生效。
run：過濾器的具體邏輯。需要注意，這裡我們通過ctx.setSendZuulResponse(false)令zuul過濾該請求，不對其進行路由，然後通過ctx.setResponseStatusCode(401)設定了其返回的錯誤碼，當然我們也可以進一步優化我們的返回，比如，通過ctx.setResponseBody(body)對返回body內容進行編輯等。
在實現了自定義過濾器之後，還需要例項化該過濾器才能生效，我們只需要在應用主類中增加如下內容：
@EnableZuulProxy
@SpringCloudApplication
public class Application {
public static void main(String[] args) {
new SpringApplicationBuilder(Application.class).web(true).run(args);
}
@Bean
public AccessFilter accessFilter() {
return new AccessFilter();
}
}
複製程式碼啟動該服務閘道器後，訪問：
http://localhost:5555/api-a/add?a=1&b=2： 返回401錯誤
http://localhost:5555/api-a/add?a=1&b=2&accessToken=token： 正確路由到server-A，並返回計算內容
最後，總結一下為什麼服務閘道器是微服務架構的重要部分，是我們必須要去做的原因：
不僅僅實現了路由功能來遮蔽諸多服務細節，更實現了服務級別、均衡負載的路由。 實現了介面許可權校驗與微服務業務邏輯的解耦。通過服務閘道器中的過濾器，在各生命週期中去校驗請求的內容，將原本在對外服務層做的校驗前移，保證了微服務的無狀態性，同時降低了微服務的測試難度，讓服務本身更集中關注業務邏輯的處理。 實現了斷路器，不會因為具體微服務的故障而導致服務閘道器的阻塞，依然可以對外服務。資料原始碼來源