zuul的各种配置

比眉伴天荒 2024-02-19 18:26 45阅读 0赞

我们知道我们前台要展示数据给用户看，这中间可能涉及到从后端的多个微服务进行获取数据。比如获取用户信息需要用到用户微服务、获取商品信息需要获取商品微服务、创建订单需要调用订单微服务，而各个微服务可能分布在各个机器上，前端要获取到数据就必须要知道各个微服务的地址，这给前端增加开发的复杂性。一段后端的某个微服务地址改变了，前端可能还要修改。而且后端各个微服务权限认证也不好认证，那么有没有一种好的解决办法呢？**服务网关**就正好可以解决这个问题，在 spring cloud 中使用的就是zuul来实现服务网关。我们来看一下有了服务网关后，前端程序调用后端服务。  
![a6efee75-c459-3061-a62d-8f09c75e3793.png][]  
由上可知，当存在服务网关，前端程序通过服务网关调用后台服务，同时我们也可以在网关层进行各种操作，比如限流、权限校验等。

## 实现功能 ##

**1、查看 zuul 中配置好的路由和过滤器信息**

**2、忽略所有微服务或某些微服务**

**3、忽略所有为服务，只路由指定的微服务**

**4、通过path和url访问到具体的某台机器上**

**5、脱离eureka进行访问，并使之具有负载均衡和隔离的机制等**

**6、转发前是否去掉路由前缀**

**7、为所有路由都增加一个通过的前缀**

**8、忽略某些路径不进行路由**

**9、敏感头的传递（比如Cookie等）全局设置和某个微服务设置**

**10、忽略头**

**11、spring security 在classpath 下会忽略的头**

**12、本地调换和路由的优先级**

**13、配置网关超时**

**14、重写 Location 头**

**15、文件上传处理**

## 代码结构 ##

eureka-server
        |- 服务注册中心
        zuul
            product-provider-8202
            product-provider-8203
                |- 服务提供者
            product-consumer-8201
                |- 服务消费者
            product-gateway-8204
                |- 网关程序，演示网关路由的各种配置

## 代码编写 ##

##### **一、服务提供者、服务消费者、注册中心，没有什么需要特别注意的，略。** #####

##### **二、服务网关的编写** #####

1、创建网关工程

2、引入 zuul 的依赖

3、启动类上增加 @EnableZuulProxy 注解

4、yml 文件上注册到 eureka 上  
![6aa5aa7d-b303-31b2-84d2-58dbcbae3375.png][]

##### 三、eureka服务启动界面 #####

![6f87e388-576c-3cb2-96ef-1bc91a74d314.png][]

## 功能实现 ##

#### 1、查看 zuul 中配置好的路由和过滤器信息 ####

当我们启动了zuul 的网关之后，想知道当前zuul代理了那些路由，访问的路径又是那些或者我们自己写了一个zuul的filter，想知道它当前位于zuul的filter的那个位置时，该如何查询。

**访问路径：** http://网关地址:端口/routes 访问路由的简单信息

http://网关地址:端口/routes?format=details 访问路由的详细信息

http://网关地址:端口/filters 访问zuul中使用了那些过滤器。

**yml文件配置：**

management:
      security:
        enabled: false  # 默认值是 true, 为true的话那么页面上可能会报没有权限访问

**不进行配置，访问上面的2个端点会报没有权限访问。**

#### 2、忽略所有微服务或某些微服务 ####

默认情况下，只要引入了zuul后，就会自动一个默认的路由配置，但有些时候我们可能不想要默认的路由配置规则，想自己进行定义

**忽略所有微服务：(后面写 \* )**

zuul:
      ignored-services: "*"

**忽略某些微服务：(直接写微服务的名字=>可以理解为spring.application.name的值，多个以都好分隔)**

zuul:
      ignored-services: product-provider,product-consumer-8201

#### 3、忽略所有为服务，只路由指定的微服务 ####

![3f03957b-54c7-323a-a5c0-bf12b2585512.png][]  
 **访问：** http://gatewayhost:port/product/selectOne ===> 转发到 product-provider上的selectOne

#### 四、通过path和url访问到具体的某台机器上 ####

