springboot2 springcloud Greenwich.SR3 构建微服务--6.服务网关zuul入门使用

分手后的思念是犯贱 2023-10-11 10:12 12阅读 0赞

Zuul是Spring Cloud全家桶中的微服务API网关。

所有从设备或网站来的请求都会经过Zuul到达后端的Netflix应用程序。作为一个边界性质的应用程序，Zuul提供了动态路由、监控、弹性负载和安全功能。Zuul底层利用各种filter实现如下功能：

*  认证和安全 识别每个需要认证的资源，拒绝不符合要求的请求。
 *  性能监测 在服务边界追踪并统计数据，提供精确的生产视图。
 *  动态路由 根据需要将请求动态路由到后端集群。
 *  压力测试 逐渐增加对集群的流量以了解其性能。
 *  负载卸载 预先为每种类型的请求分配容量，当请求超过容量时自动丢弃。
 *  静态资源处理 直接在边界返回某些响应。

现在的服务网关的作用就相当于设计模式中的门面模式, 作为一个统一的服务接口, 所有的服务都发送到网关中, 先进行一些操作, 例如, 权限鉴定, 限流, 等等. 再转发到真正的服务提供者哪里.

服务网关的选型, 现在还要一个springcloud 的 getway   nginx+lua Kong(商业) Tyk(go开发的)  都是可以作为服务网关的

### zuul的工作原理 ###

**1、过滤器机制**

zuul的核心是一系列的**filters**, 其作用可以类比Servlet框架的Filter，或者AOP。

zuul把Request route到 用户处理逻辑 的过程中，这些filter参与一些过滤处理，比如Authentication，Load Shedding等。

![format_png][]

**Zuul提供了一个框架，可以对过滤器进行动态的加载，编译，运行。**

Zuul的过滤器之间没有直接的相互通信，他们之间通过一个RequestContext的静态类来进行数据传递的。RequestContext类中有ThreadLocal变量来记录每个Request所需要传递的数据。

Zuul的过滤器是由Groovy写成，这些过滤器文件被放在Zuul Server上的特定目录下面，Zuul会定期轮询这些目录，修改过的过滤器会动态的加载到Zuul Server中以便过滤请求使用。

下面有几种标准的过滤器类型：

Zuul大部分功能都是通过过滤器来实现的。Zuul中定义了四种标准过滤器类型，这些过滤器类型对应于请求的典型生命周期。

(1) PRE：这种过滤器在请求被路由之前调用。我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

(2) ROUTING：这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并使用Apache HttpClient或Netfilx Ribbon请求微服务。

(3) POST：这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的HTTP Header、收集统计信息和指标、将响应从微服务发送给客户端等。

(4) ERROR：在其他阶段发生错误时执行该过滤器。

**使用**

*  PRE Filter：在请求路由到目标之前执行。一般用于请求认证、负载均衡和日志记录。
 *  ROUTING Filter：处理目标请求。这里使用Apache HttpClient或Netflix Ribbon构造对目标的HTTP请求。
 *  POST Filter：在目标请求返回后执行。一般会在此步骤添加响应头、收集统计和性能数据等。
 *  ERROR Filter：整个流程某块出错时执行。

**内置的特殊过滤器**

zuul还提供了一类特殊的过滤器，分别为：StaticResponseFilter和SurgicalDebugFilter

StaticResponseFilter：StaticResponseFilter允许从Zuul本身生成响应，而不是将请求转发到源。

SurgicalDebugFilter：SurgicalDebugFilter允许将特定请求路由到分隔的调试集群或主机。

**自定义的过滤器**

除了默认的过滤器类型，Zuul还允许我们创建自定义的过滤器类型。

例如，我们可以定制一种STATIC类型的过滤器，直接在Zuul中生成响应，而不将请求转发到后端的微服务。

2、过滤器的生命周期

Zuul请求的生命周期如图，该图详细描述了各种类型的过滤器的执行顺序。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE_size_16_color_FFFFFF_t_70][]

