spring cloud之zuul路由网关（六）

最新推荐文章于 2024-09-14 20:52:59 发布

闻道☞

最新推荐文章于 2024-09-14 20:52:59 发布

阅读量1.6k

点赞数

分类专栏： Spring Cloud

Spring Cloud 专栏收录该内容

18 篇文章 0 订阅

订阅专栏

转自：http://blog.csdn.net/forezp/article/details/69939114

在微服务架构中，需要几个基础的服务治理组件，包括服务注册与发现、服务消费、负载均衡、断路器、智能路由、配置管理等，由这几个基础组件相互协作，共同组建了一个简单的微服务系统。一个简答的微服务系统如下图：

Azure (1).png
注意：A服务和B服务是可以相互调用的，作图的时候忘记了。并且配置服务也是注册到服务注册中心的。

在Spring Cloud微服务系统中，一种常见的负载均衡方式是，客户端的请求首先经过负载均衡（zuul、Ngnix），再到达服务网关（zuul集群），然后再到具体的服务。服务统一注册到高可用的服务注册中心集群，服务的所有的配置文件由配置服务管理，配置服务的配置文件放在git仓库，方便开发人员随时改配置。

一、Zuul简介

路由器和过滤器：Zuul

路由在微服务体系结构的一个组成部分。例如，/可以映射到您的Web应用程序，/api/users映射到用户服务，并将/api/shop映射到商店服务。

Zuul是Netflix的基于JVM的路由器和服务器端负载均衡器。

Netflix使用Zuul进行以下操作：

认证
洞察
压力测试
金丝雀测试
动态路由
服务迁移
负载脱落
安全
静态响应处理
主动/主动流量管理

Zuul的规则引擎允许通过任何JVM语言来编写规则和过滤器, 支持基于Java和Groovy的构建。

配置属性 zuul.max.host.connections 已经被两个新的配置属性替代, zuul.host.maxTotalConnections （总连接数）和 zuul.host.maxPerRouteConnections,（每个路由连接数）默认值分别是200和20.

三、创建zuul-service工程

其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>spring-cloud</artifactId>
        <groupId>com.alen</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <packaging>jar</packaging>
    <artifactId>zuul-service</artifactId>
    <dependencies>
        <!--eureka client -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <!--zuul-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

加上配置文件application.yml加上以下的配置代码：

server:
  port: 8086

eureka:
  instance:
    hostname: localhost
      # 发呆时间，即服务失效时间（缺省为90s）,就是超过15秒没有续约就会从注册表中剔除
    lease-expiration-duration-in-seconds: 15
      # 心跳时间，即服务续约间隔时间（缺省为30s）
    lease-renewal-interval-in-seconds: 5
  client:
    service-url:
      defaultZone: http://localhost:8010/eureka/

spring:
  application:
    name: zuul-service

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: eureka-client
    api-b:
      path: /api-b/**
      serviceId: feign-service

首先指定服务注册中心的地址为http://localhost:8081/eureka/，服务名为zuul-service；以/api-a/ 开头的请求都转发给eureka-client服务；以/api-b/开头的请求都转发给feign-service服务；

在Spring Boot主函数上通过注解 @EnableZuulProxy 来开启, 这样可以让本地的请求转发到适当的服务

依次运行这五个工程;打开浏览器访问：http://localhost:8086/api-a/hello?age=10 ;浏览器显示：20

这说明zuul起到了路由的作用

Zuul starter没有包含服务发现的客户端, 所以对于路由你需要在classpath中提供一个根据service IDs做服务发现的服务.(例如, eureka是一个不错的选择)

　　在服务ID表达式列表中设置 zuul.ignored-services, 可以忽略已经添加的服务. 如果一个服务匹配表达式, 则将会被忽略, 但是对于明确配置在路由匹配中的, 将不会被忽略(api-a,api-b), 例如:

zuul:
  routes:
    api-a:
      path: /api-a/**
      serviceId: eureka-client
    api-b:
      path: /api-b/**
      serviceId: feign-service
  ignored-services: '*'

后端的配置既可以是"serviceId"(对于服务发现中的服务而言), 也可以是"url"(对于物理地址), 例如:

zuul:
  routes:
    users:
      path: /myusers/**
      url: http://example.com/users_service

四、服务过滤

zuul不仅只是路由，并且还能过滤，做一些安全验证。继续改造工程；

/**
 * 过滤器
 **/
@Component
public class MySelfZuulFilter extends ZuulFilter{

    private static final Logger log=Logger.getLogger(MyFilter.class);
    @Override
    public String filterType() {
        return "pre";
    }

    @Override
    public int filterOrder() {
        return 0;
    }

    @Override
    public boolean shouldFilter() {
        return true;
    }

    @Override
    public Object run() {
        RequestContext ctx = RequestContext.getCurrentContext();
        HttpServletRequest request = ctx.getRequest();
        Object accessToken = request.getParameter("token");
        if(accessToken == null) {
            log.warn("token is empty");
            ctx.setSendZuulResponse(false);
            ctx.setResponseStatusCode(401);
            try {
                ctx.getResponse().getWriter().write("token is empty");
            }catch (Exception e){}
            return null;
        }
        log.info("ok");
        return null;
    }
}

filterType：返回一个字符串代表过滤器的类型，在zuul中定义了四种不同生命周期的过滤器类型，具体如下：

pre：路由之前
routing：路由之时
post：路由之后
error：发送错误调用
filterOrder：过滤的顺序
shouldFilter：这里可以写逻辑判断，是否要过滤，本文true,永远过滤。

这时访问：http://localhost:8086/api-a/hello?age=10 ；网页显示：

token is empty

