1、概述简介
Zuul包含了对请求的路由
和过滤
两个最主要的功能。其中路由功能负责将外部请求转发到具体的微服务实例上,是实现外部访问统一入口的基础,过滤器功能则负责对请求的处理过程进行干预,是实现请求校验、服务聚合等功能的基础。
Zuul和Eureka进行整合,将Zuul自身注册为Eureka服务治理下的应用,同时还可以从Eureka中获取其他微服务的消息,以后访问微服务都是通过Zuul跳转后获得
。
注意:Zuul服务最终还是会注册进Eureka,提供 = 代理 + 路由 + 过滤三大功能
。
Zuul是spring cloud中的微服务网关。网关: 是一个网络整体系统中的前置门户入口。请求首先通过网关,进行路径的路由,定位到具体的服务节点上。
Zuul是一个微服务网关,首先是一个微服务。也是会在Eureka注册中心中进行服务的注册和发现。也是一个网关,请求应该通过Zuul来进行路由。
Zuul网关不是必要的。是推荐使用的。
使用Zuul,一般在微服务数量较多(多于10个)的时候推荐使用,对服务的管理有严格要求的时候推荐使用,当微服务权限要求严格的时候推荐使用
。
2、Zuul网关的作用
网关有以下几个作用:
-
统一入口
:未全部为服务提供一个唯一的入口,网关起到外部和内部隔离
的作用,保障了后台服务
的安全性。 -
鉴权校验
:识别
每个请求的权限
,拒绝不符合要求的请求。 -
动态路由
:动态的将请求路由
到不同的后端集群中。 -
减少客户端与服务端的耦合
:服务可以独立发展,通过网关层来做映射。
3、路由基本配置
新建cloud-gateway-zuul9527
模块,修改pom.xml
,这里加入Zuul
、Eureka
、Hystrix
的依赖。
cloud-gateway-zuul9527
模块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">
<!-- 引入父级模块名称 -->
<parent>
<artifactId>cloud2020</artifactId>
<groupId>com.king.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<!-- 子模块名称 -->
<artifactId>cloud-gateway-zuul9527</artifactId>
<dependencies>
<!-- 引入zuul路由网关依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-zuul</artifactId>
<version>2.0.0.RELEASE</version>
</dependency>
<!-- 引入hystrix熔断依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>
<!-- 引用eureka-client注册服务客户端依赖 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!-- actuator监控器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!-- 引用父级spring boot的依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 配置热部署 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<!-- 引用父级的lombok依赖 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
cloud-gateway-zuul9527
模块的application.yml
文件。
# 配置服务端口号
server:
port: 9527
# 配置应用信息
spring:
application:
name: cloud-gateway-zuul # 配置应用名称
# 配置eureka
eureka:
client:
service-url:
defaultZone: http://eureka7001.com:7001/eureka/ # 入驻的服务地址
instance:
instance-id: gateway-zuul-9527 # 指定服务实例ID
prefer-ip-address: true # 访问路径可以显示IP地址
cloud-gateway-zuul9527
模块的主启动类。
package com.king.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;
/**
* @EnableZuulServer:普通ZuulServer,只支持基本的route与filter功能.
* @EnableZuulProxy:普通ZuulServer+服务发现与熔断等功能的增强版,具有反向代理功能.
*/
@EnableZuulProxy
@SpringBootApplication
public class ZuulMain9527 {
public static void main(String[] args) {
SpringApplication.run(ZuulMain9527.class, args);
}
}
启动cloud-eureka-erver7001
注册中心模版,cloud-provider-hystrix-payment8001
服务生产者模版,cloud-gateway-zuul9527
路由网关模块。
通过浏览器访问http://eureka7001.com:7001/
页面可以看到CLOUD-GATEWAY-ZUUL
跟CLOUD-PROVIDER-HYSTRIX-PAYMENT
都已经注册到注册中心了。
再访问cloud-provider-hystrix-payment8001
服务生产者模版的http://localhost:8001/payment/hystrix/ok/1
,此时可以拿到正确的结果,此时是直接访问。
再尝试通过cloud-gateway-zuul9527
路由网关模块访问cloud-provider-hystrix-payment8001
服务生产者模版的http://localhost:8001/payment/hystrix/ok/1
的API方法,访问路径http://localhost:9527/cloud-provider-hystrix-payment/payment/hystrix/ok/1
,发现也可以拿到正确的结果。
4、路由访问映射规则
这里的服务名称,是直接暴露出来的,有时,我们并不希望直接暴露服务名称,有没有办法解决这个问题呢?
找到cloud-gateway-zuul9527
模块,在application.yml
里,添加如下内容,做一个服务名称的路由映射规则。
# 配置服务端口号
server:
port: 9527
# 配置应用信息
spring:
application:
name: cloud-gateway-zuul # 配置应用名称
# 配置eureka
eureka:
client:
service-url:
defaultZone: http://eureka7001.com:7001/eureka/ # 入驻的服务地址
instance:
instance-id: gateway-zuul-9527 # 指定服务实例ID
prefer-ip-address: true # 访问路径可以显示IP地址
zuul:
routes:
serviceTempName.serviceId: cloud-provider-hystrix-payment # 注册进Eureka的真实服务名称/应用名称
serviceTempName.path: /provider8001/** # 表示通过浏览器访问/provider8001/**的所有请求,实际都发给了cloud-provider-hystrix-payment这个服务名
ignored-services: cloud-provider-hystrix-payment # 将原服务名进行隐藏,隐藏后只能通过'/provider8001'进行访问,如果这里有多个微服务原始名称需要隐藏,只需要把ignored-services的值改成'*'即可。
prefix: /king # 访问前缀
这段配置的serviceTempName
是随便取的,相当于给的当前服务临时起一个名称,serviceId
的值就是注册进Eureka
的真实服务名称,path是虚拟路径,表示通过浏览器访问
/provider8001/**的所有请求,实际都发给了
cloud-provider-hystrix-payment`这个服务名。
prefix
可以给经过Zuul
的请求加一个访问前缀,即服务名称前面需要带上这个前缀才能正确访问到资源。我们必须在provider8001
前加一个/king
才能正常访问,如果没有,肯定是报错的。
我们发送一个请求http://localhost:9527/cloud-provider-hystrix-payment/payment/hystrix/ok/1
就报Whitelabel Error Page 404
了,因为重新配置映射规则,要访问http://localhost:9527/king/provider8001/payment/hystrix/ok/1
可以正常获取到结果,映射规则生效。
这里的ignored-services
的作用是将原服务名进行隐藏,如果不隐藏的话,provider8001
和cloud-provider-hystrix-payment
都可以访问到,没有彻底解决之前的问题,所以,在做服务名称映射的时候,通常将原始名称给隐藏起来。如果这里有多个微服务原始名称需要隐藏,只需要把ignored-services
的值改成"*"
即可。
5、查看路由信息
在application.yml
中加入如下信息,将actuator
的routes
和filters
信息暴露出来方便查看。
# 默认情况下,actuator只会暴露health和info,让actuator暴露出routes, filters端点
management:
endpoints:
web:
exposure:
include: routes, filters
浏览器访问http://localhost:9527/actuator/routes
可以查看到路由信息,访问http://localhost:9527/actuator/filters
可以查看到过滤器信息。
6、过滤器
创建MyZuulFilter
,继承ZuulFilter
,实现对应的方法,并把MyZuulFilter
加到容器中。
package com.king.springcloud.filter;
import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;
import static org.springframework.cloud.netflix.zuul.filters.support.FilterConstants.ROUTE_TYPE;
@Component
public class MyZuulFilter extends ZuulFilter {
/**
* ERROR_TYPE:出现错误时候执行
* POST_TYPE:在ROUTE或ERROR执行之后执行
* PRE_TYPE:在代理执行之前执行
* ROUTE_TYPE:在代理执行的时候执行
*/
@Override
public String filterType() {
return ROUTE_TYPE;
}
/**
* 如果定义了多个同类型的ZuulFilter,根据filterOrder()方法的返回值,确定执行先后顺序
* 返回值越小,优先级越高,越先执行
*/
@Override
public int filterOrder() {
return 0;
}
/**
* true:开启过滤器
* false:不开启过滤器
*/
@Override
public boolean shouldFilter() {
return true;
}
/**
* 过滤器执行什么操作
*/
@Override
public Object run() throws ZuulException {
System.out.println("MyZuulFilterConfig.run");
return null;
}
}
通过浏览器访问http://localhost:9527/king/provider8001/payment/hystrix/ok/1
,在控制台看到有输出,表明run()方法执行了。