有时候我们测试的时候需要访问到具体的某台机器上，而不希望负载均衡到别的机器上或者需要访问到第三方的某台机器上。

zuul:
      routes:
        product-provider:
          path: /product/**
          url: http://localhost:8202/

![bea5162e-795a-381a-913a-7c8d8baec11a.gif][]

**注意：**

**1、product-provider 这个值可以随便写，即使是一个不存在的值**

**2、这种方式访问不会作为 HystrixCommand 来进行访问。**

**3、url 里面也不可以写多个url**

#### 五、**脱离eureka进行访问，并使之具有负载均衡和隔离的机制等** ####

![e9d313bb-2716-3ac5-9147-22010e735bd5.png][]  
**运行结果：**  
![af7b0b4a-f953-39c4-8d18-9494144c4ee2.gif][]

#### 六、转发前是否去掉路由前缀 ####

![2b26c26c-444c-32be-bc5a-f8542b568fc3.png][]

#### 七、为所有路由都增加一个通过的前缀 ####

有些时候我们系统所有的路由都有一个统一的前缀进行访问，此时就可以使用 zuul.prefix 进行统一添加。

![147b756e-a2b0-331d-bfb7-c4bba21af363.png][]

#### 八、忽略某些路径不进行路由 ####

有些时候，我们某些微服务的某些地址不希望被第三方客户调用到，需要被隐藏起来，此时就可以使用网关路由这些url不进行路由。

zuul:
      ignored-patterns: /**/selectOne/**
      routes:
        product-provider: /product/**

**注意： 这个忽略是全局忽略，即对所有的微服务都进行忽略**

#### 九、敏感头的传递（比如Cookie等）全局设置和某个微服务设置 ####

有些时候我们微服务上游可能想传递一些请求头到下游的服务，比如Token、Cookie等值，默认情况下，zuul 不会将 Cookie,Set-Cookie,Authorization **这三个头传递到下游服务，如果需要传递，就需要忽略这些敏感头。**

**全局和局部设置敏感头：**  
**![6614d4dd-8669-3896-aacd-0f333f2d6301.png][]  
运行结果：  
![290b5401-956b-3fbd-8985-35c34f3e3006.gif][]  
注意：**

**1、可以看到访问 product 路由时，是可以获取到 敏感头中 cookie 的信息的，访问 consumer 路由无法获取到。**

**2、如果下游服务启用了hystrix，那么 RequestInterceptor 要想从 ThreadLocal 中获取request的值，需要将隔离策略修改成信号量。**

#### 十、忽略头 （[链接][Link 1]） ####

有些时候，我们不想将某个头传递到其它所有的微服务中，就可以使用忽略头，忽略头是全局配置的，如果想在某个服务中忽略某个头，可以使用敏感头忽略。

zuul:
      routes:
        product-provider:
          path: /product/**
          serviceId : product-provider
      ignored-headers: token  # 全局忽略头，忽略 token 这个请求头，不向下游服务传递这个token请求头

**zuul.ignored-headers: token** 表示被zuul路由的服务都不会传递 token 这个请求头。

#### 十一、spring security 在classpath 下会忽略的头 ####

当我们的 spring security 在classpath中，zuul 会为我们增加一个默认的 spring security 相关的忽略头，如果我们不想要忽略，将 zuul. ignore-security-headers: false 就可以了。

# spring security 在classpath 下会忽略的头
    zuul:
      routes:
        product-provider:
          path: /product/**
          serviceId : product-provider
      ignore-security-headers: false  # 为true会忽略spring security安全头，如果下游需要用到需要设置成false

![e2e32853-a1e3-390f-9796-471e7b59cf47.png][]

#### 十二、本地调换和路由的优先级 ####

有些时候，我们页面上访问到的某些路径，**想让网关直接进行处理**，而不是直接转发到后端的服务上，此时就可以使用到路由的跳转。 有些时候 **/product/ext/\*\***想**路由**到 **product-provider-ext** 服务上，

**/product/\*\*** 想**路由**到 **product-provider**服务上，此时在 yml 文件中**顺序配置**即可。  
![d627e3f6-f1f9-3181-9963-220025d55481.png][]  
  
