Spring Cloud：服务网关 Zuul

╰+哭是因爲堅強的太久メ 2021-09-10 07:34 406阅读 0赞

## 为什么要使用微服务网关 ##

*  不同的微服务一般会有不同的网络地址，而客户端可能需要调用多个服务接口才能完成一个业务需求
 *  若让客户端直接与各个微服务通信，会有以下问题：
    
     *  客户端会多次请求不同微服务，增加了客户端复杂性
     *  存在跨域请求，处理相对复杂
     *  认证复杂，每个服务都需要独立认证
     *  难以重构，多个服务可能将会合并成一个或拆分成多个
        
          
        
        
        ![9434708-a541e729ab3940b3..png][]
        
        image
 *  **微服务网关介于服务端与客户端的中间层，所有外部服务请求都会先经过微服务网关**
 *  客户只能跟微服务网关进行交互，无需调用特定微服务接口，使得开发得到简化
 *  微服务网关还具备以下优点：
    
     *  易于监控，微服务网关可收集监控数据并进行分析
     *  易于认证，可在微服务网关上进行认证，然后在将请求转发给微服务，无须每个微服务都进行认证
     *  减少客户端与微服务之间的交互次数
        
          
        
        
        ![9434708-dde6e191704aab7f..png][]
        
        image

## Zuul简介 ##

*  Zuul 是开源的微服务网关，可与 Eureka、Ribbon、Hystrix 等组件配合使用，**Zuul 它的核心是一系列过滤器**，这些过滤器可完成下面功能：
    
     *  身份认证与安全：识别每个资源的验证要求，并拒绝那些要求不符合的请求
     *  审核与监控：在边缘位置追踪有意义的数据和统计结果，从而带来精确的生产视图
     *  动态路由：动态的将请求路由到不同的后端集群
     *  压力测试：逐渐增加指向集群的流量，以了解性能
     *  负载分配：为每一种负载类型分配对应容量，并弃用超出限定值的请求
     *  静态响应处理：在边缘位置直接建立部分响应，从而避免转发到内部集群
     *  多区域弹性：跨越 AWS Region 进行请求路由，实现 ELB 使用多样化，让系统边缘更贴近使用者
 *  Spring Cloud 对 Zuul 进行了整合和增强，Zuul 默认使用的 HTTP 客户端是 Apache Http Client，也可使用 RestClient 或 okHttpClient

> 若要使用 RestClient 可设置

ribbon.restclient.enabled = true

> 若要使用 okhttp3.OKHttpClient 可设置

ribbon.okhttp.enabled = true

## 编写Zuul微服务网关 ##

> 创建新项目，添加zuul依赖库

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-zuul</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka</artifactId>
    </dependency>

> 在启动类添加注解 @EnableZuulProxy，声明一个 Zuul 代理，该代理用 Ribbon 来定位 Eureka Server 中的微服务，同时整合了 Hystrix，实现了容错

> 编写配置文件

server:
        port: 8040
    spring:
        application:
            name: zuul
    eureka:
        client:
            service-url:
                defaultZone: http://localhost:8761/eureka/

> 测试

