简介

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