zuul的执行代码, ZuulServlet 中的service方法

public void service(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse) throws ServletException, IOException {
            try {
                init((HttpServletRequest) servletRequest, (HttpServletResponse) servletResponse);
                // Marks this request as having passed through the "Zuul engine", as opposed to servlets
                // explicitly bound in web.xml, for which requests will not have the same data attached
                RequestContext context = RequestContext.getCurrentContext();
                context.setZuulEngineRan();
                try {
                    preRoute();
                } catch (ZuulException e) {
                    error(e);
                    postRoute();
                    return;
                }
                try {
                    route();
                } catch (ZuulException e) {
                    error(e);
                    postRoute();
                    return;
                }
                try {
                    postRoute();
                } catch (ZuulException e) {
                    error(e);
                    return;
                }
            } catch (Throwable e) {
                error(new ZuulException(e, 500, "UNHANDLED_EXCEPTION_" + e.getClass().getName()));
            } finally {
                RequestContext.getCurrentContext().unset();
            }
        }

可以从`service(servletRequest, servletResponse)`方法看出四种FilterType(pre、route、post、error)的ZuulFilter的执行顺序，总结如下：

*  1、pre、route、post都不抛出异常，顺序是：pre->route->post，error不执行。
 *  2、pre抛出异常，顺序是：pre->error->post。
 *  3、route抛出异常，顺序是：pre->route->error->post。
 *  4、post抛出异常，顺序是：pre->route->post->error。

注意，一旦出现了异常，会把抛出的Throwable实例设置到绑定到当前请求线程的RequestContext实例中的throwable属性。还需要注意在`service(servletRequest, servletResponse)`的finally块中调用了`RequestContext.getCurrentContext().unset();`，实际上是从RequestContext的ThreadLocal实例中移除当前的RequestContext实例，这样做可以避免ThreadLocal使用不当导致内存泄漏。

好了,原理讲完了,开始撸代码.