![e31565dc-260e-3f90-97f2-14b751d10314.png][]

#### 十三、配置网关超时 ####

![d9f13a3f-e440-3f5c-bd41-8ff515302a94.png][]

**如果是通过 url 进行配置的，那么需要设置下面这个超时时间**  
![e04915aa-22ff-3b96-a9e9-9f6585fc51c3.png][]

#### 十四、重写 Location 头 ####

如果Zuul面向Web应用程序，那么当Web应用程序通过http状态代码3XX重定向时，可能需要重写Location头，否则浏览器将最终重定向到Web应用程序的url而不是Zuul url。  
![cee7b61d-06ec-3712-ba8e-22e5199872c6.png][]

#### 十五、文件上传处理 ####

在微服务中，有时候我们经常需要用到文件的上传，当使用了服务网关 zuul 后，对于小的文件是可以上传成功的，那么对于大的文件就会报错，此处应该如何处理呢？

对于大文件的上传，我们需要绕过 Spring 的 DispatcherServlet。在 spring cloud zuul 中我们只需要在路由的前面加上 /zuul（ **zuul.servletPath**） 前缀即可。  
![475c72df-a867-32ec-9ea0-71b7544f7dc6.png][]  
 **从上图中可以看到，对于大文件的上传，是加上了  /zuul  的前缀的。**

**完整代码**

**服务网关配置代码： [https://gitee.com/huan1993/spring-cloud-parent/tree/master/zuul][https_gitee.com_huan1993_spring-cloud-parent_tree_master_zuul]**

[a6efee75-c459-3061-a62d-8f09c75e3793.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/efbc3cc9dd854815abfe280daf87b8c8.png
[6aa5aa7d-b303-31b2-84d2-58dbcbae3375.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/6d4e4f482f1a4e63b675513e6a132359.png
[6f87e388-576c-3cb2-96ef-1bc91a74d314.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/6fd105dcacb144129429914045314117.png
[3f03957b-54c7-323a-a5c0-bf12b2585512.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/7c629c0fc283472cb9754859c8d559a5.png
[bea5162e-795a-381a-913a-7c8d8baec11a.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/57787f82b2084f9c84c7a4ac9e994613.png
[e9d313bb-2716-3ac5-9147-22010e735bd5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/64a370291efd4b869792405699e0ec6e.png
[af7b0b4a-f953-39c4-8d18-9494144c4ee2.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/ef1e81acb79543099c5f81a3745caa60.png
[2b26c26c-444c-32be-bc5a-f8542b568fc3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/a4f3289623fd4c15833479884943b049.png
[147b756e-a2b0-331d-bfb7-c4bba21af363.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/27a8818f40e84a969dabc2e031503829.png
[6614d4dd-8669-3896-aacd-0f333f2d6301.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/1f570ff6e3b943a28e7d79e445bd6608.png
[290b5401-956b-3fbd-8985-35c34f3e3006.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/f7b88e722ace4325b8e41a6b9275a896.png
[Link 1]: http://cloud.spring.io/spring-cloud-static/Edgware.SR3/single/spring-cloud.html#_ignored_headers
[e2e32853-a1e3-390f-9796-471e7b59cf47.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/294d1bfc9315449a952f6473eae270bb.png
[d627e3f6-f1f9-3181-9963-220025d55481.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/129d454ebcb04feba0367964621dc6a6.png
[e31565dc-260e-3f90-97f2-14b751d10314.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/cc646213405d4329900f21425adec373.png
[d9f13a3f-e440-3f5c-bd41-8ff515302a94.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/8ca2daa79e7d405eb0fc0be772ef9397.png
[e04915aa-22ff-3b96-a9e9-9f6585fc51c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/42f2979fc2494ff9953c03654380f408.png
[cee7b61d-06ec-3712-ba8e-22e5199872c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/8b4df6120b3d4f848779d5c248de4b3d.png
[475c72df-a867-32ec-9ea0-71b7544f7dc6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/236ecf0bfd9248208a0fda70f4463afa.png
[https_gitee.com_huan1993_spring-cloud-parent_tree_master_zuul]: https://gitee.com/huan1993/spring-cloud-parent/tree/master/zuul