*  启动 EurekaServer
 *  启动 flim-user（spring.application.name 为 flim-user） 和 flim-consumer（spring.application.name 为 flim-consumer）
 *  启动 zuul，访问 [http://localhost:8040/flim-consumer/user/1][http_localhost_8040_flim-consumer_user_1] 请求会被转发到 [http://localhost:8010/user/1][http_localhost_8010_user_1]
 *  **默认情况下 Zuul 会代理所有注册到 EurekaServer 的微服务，并且 Zuul 路由规则如下 [http://ZUUL\_HOST:ZUUL\_PORT/][http_ZUUL_HOST_ZUUL_PORT]微服务在Eureka上的serviceId/** 会被转发到 serviceId 对应的微服务\*\*

## Zuul 路由端点 ##

*  当 @EnableZuulProxy 与 Spring Boot Actuator 配合使用时，Zuul 会暴露一个路由管理端点 /routes 借助该断点可以方便的、直观地查看以及管理 Zuul 路由
 *  通过 GET 方式访问该端点即可返回路由列表，通过 POST 方式访问该端点就会强制刷新 Zuul 当前映射的路由列表

## 路由配置 ##

*  默认 Zuul 会代理所有注册到 EurekaServer 的微服务，若只想代理部分服务，就需要对 URL 进行精确的控制

> 指定微服务访问路径，配置 zuul.routes.微服务的 serviceId = 指定路径，当访问 /user/\*\* 时会转发到微服务 flim-user

zuul:
        routes:
            flim-user: /user/**

> 忽略指定微服务，通过 zuul.ignored-services 配置需要忽略的微服务，多个微服务通过逗号隔开

zuul:
        ignored-services: flim-user,flim-consumer

> 忽略所有微服务，只路由指定微服务

zuul:
        ignored-services:'*'  #使用'*'忽略所有微服务
        routes:
            flim-user: /user/**

> 指定微服务的 serviceId 和对应路径

zuul:
        routes:
            user-route:     #该配置方式中，user-route 只是给路由起的一个名称，可以任意起名
                service-id: provider-flim-user
                path: /user/**

> 指定 path 和 URL，但会破坏 Ribbon 负载均衡和 HystrixCommand 执行

zuul:
        routes:
            user-route:     #该配置方式中，user-route 只是给路由起的一个名称，可以任意起名
                url: http://localhost:8000/
                path: /user/**

> 指定 path 和 URL，不会破坏 Ribbon、Hystrix 特性

zuul:
        routes:
            user-route:     #该配置方式中，user-route 只是给路由起的一个名称，可以任意起名
                service-id: flim-user
                path: /user/**
    ribbon:
        eureka:
            enabled: false  #为Ribbon禁用Eureka
    flim-user:
        ribbon:
            listOfServers: localhost:8000,localhost:8001

> 借助 PatternServiceRouteMapper 使用正则表达式匹配路由

@Bean 
    public PatternServiceRouteMapper serviceRouteMapper(){
        // 调用构造函数 PatternServiceRouteMapper(String servicePattern,String routePattern)
        // servicePattern 指定微服务的正则
        // routePattern 指定路由正则
        return new PatternServiceRouteMapper("(?<name>^.+)-(?<version>v.+$)","${version}/${name}");
    }

> 路由前缀

*  prefix ：前缀，当请求匹配前缀时会进行代理
 *  strip-prefix ：代理前缀默认会从请求路径中移除，通过该设置关闭移除功能，当 stripPrefix=true 的时 （[http://127.0.0.1:8181/api/user/list][http_127.0.0.1_8181_api_user_list] \-> [http://192.168.1.100:8080/user/list][http_192.168.1.100_8080_user_list]），当stripPrefix=false的时（[http://127.0.0.1:8181/api/user/list][http_127.0.0.1_8181_api_user_list] \-> [http://192.168.1.100:8080/api/user/list][http_192.168.1.100_8080_api_user_list]）

#将 /api/flim-user/1 的请求转发到 flim-user 的 /api/1
    zuul:
        prefix: /api
        strip-prefix: false
        routes:
            flim-user: /user/**
    #将 /user/1 请求转发到 flim-user 的 /user/1
    zuul:
        routes:
            flim-user:
                path: /user/**
                strip-prefix: false

> 忽略某些路径，通过正则匹配

zuul:
        ignoredPatterns:/**/admin/**  #忽略所有包含 /admin/ 的路径
        routes:
            flim-user: /user/**

## Zuul 安全与 Header ##

### 敏感的 Header 设置 ###

*  一般来说，同一个系统中的服务之间共享 Header，不过应该防止一些敏感的 Header 外泄，在很多场景下，需要通过路由指定一系列敏感 Header 列表

zuul:
        routes:
            flim-user:
                ptah: /user/**
                sensitive-headers: Cookie,Set-Cookie,Authorization
                url: https://downstream

*  这样就可以为 flim-user 微服务指定敏感 Header 了，也可用 zuul.sensitive-headers 全局指定敏感 Header

zuul:
        sensitive-headers: Cookie,Set-Cookie,Authorization

### 忽略 Header ###

*  可用 zuul.ignoredHeaders 属性丢弃一些 Header，这样设置后 Header1、Header2 将不会传播到其它微服务中

zuul:
        ignored-headers: Header1,Header2

## 使用 Zuul 上传文件 ##

*  对于小文件（1M以内）上传无需任何处理，对于大文件（10M以上）上传，需要为上传路径添加 /zuul 前缀，也可以使用 zuul.servlet-path 自定义前缀
 *  假设 zuul.routes.file-upload = /file-upload/\*\*，如果 http://\{HOST\}:\{PORT\}/uoload 是微服务 file-upload 上传路径，则可以使用 Zuul 的 /zuul/file-upload/upload 路径上传大文件
 *  如果 Zuul 使用 Ribbon 做负载均衡，那么对于超大文件（例如500M）需要提升超时时间

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 60000
    ribbon:
        ConnectTimeout: 3000
        ReadTimeout: 60000

### 编写文件上传微服务 ###

> 创建新项目 file-upload，并添加依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-eureka</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

> 在启动类上添加 @EnableEurekaClient  
> 编写 Controller

@RestController
    public class FileUploadController {
        @PostMapping(name = "/upload")
        public String handleFileUpLoad(@RequestParam(value = "file") MultipartFile file) throws IOException {
            byte[] bytes = file.getBytes();
            File fileToSave = new File(file.getOriginalFilename());
            FileCopyUtils.copy(bytes, fileToSave);
            return fileToSave.getAbsolutePath();
        }
    }

> 编写配置文件

server:
      port: 8050
    eureka:
      client:
        service-url:
          defaultZone: http://localhost:8761/eureka/
        instance:
          prefer-ip-address: true
    spring:
      application:
        name: file-upload
      http:
        multipart:
          max-file-size: 2000Mb
          max-request-size: 2500Mb

> 测试

*  启动 EurekaServer
 *  启动 file-upload、zuul
 *  直接将文件通过 [http://localhost:8050/upload][http_localhost_8050_upload] 上传，小文件（1M）、大文件（1G）均正常上传（除非发生堆错误等问题）
 *  通过 Zuul [http://localhost:8040/file-upload/upload][http_localhost_8040_file-upload_upload] 上传小文件，可以正常上传
 *  通过 Zuul [http://localhost:8040/file-upload/upload][http_localhost_8040_file-upload_upload] 上传大文件，会报异常

There was an unexpected error (type=Internal Server Error, status=500).
    Could not parse multipart servlet request; nested exception is java.lang.IllegalStateException: org.apache.tomcat.util.http.fileupload.FileUploadBase$SizeLimitExceededException: the request was rejected because its size (155106628) exceeds the configured maximum (10485760)

*  添加 /zuul 前缀，通过 [http://localhost:8040/zuul/file-upload/upload][http_localhost_8040_zuul_file-upload_upload] 此时会报新的异常，Hystrix 超时异常

There was an unexpected error (type=Internal Server Error, status=500).
    TIMEOUT

*  需要在 Zuul 配置文件中添加以下内容，然后重启微服务，可正常上传

hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 60000
    ribbon:
        ConnectTimeout: 3000
        ReadTimeout: 60000

## Zuul 过滤器 ##

*  Zuul 大部分功能都是通过过滤器实现的，Zuul 中定义了 4 种标准过滤器类型，对应了典型的生命周期
    
     *  PRE：在请求被路由之前调用，可用于身份验证、集群中选择请求的微服务、记录调试信息等
     *  ROUTING：请求路由到微服务时执行，用于构建发送给微服务的请求，使用 HttpClient 或 Ribbon 请求微服务
     *  POST：在路由到微服务后执行，可用来为响应添加 Header，收集统计信息和指标、将相应从微服务发送给客户端等
     *  ERROR：在其他阶段发生错误时执行该过滤器
     *  Zuul 还允许创建自定义过滤器类型，例如定制一种 STATIC 类型过滤器，直接在 Zuul 中生存响应，而不将请求转发到后端的微服务
        
          
        
        
        ![9434708-ba55d3750e99efdd..png][]
        
        image

### 编写 Zuul 过滤器 ###

> 创建过滤器类，继承抽象类 ZuulFilter 并实现抽象方法

/**
     * @description: Zuul日志过滤器
     * filterType：返回过滤器类型，有 pre、route、post、error 等几种取值
     * filterOrder：返回一个 int 值指定过滤器执行顺序，不同过滤器允许返回相同的数字
     * shouldFilter：true 表示过滤器执行、false表示不执行
     * run：过滤器具体逻辑，下面代码打印了请求方法和URL
     */
    public class PreRequestLogFilter extends ZuulFilter{
    
        private static final Logger LOGGER = LoggerFactory.getLogger(PreRequestLogFilter.class);
    
        @Override
        public String filterType() {
            return "pre";
        }
    
        @Override
        public int filterOrder() {
            return 1;
        }
    
        @Override
        public boolean shouldFilter() {
            return true;
        }
    
        @Override
        public Object run() {
            RequestContext ctx = RequestContext.getCurrentContext();
            HttpServletRequest request = ctx.getRequest();
            PreRequestLogFilter.LOGGER.info(String.format("send %s request to %s",request.getMethod(),request.getRequestURL().toString()));
            return null;
        }
    }

> 将过滤器通过 @Bean 注入到 IOC 容器

@Bean
    public PreRequestLogFilter preRequestLogFilter() {
        return new PreRequestLogFilter();
    }

> 测试

*  启动 EurekaServer、启动 flim-user
 *  启动 zuul 访问 [http://localhost:8040/flim-user/1][http_localhost_8040_flim-user_1] 可看到如下日志

c.l.zuul.filter.PreRequestLogFilter      : send GET request to http://localhost:8040/flim-user/1

### 禁用 Zuul 过滤器 ###

*  Spring Cloud 默认为 Zuul 启用了一些过滤器，如 DebugFilter、FormBodyWrapperFilter、PreDecorationFilter 等，这些过滤器存放在 spring-cloud-netflix-core 这个 Jar 包的 org.springframwork.cloud.netflix.zuul.filters 包中
 *  只需配置 zuul.<SimpleClassName>.<filterType>.disable = true 即可禁用 SimpleClassName 对应的过滤器，例如

zuul.SendResponseFilter.post.disable = true

## 为 Zuul 添加回退 ##

*  Zuul 的 Hystrix 监控粒度是微服务，而不是某个 API
 *  要为 Zuul 添加回退，需要实现 ZuulFallbackProvider 接口，在实现类中指定为哪个微服务提供回退，并提供一个 ClientHttpResponse 作为回退响应

> 编写 Zuul 回退类

@Component
    public class UserFallbackProvider implements ZuulFallbackProvider {
    
        @Override
        public String getRoute() {
            //表明为哪个微服务提供回退
            return "flim-user";
        }
    
        @Override
        public ClientHttpResponse fallbackResponse() {
            return new ClientHttpResponse() {
                @Override
                public HttpStatus getStatusCode() throws IOException {
                    //回退时的状态码
                    return HttpStatus.OK;
                }
    
                @Override
                public int getRawStatusCode() throws IOException {
                    //数字类型的状态码，本文返回的是200
                    return this.getStatusCode().value();
                }
    
                @Override
                public String getStatusText() throws IOException {
                    //状态文本，本文返回的是OK
                    return this.getStatusCode().getReasonPhrase();
                }
    
                @Override
                public void close() {
    
                }
    
                @Override
                public InputStream getBody() throws IOException {
                    //响应体
                    return new ByteArrayInputStream("用户微服务不可用".getBytes());
                }
    
                @Override
                public HttpHeaders getHeaders() {
                    //headers设定
                    HttpHeaders httpHeaders = new HttpHeaders();
                    MediaType mt = new MediaType("application","json", Charset.forName("UTF-8"));
                    httpHeaders.setContentType(mt);
                    return httpHeaders;
                }
            };
        }
    }

> 测试

*  启动 EurekaServer
 *  启动 Zuul，访问 [http://localhost:8040/flim-user/1][http_localhost_8040_flim-user_1] 时会返回以下内容

用户微服务不可用

## Zuul 高可用 ##

*  将多个 Zuul 客户端也注册到 Eureka Server 上，就可以实现 Zuul 高可用
 *  部署多个 Zuul，Zuul 客户端会自动从 Eureka Server 中查询 Zuul Server 列表，并使用 Ribbon 负载均衡地请求 Zuul 集群
 *  如果 Zuul 客户端未注册到 Eureka Server 上，可借助 Nginx 等实现负载均衡

## 修改 ServiceId 与路由映射规则 ##

*  可以自定义 serviceId 和路由之间的相互映射，通过正则表达式进行匹配
 *  例如将 serviceId 为 users-v1 的服务映射到路由 /v1/users/ 的路径上,当请求 /v1/users/ 时等同于请求 /users-v1/

@Bean
    public PatternServiceRouteMapper serviceRouteMapper() {
        return new PatternServiceRouteMapper(
            "(?<name>^.+)-(?<version>.+$)",
            "${version}/${name}");
    }

**---- 待完善 ----**

[9434708-a541e729ab3940b3..png]: /images/20210811/758b1fd929f34dca92e09085ed8902ef.png
[9434708-dde6e191704aab7f..png]: /images/20210811/ff498fa7f4c7439c8f0ac13806995d69.png
[http_localhost_8040_flim-consumer_user_1]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8040%2Fflim-consumer%2Fuser%2F1
[http_localhost_8010_user_1]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8010%2Fuser%2F1
[http_ZUUL_HOST_ZUUL_PORT]: https://link.jianshu.com?t=http%3A%2F%2FZUUL_HOST%3AZUUL_PORT%2F
[http_127.0.0.1_8181_api_user_list]: https://link.jianshu.com?t=http%3A%2F%2F127.0.0.1%3A8181%2Fapi%2Fuser%2Flist
[http_192.168.1.100_8080_user_list]: https://link.jianshu.com?t=http%3A%2F%2F192.168.1.100%3A8080%2Fuser%2Flist
[http_192.168.1.100_8080_api_user_list]: https://link.jianshu.com?t=http%3A%2F%2F192.168.1.100%3A8080%2Fapi%2Fuser%2Flist
[http_localhost_8050_upload]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8050%2Fupload
[http_localhost_8040_file-upload_upload]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8040%2Ffile-upload%2Fupload
[http_localhost_8040_zuul_file-upload_upload]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8040%2Fzuul%2Ffile-upload%2Fupload
[9434708-ba55d3750e99efdd..png]: /images/20210811/b77a5953823b41eab072836911f11fad.png
[http_localhost_8040_flim-user_1]: https://link.jianshu.com?t=http%3A%2F%2Flocalhost%3A8040%2Fflim-user%2F1