簡介
zuul是netflix基于jvm的路由器和服務器端負載均衡器。最常用的場景是替換nginx反向代理后臺微服務供前端ui訪問。
zuul使用ribbon來定位一個通過發現轉發的實例,所有請求都以hystrix命令執行,所以故障將顯示在hystrix指標中。
注:zuul不包括發現客戶端,因此對于基于服務id的路由,需要在類路徑中提供其中一個路由
zuul是spring cloud提供的api網關和過濾組件,它提供如下功能:
- 認證
- 過濾
- 壓力測試
- canary測試
- 動態路由
- 服務遷移
- 負載均衡
- 安全
- 靜態請求處理
- 動態流量管理
在本教程中,我們將用zuul,把web端的請求/product轉發到對應的產品服務上,并且定義一個pre過濾器來驗證是否經過了zuul的轉發。
基礎環境
- jdk 1.8
- maven 3.3.9
- intellij 2018.1
- git
項目源碼
創建zuul服務
在intellij中創建一個maven項目:
- cn.zxuqian
- apigateway
然后在pom.xml中添加如下代碼:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
|
<?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> <groupid>cn.zxuqian</groupid> <artifactid>apigateway</artifactid> <version> 1.0 -snapshot</version> <parent> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-parent</artifactid> <version> 2.0 . 1 .release</version> </parent> <dependencies> <dependency> <groupid>org.springframework.cloud</groupid> <!-- name has changed, before: spring-cloud-starter-zuul --> <artifactid>spring-cloud-starter-netflix-zuul</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-netflix-eureka-client</artifactid> </dependency> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-config</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-web</artifactid> </dependency> </dependencies> <dependencymanagement> <dependencies> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-dependencies</artifactid> <version>finchley.m9</version> <type>pom</type> <scope> import </scope> </dependency> </dependencies> </dependencymanagement> <properties> <java.version> 1.8 </java.version> </properties> <build> <plugins> <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> </plugin> </plugins> </build> <repositories> <repository> <id>spring-milestones</id> <name>spring milestones</name> <url>https: //repo.spring.io/libs-milestone</url> <snapshots> <enabled> false </enabled> </snapshots> </repository> </repositories> </project> |
需要注意的是,spring官網的教程給的zuul的artifactid為spring-cloud-starter-zuul,這個是舊版zuul的名字,在我們的finchley.m9版本中已經更名為spring-cloud-starter-netflix-zuul。
添加src/main/resources/bootstrap.yml文件,指定spring.application.name:
1
2
3
|
spring: application: name: zuul-server |
創建cn.zxuqian.application類:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
package cn.zxuqian; import cn.zxuqian.filters.prefilter; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; import org.springframework.cloud.client.discovery.enablediscoveryclient; import org.springframework.cloud.netflix.zuul.enablezuulproxy; import org.springframework.context.annotation.bean; @enablezuulproxy @enablediscoveryclient @springbootapplication public class application { public static void main(string[] args) { springapplication.run(application. class , args); } @bean public prefilter prefilter() { return new prefilter(); } } |
這里使用了@enablezuulproxy來指定使用zuul的反向代理,把我們的請求轉發到對應的服務器上。然后啟用了eureka的服務發現。zuul默認也會使用ribbon做負載均衡,所以可以通過eureka發現已注冊的服務。prefilter是一個預過濾器,用來在request請求被處理之前進行一些操作,它的代碼如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
package cn.zxuqian.filters; import com.netflix.zuul.zuulfilter; import com.netflix.zuul.context.requestcontext; import com.netflix.zuul.exception.zuulexception; import org.slf4j.logger; import org.slf4j.loggerfactory; import javax.servlet.http.httpservletrequest; public class prefilter extends zuulfilter { private static logger log = loggerfactory.getlogger(prefilter. class ); @override public string filtertype() { return "pre" ; } @override public int filterorder() { return 1 ; } @override public boolean shouldfilter() { return true ; } @override public object run() throws zuulexception { requestcontext ctx = requestcontext.getcurrentcontext(); httpservletrequest request = ctx.getrequest(); log.info(string.format( "%s 方式請求 %s" , request.getmethod(), request.getrequesturl().tostring())); return null ; } } |
filtertype - zuul內置的filter類型有四種,pre, route,post,error,分別代表請求處理前,處理時,處理后和出錯后。
filterorder - 指定了該過濾器執行的順序。
shouldfilter - 是否開啟此過濾器。
run - 過濾器的業務邏輯。這里只是簡單的log了一下reqeust的請求方式和請求的路徑。
接下來,在我們的配置中心的git倉庫中創建zuul-server.yml文件,并添加如下配置:
1
2
3
4
5
6
7
|
server: port: 8083 zuul: routes: products: path: /product/** serviceid: product-service |
這里配置了zuul的端口為8083,然后映射所有/product/的請求到我們的product-service服務上。如果不配置serviceid,那么products這個key就會默認作為serviceid,而我們的例子中,serviceid包括了-,所以在下邊顯示指定了serviceid。配置完成后提交到git。
更新productservice
productservice的uri做了一點改動,使其更符合rest風格:
1
2
3
4
5
|
@requestmapping ( "/list" ) public string productlist() { log.info( "access to /products endpoint" ); return "外套,夾克,毛衣,t恤" ; } |
這里@requestmapping匹配的路徑改為了/list,之前是/products。
更新web客戶端
在我們的web客戶端的productservice中添加一個新的方法:
1
2
3
|
public string productlistzuul() { return this .resttemplate.getforobject( "http://zuul-server/product/list" , string. class ); } |
這次我們直接請求zuul-server服務,然后由它把我們的請求反射代理到product-service服務。最后在productcontroller中添加一個請求處理方法:
1
2
3
4
|
@requestmapping ( "/product/list" ) public string productlistzuul() { return productservice.productlistzuul(); } |
用來處理/product/list請求,然后調用productservice類中的方法。
測試
使用mvn spring-boot:run啟動configserver,registry, zuulserver, productservice,web這幾個工程,然后啟動第二個productservice,使用server_port=8082 spring-boot:run。
訪問幾次http://localhost:8080/product/list,然后除了會在瀏覽器看到返回的結果,我們還會在zuulserver的命令行窗口中看到如下字樣:
get 方式請求 http://xuqians-imac:8083/product/list
然后在兩個productservice的命令行窗口中,我們還會看到隨機出現的
access to /products endpoint
說明zuulserver也會自動進行負載均衡。
總結
以上就是這篇文章的全部內容了,希望本文的內容對大家的學習或者工作具有一定的參考學習價值,如果有疑問大家可以留言交流,謝謝大家對服務器之家的支持。
原文鏈接:https://blog.csdn.net/fengqiuzhihua/article/details/80213455