SpringCloud(五)Zuul閘道器與分散式配置中心
在 Spring Cloud 微服務系統中,一種常見的負載均衡方式是,客戶端的請求首先經過負載均衡(Ngnix),再到達服務閘道器(Zuul 叢集),然後再到具體的服務。服務統一註冊到高可用的服務註冊中心叢集,服務的所有的配置檔案由配置服務管理,配置服務的配置檔案放在 GIT 倉庫,方便開發人員隨時改配置。
一、Zuul
Zuul包含了對請求的路由和過濾兩個最主要的功能: 其中路由功能負責將外部請求轉發到具體的微服務例項上,是實現外部訪問統一入口的基礎而過濾器功能則負責對請求的處理過程進行干預,是實現請求校驗、服務聚合等功能的基礎.
Zuul和Eureka進行整合,將Zuul自身註冊為Eureka服務治理下的應用,同時從Eureka中獲得其他微服務的訊息,也即以後的訪問微服務都是通過Zuul跳轉後獲得。Zuul服務最終還是會註冊進Eureka。
總體來說Zuul提供代理、路由、過濾三大功能。
1.1 建立Zuul專案
建立一個spring-cloud-learn-zuul專案,建立方式與之前相同,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> <parent> <groupId>com.yuanqinnan</groupId> <artifactId>spring-cloud-learn-parent</artifactId> <version>1.0.0-SNAPSHOT</version> </parent> <artifactId>spring-cloud-learn-zuul</artifactId> <packaging>jar</packaging> <name>spring-cloud-learn-zuul</name> <dependencies> <!-- Spring Boot Begin --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- Spring Boot End --> <!-- Spring Cloud Begin --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-zuul</artifactId> </dependency> <!-- Spring Cloud End --> </dependencies> </project>
新建啟動類ZuulApplication,增加@EnableZuulProxy註解
@SpringBootApplication @EnableEurekaClient @EnableZuulProxy public class ZuulApplication { public static void main(String[] args) { SpringApplication.run(ZuulApplication.class, args); } }
application.yml配置如下:
spring: application: name: spring-cloud-learn-zuul server: port: 8769 eureka: client: serviceUrl: defaultZone: http://localhost:8761/eureka/ zuul: routes: api-a: path: /api/a/** serviceId: spring-cloud-learn-consumer-dept-ribbon api-b: path: /api/b/** serviceId: spring-cloud-learn-consumer-dept-feign
這個配置檔案也很好理解,主要是配置路由:
-
以
/api/a
開頭的請求都轉發給spring-cloud-learn-consumer-dept-ribbon
服務 -
以
/api/b
開頭的請求都轉發給spring-cloud-learn-consumer-dept-feign
服務
然後再啟動之前的所有專案
開啟瀏覽器訪問:http://localhost:8769/api/a/hi?message=HelloZuul 瀏覽器顯示
Hi,your message is :"HelloZuul" i am from port:8763
開啟瀏覽器訪問:http://localhost:8769/api/a/hi?message=HelloZuul 瀏覽器顯示
Hi,your message is : HelloZuul i am from port : 8763
1.2 失敗時的回撥
由於網路震盪或者一些未知原因,可能會導致閘道器呼叫失敗,這個時候我們需要配置一個閘道器路由失敗時的回撥,繼承FallbackProvider
@Component public class ConsumerDeptFeignFallbackProvider implements FallbackProvider { @Override public String getRoute() { // ServiceId,如果需要所有呼叫都支援回退,則 return "*" 或 return null return "spring-cloud-learn-consumer-dept-feign"; } /** * 如果請求服務失敗,則返回指定的資訊給呼叫者 * @param * @return * @date */ @Override public ClientHttpResponse fallbackResponse(String route, Throwable cause) { return new ClientHttpResponse() { /** * 閘道器向 api 服務請求失敗了,但是消費者客戶端向閘道器發起的請求是成功的, * 不應該把 api 的 404,500 等問題拋給客戶端 * 閘道器和 api 服務叢集對於客戶端來說是黑盒 * @return * @throws IOException */ @Override public HttpStatus getStatusCode() throws IOException { return HttpStatus.OK; } @Override public int getRawStatusCode() throws IOException { return HttpStatus.OK.value(); } @Override public String getStatusText() throws IOException { return HttpStatus.OK.getReasonPhrase(); } @Override public void close() { } @Override public InputStream getBody() throws IOException { ObjectMapper objectMapper = new ObjectMapper(); Map<String, Object> map = new HashMap<>(); map.put("status", 200); map.put("message", "無法連線,請檢查您的網路"); return new ByteArrayInputStream(objectMapper.writeValueAsString(map).getBytes("UTF-8")); } @Override public HttpHeaders getHeaders() { HttpHeaders headers = new HttpHeaders(); // 和 getBody 中的內容編碼一致 headers.setContentType(MediaType.APPLICATION_JSON_UTF8); return headers; } }; } }
1.3 過濾功能
Zuul 不僅僅只是路由,還有很多強大的功能,本節演示一下它的服務過濾功能,比如用在安全驗證方面。
來建立下過濾器功能:只要繼承 ZuulFilter 類並在類上增加 @Component 註解就可以使用服務過濾功能了
@Component public class LoginFilter extends ZuulFilter { private static final Logger logger = LoggerFactory.getLogger(LoginFilter.class); /** * 配置過濾型別,有四種不同生命週期的過濾器型別 * 1. pre:路由之前 * 2. routing:路由之時 * 3. post:路由之後 * 4. error:傳送錯誤呼叫 */ @Override public String filterType() { return "pre"; } /** * 配置過濾的順序 */ @Override public int filterOrder() { return 0; } /** * 配置是否需要過濾:true/需要,false/不需要 */ @Override public boolean shouldFilter() { return false; } /** * 過濾器的具體業務程式碼 * @param */ @Override public Object run() throws ZuulException { RequestContext context = RequestContext.getCurrentContext(); HttpServletRequest request = context.getRequest(); logger.info("{} >>> {}", request.getMethod(), request.getRequestURL().toString()); String token = request.getParameter("token"); if (token == null) { logger.warn("Token is empty"); context.setSendZuulResponse(false); context.setResponseStatusCode(401); try { context.getResponse().getWriter().write("Token is empty"); } catch (IOException e) { } } else { logger.info("OK"); } return null; }
這裡的四個方法:
-
filterType:返回一個字串代表過濾器的型別,在 Zuul 中定義了四種不同生命週期的過濾器型別
pre:路由之前routing:路由之時
post: 路由之後
error:傳送錯誤呼叫
-
filterOrder:過濾的順序
-
shouldFilter:是否需要過濾,這裡是 true,需要過濾
-
run:過濾器的具體業務程式碼
測試下:http://localhost:8769/api/a/hi?message=HelloZuul 網頁顯示
Token is empty
http://localhost:8769/api/b/hi?message=HelloZuul&token=123 網頁顯示
Hi,your message is :"HelloZuul" i am from port:8763
二、分散式配置中心
在分散式系統中,由於服務數量巨多,為了方便服務配置檔案統一管理,實時更新,所以需要分散式配置中心元件。在 Spring Cloud 中,有分散式配置中心元件 Spring Cloud Config ,它支援配置服務放在配置服務的記憶體中(即本地),也支援放在遠端 Git 倉庫中。在 Spring Cloud Config 元件中,分兩個角色,一是 Config Server,二是 Config Client。
2.1 Config Server專案
建立專案的方式與之前相同,新建spring-cloud-learn-config專案,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> <parent> <groupId>com.yuanqinnan</groupId> <artifactId>spring-cloud-learn-parent</artifactId> <version>1.0.0-SNAPSHOT</version> </parent> <artifactId>spring-cloud-learn-config</artifactId> <packaging>jar</packaging> <name>spring-cloud-learn-config</name> <dependencies> <!-- Spring Boot Begin --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-tomcat</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <!-- Spring Boot End --> <!-- Spring Cloud Begin --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency> <!-- Spring Cloud End --> </dependencies> </project>
新建啟動專案ConfigApplication,增加@EnableConfigServer註解
@SpringBootApplication @EnableConfigServer @EnableEurekaClient public class ConfigApplication { public static void main(String[] args) { SpringApplication.run(ConfigApplication.class, args); } }
application.yml 配置檔案
spring: application: name: spring-cloud-learn-config cloud: config: label: master server: git: uri: https://github.com/yuanqinnan/spring-cloud-config search-paths: respo username: password: server: port: 8888 eureka: client: serviceUrl: defaultZone: http://localhost:8761/eureka/
這裡注意的地方是埠號不要修改,使用8888,如要修改建立一個bootstrap.properties檔案進行修改,原因是 bootstrap
開頭的配置檔案會被優先載入和配置,切記。
這裡的配置檔案也比較好理解,相關配置說明,如下:
-
spring.cloud.config.label
:配置倉庫的分支 -
spring.cloud.config.server.git.uri
:配置 Git 倉庫地址(GitHub、GitLab、碼雲 ...) -
spring.cloud.config.server.git.search-paths
:配置倉庫路徑(存放配置檔案的目錄) -
spring.cloud.config.server.git.username
:訪問 Git 倉庫的賬號 -
spring.cloud.config.server.git.password
:訪問 Git 倉庫的密碼
注意事項:
-
如果使用 GitLab 作為倉庫的話,
git.uri
需要在結尾加上.git
,GitHub 則不用
我們想要測試的話,先在自己的github上新建一個倉庫,並新增respo資料夾(存放配置檔案的目錄),然後新增一個配置檔案consumer-dept-feign.yml(這個是配置feign專案的)即可,然後我們就可以看看效果:
訪問路徑為:http://localhost:8888/consumer-dept-feign/master 這裡路徑也好理解,這裡的是配合檔名稱加上分支名稱
在實際開發過程中,我們一般有三個環境,開發、測試、生產,而我們一般會在配置檔案後加字尾來區分,如consumer-dept-feign-dev.yml,這個時候的訪問路徑就是http://localhost:8888/consumer-dept-feign/dev/master,路徑地址增加環境地址,為了方便測試,再上傳一個consumer-dept-feign-prod.yml,作為正式環境的配置,只修改一下埠號(8766)即可。
這裡看出來,我們的feign專案的配置檔案已經換成配置中心的,那現在可以去改造feign,讓他去取配置中心的配置。
2.2 改造Config Client專案
因為我們剛剛上傳了spring-cloud-learn-consumer-dept-feign專案的配置檔案,現在拿來做下實踐,第一步還是新增依賴:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency>
啟動類沒有變化,只需修改配置檔案:
spring: cloud: config: uri: http://localhost:8888 name: consumer-dept-feign label: master profile: dev
我們看到這裡只保留了cloud.config下的相關配置,因為其他所有的配置,我們都可以去雲配置中找,這裡的配置說明如下:
相關配置說明,如下:
-
spring.cloud.config.uri
:配置服務中心的網址 -
spring.cloud.config.name
:配置檔名稱的字首 -
spring.cloud.config.label
:配置倉庫的分支 -
spring.cloud.config.profile
:配置檔案的環境標識
-
dev:表示開發環境
-
test:表示測試環境
-
prod:表示生產環境
-
現在只要能夠啟動feign專案,就說明配置中心生效了,我們啟動一下,一切順利,可以啟動成功。當我們修改 profile為prod時,啟動的就是8766埠。
&n