@EnableZuulProxy与@EnableZuulServer
Spring Cloud Netflix根据使用何种注释来启用Zuul安装多个过滤器。@EnableZuulProxy是@EnableZuulServer的超集。换句话说，@EnableZuulProxy包含@EnableZuulServer安装的所有过滤器。“代理”中的其他过滤器启用路由功能。如果你想要一个“空白”Zuul，你应该使用@EnableZuulServer。
@EnableZuulServer过滤器

创建从Spring Boot配置文件加载路由定义的SimpleRouteLocator。

安装了以下过滤器（正常Spring豆类）：

前置过滤器
    ServletDetectionFilter：检测请求是否通过Spring调度程序。使用键FilterConstants.IS_DISPATCHER_SERVLET_REQUEST_KEY设置布尔值。
    FormBodyWrapperFilter：解析表单数据，并对下游请求进行重新编码。
    DebugFilter：如果设置debug请求参数，则此过滤器将RequestContext.setDebugRouting()和RequestContext.setDebugRequest()设置为true。

路由过滤器
SendForwardFilter：此过滤器使用Servlet RequestDispatcher转发请求。转发位置存储在RequestContext属性FilterConstants.FORWARD_TO_KEY中。这对于转发到当前应用程序中的端点很有用。

过滤器：
SendResponseFilter：将代理请求的响应写入当前响应。

错误过滤器：
SendErrorFilter：如果RequestContext.getThrowable()不为null，则转发到/错误（默认情况下）。可以通过设置error.path属性来更改默认转发路径（/error）。

@EnableZuulProxy过滤器
创建从DiscoveryClient（如Eureka）以及属性加载路由定义的DiscoveryClientRouteLocator。每个serviceId从DiscoveryClient创建路由。随着新服务的添加，路由将被刷新。

除了上述过滤器之外，还安装了以下过滤器（正常Spring豆类）：
前置过滤器
PreDecorationFilter：此过滤器根据提供的RouteLocator确定在哪里和如何路由。它还为下游请求设置各种与代理相关的头。

路由过滤器
    RibbonRoutingFilter：此过滤器使用Ribbon，Hystrix和可插拔HTTP客户端发送请求。服务ID位于RequestContext属性FilterConstants.SERVICE_ID_KEY中。此过滤器可以使用不同的HTTP客户端。他们是：
        Apache HttpClient。这是默认的客户端。
       Squareup OkHttpClient v3。通过在类路径上设置com.squareup.okhttp3:okhttp库并设置ribbon.okhttp.enabled=true来启用此功能。
      Netflix Ribbon HTTP客户端。这可以通过设置ribbon.restclient.enabled=true来启用。这个客户端有限制，比如它不支持PATCH方法，还有内置的重试。
SimpleHostRoutingFilter：此过滤器通过Apache HttpClient发送请求到预定的URL。URL位于RequestContext.getRouteHost()。

五：一些Zuul 路由配置

1.必须要知道应用程序的名称，但是如果不知道这个名称肯定无法访问，可是如果让用户知道这个名称，那么使用 zuul 就没有任何的实际意义，直接调用即可。而 zuul 的主要功能是代理，那么代理的功能就是不让用户看见真实的操作，所以在实际的使用之中就需要为 zuul 设置一些路由规则。为指定的应用设置路径，修改 application.yml 配置文件：那么此时就可以通过“/company-proxy”来访问“microcloud-provider-company”名称。 http://gateway-9501.com:9501/company-proxy/company/get/hello 但是现在还会存在有一个实际的问题，虽然现在开启了路由访问支持，但是依然支持通过应用名称进行访问： http://gateway-9501.com:9501/microcloud-provider-company/company/get/hello

2、修改 application.yml 配置文件忽略掉应用名称访问： · 忽略掉“microcloud-provider-company”应用名称； zuul: ignored-services: microcloud-provider-company routes: microcloud-provider-company: /company-proxy/** 这个时候就可以进行代理的安全使用，但是如果你一个系统之中存在有几百个微服务，如果按照如上的方式进行配置就会非常的麻烦，所以最简单的做法是可以采用一个通配符“*”的模式来完成： zuul: ignored-services: "*" routes: microcloud-provider-company: /company-proxy/** 现在表示所有的 Eureka 中的服务名称的信息访问都要忽略掉，所有的访问都需要配置一个映射路径的模式来完成。

3、除了以上的模式进行服务定义之外，在 zuul 之中也可以采用如下的方式进行处理： zuul: ignored-services: "*" routes: mycompany.path: /company-proxy/** mycompany.serviceId: microcloud-provider-company 其中在代码里面出现的“mycompany”是一个逻辑名称，该名称的主要作用是将 path 与 serviceId 绑定在一起。 4、如果说现在不想通过 Eureka 进行访问，则也可以直接连接到 company 微服务的地址 zuul: ignored-services: "*" routes: company.path: /company-proxy/** company.url: http://company-8101.com:8101/company 此时的地址上由于已经存在有了“company”前缀，所以访问地址为： http://gateway-9501.com:9501/company-proxy/get/hello 但是从实际的开发来讲不建议采用此类模式处理，因为所有的服务如果直接绑定了指定的服务提供者的地址，那么将不方便进行负载均衡的配置处理，而且没有 Eureka 所有微服务的管理也非常不方便。 5、设置公共前缀： zuul: prefix: /mldn-proxy ignored-services: "*" routes: microcloud-provider-company: /company-proxy/** 一旦存在有前缀定义之后所有微服务的访问上就必须追加有前缀名称： http://gateway-9501.com:9501/mldn-proxy/company-proxy/company/get/hello 以上的地址： · “/mldn-proxy”：整个 zuul 的前缀； · “/company-proxy”：是在 zuul 中定义的映射路径； · “/company/get/hello”：是微服务提供者提供的操作