1.创建一个叫做 zuul-server 的项目,作为服务网关, 完整的pom文件为:

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.1.8.RELEASE</version>
            <relativePath/> 
        </parent>
        <groupId>com.example</groupId>
        <artifactId>zuul-server</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>zuul-server</name>
        <description>Demo project for Spring Boot</description>
    
        <properties>
            <java.version>1.8</java.version>
            <spring-cloud.version>Greenwich.SR3</spring-cloud.version>
        </properties>
    
        <dependencies>
            <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-netflix-zuul</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis</artifactId>
            </dependency>
        </dependencies>
    
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>${spring-cloud.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

2. 在启动类上添加注解

@EnableZuulProxy

**记住了, 不是@EnableZuulServer注解..... 不要自己忘坑里跳,还挑不出来的**

**@EnableZuulServer  普通网关, 只支持基本的route 和 filter**

**@EnableZuulProxy    配合上服务发现与熔断开关的@EnabeleZullServer 的增强版, 具有反向代理的功能**

3.修改配置

server.port=9000
    spring.application.name=zuul-service
    eureka.client.eureka-server-u-r-l-context=http://localhost:8761/eureka
    #这里没有配置config, 因为我电脑太卡了....
    
    #自定义路由
    #zuul.routes.myProduct  这里的myProduct 可以随意定义的,没关系
    zuul.routes.myProduct.path=/myProduct/**
    zuul.routes.myProduct.service-id=product-service
    #敏感头, 设置为空就可以传递cookie信息了
    #zuul.routes.myProduct.sensitive-headers=null
    #http://localhost:9000/myProduct/product/list  进行访问
    #简洁写法:
    #zuul.routes.product-service=/myProduct/**
    
    #所有的配置都传递cookie,不用zuul.routes.myProduct.sensitive-headers=null了
    #全部忽略
    zuul.sensitive-headers=null
    
    #路由忽略的,不能通过路由访问的,报 404, 排除一些url
    zuul.ignored-patterns=/product-service/hello,/myProduct/hello
    #可以只写一个, /*/hello
    
    #查看所有zuul的配置,权限配置,查看zuul的路由规则
    #http://localhost:9000/application/routes
    #management.security.enabled=false
    
    #动态路由
    # 以上的配置放到git里面去. 再新建一个java bean的类
    #redis的配置
    spring.redis.host=localhost
    spring.redis.port=6379
    
    #zuul的超时时间配置,其实还是hystrix的配置.

**路由配置举例:**

1、重写指定微服务的访问路径：

zuul.routes.rest-demo=/rest/\*\*

这表示将rest-demo微服务的地址映射到/rest/\*\*路径。

2、忽略指定微服务：

zuul.ignored-services=rest-demo,xxx-service

使用“\*”可忽略所有微服务，多个指定微服务以半角逗号分隔。

3、忽略所有微服务，只路由指定微服务：

zuul.ignored-services=\*  
zuul.routes.rest-demo:=/rest/\*\*

4、路由别名：  
zuul.routes.route-name.service-id=rest-demo  \#路由别名，无其他意义，与例1效果一致  
zuul.routes.route-name.path=/rest/\*\*

5、指定path和URL  
zuul.routes.route-name.url=http://localhost:8000/  
zuul.routes.route-name.path=/rest/\*\*

此例将http://ZUULHOST:ZUULPORT/rest/**映射到http://localhost:8000/**。同时由于并非用service-id定位服务，所以也无法使用负载均衡功能。

6、即指定path和URL，又保留Zuul的Hystrix、Ribbon特性

zuul.routes.route-name.service-id=rest-demo  \#路由别名，无其他意义，与例1效果一致  
zuul.routes.route-name.path=/rest/\*\*

ribbon.eureka.enable=false \#为Ribbon禁用Eureka  
rest-demo.ribbon.listOfServers=localhost:9000,localhost:9001

7、借助`PatternServiceRouteMapper`实现路由的正则匹配

@Bean  
public PatternServiceRouteMapper serviceRouteMapper()\{  
    /\*\*  
     \* A RegExp Pattern that extract needed information from a service ID. Ex :  
     \* "(?<name>.\*)-(?<version>v.\*$)"  
     \*/  
    //private Pattern servicePattern;  
    /\*\*  
     \* A RegExp that refer to named groups define in servicePattern. Ex :  
     \* "$\{version\}/$\{name\}"  
     \*/  
    //private String routePattern;  
    return new PatternServiceRouteMapper("(?<name>^.+)-(?<version>v.+$)", "$\{version\}/$\{name\}");  
\}

此例可以将rest-demo-v1映射为/v1/rest-demo/\*\*。

8、路由前缀  
 zuul. prefix: /api  
  zuul.strip-prefix: true  
  zuul.routes.rest-demo=/rest/\*\*

此时访问Zuul的/api/rest/user/xdlysk会被转发到/rest-demo/user/xdlysk。

9、忽略某些微服务中的某些路径  
 zuul.ignoredPatterns=/\*\*/user/\* \#忽略所有包含/user/的地址请求  
zuul. outes.route-demo.service-Id: rest-demo  
 zuul. outes.route-demo.path=/rest/\*\*

4.启动zuul-server项目, 开始服务转发

请求的地址规则是:

9000是zuul的端口号

product-service 是注册在eureka中的product 服务的服务名

/product/list  是原本product的请求的url.

http://localhost:9000/product-service/product/list
                           服务名             url

也可以使用这个链接, 自定义myProduct 来转发product-service的请求

**http://localhost:9000/myProduct/product/list**

整个代码地址是:

https://github.com/changhe626/micro-service

Java Framework,欢迎各位前来交流java相关  
QQ群:965125360

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE1LmNuYmxvZ3MuY29tL2Jsb2cvNDg2MDc0LzIwMTcwMi80ODYwNzQtMjAxNzAyMjAxODUzMzUyODgtMTcwMzIyNDMzMy5wbmc?x-oss-process=image/format,png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190923133427750.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE=,size_16,color_FFFFFF,t_70