Spring Cloud系列之网关：Zuul

最新推荐文章于 2024-07-12 21:22:25 发布

风铃峰顶

最新推荐文章于 2024-07-12 21:22:25 发布

阅读量143

点赞数

分类专栏： # Spring Cloud 文章标签：网关

本文链接：https://blog.csdn.net/haoranhaoshi/article/details/109342785

版权

Spring Cloud 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

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>cloud-demo</artifactId>
        <groupId>cn.hao.learning</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>gateway</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.8.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.8.1</version>
        </dependency>
    </dependencies>
</project>

GatewayApplication.java：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.zuul.EnableZuulProxy;

/**
 * @Author: hao
 * @Description: 网关
 * @Date: 2020/2/27 20:43
 * @Version: 1.0
 */
@EnableZuulProxy
@SpringBootApplication
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class);
    }
}

application.yml：

zuul中的配置可参考： org.springframework.cloud.netflix.zuul.filters.ZuulProperties

server:
  port: 10010
spring:
  application:
    name: gateway # 应用名称，会在Eureka中显示
eureka:
  client:
    eureka.client.fetch-registry: true # 当服务消费者启动是，会检测eureka.client.fetch-registry参数的值，如果为true，则会从Eureka Server服务的列表只读备份，然后缓存在本地，并且默认每隔30秒会重新获取并更新数据
    registry-fetch-interval-seconds: 5 # 每隔5秒会重新获取并更新Eureka Server服务的列表
    register-with-eureka: true # 是否注册自己的信息到EurekaServer，默认是true
    fetch-registry: true # 是否拉取其它服务的信息，默认是true
    service-url: # EurekaServer的地址，现在是自己的地址，如果是集群，需要加上其它Server的地址。
      defaultZone: http://127.0.0.1:10086/eureka, http://127.0.0.1:10087/eureka
  instance:
    prefer-ip-address: true # 当调用getHostname获取实例的hostname时，返回ip而不是host名称
    ip-address: 127.0.0.1 # 指定自己的ip信息，不指定的话会自己寻找

假设有一个用户服务：http://127.0.0.1:8080/user/6访问ID为6的用户。

那么application.yml中：

不配置zuul，默认zuul会自动从eureka中拉取所有服务列表，网关IP、Port后的匹配前缀为serviceId。如serviceId为user-service，访问网关地址http://127.0.0.1:10010/user-service/user/6，跳转访问http://127.0.0.1:8080/user/6

如下配置：
zuul:
  routes:
    user-service: #routes的自定义ID，不重复的话写什么都可以，规范上和serviceId保持一致
      path: /my-user-service/** 
      serviceId: user-service
可以新增http://127.0.0.1:10010/my-user-service/user/6也能跳转访问http://127.0.0.1:8080/user/6

上面对应的简写为：
zuul:
  routes:
    user-service: /my-user-service/**
格式：serviceId: 前缀映射路径

更多配置：
zuul:
  routes:
    user-service:
      path: /user/**
      serviceId: user-service
      strip-prefix: false 
  strip-prefix: true
  ignored-services: 
    - consumer-service 
  prefix: /api
strip-prefix表示匹配路径是否保留，可以全局配置，可以局部配置。默认true，匹配路径保留。
ignored-services表示忽略进行网关跳转的服务，格式为：- serviceId
prefix可配置全局的前缀，即跳转到各服务的共同前缀。

当前http://127.0.0.1:10010/api/user/6跳转访问http://127.0.0.1:8080/user/6。如果局部配置的那个strip-prefix为true，http://127.0.0.1:10010/api/user/user/6跳转访问http://127.0.0.1:8080/user/6

ZuulFilter是过滤器的顶级父类。其中定义的4个最重要的方法：
public abstract ZuulFilter implements IZuulFilter{

    abstract public String filterType();

    abstract public int filterOrder();
    
    boolean shouldFilter();// 来自IZuulFilter

    Object run() throws ZuulException;// IZuulFilter
}
shouldFilter：返回一个Boolean值，判断该过滤器是否需要执行。返回true执行，返回false不执行。

run：过滤器的具体业务逻辑。

filterType：返回字符串，代表过滤器的类型。包含以下4种：

pre：请求在被路由之前执行

routing：在路由请求时调用

post：在routing和errror过滤器之后调用

error：处理请求时发生错误调用

filterOrder：通过返回的int值来定义过滤器的执行顺序，数字越小优先级越高。

正常流程：

请求到达首先会经过pre类型过滤器，而后到达routing类型，进行路由，请求就到达真正的服务提供者，执行请求，返回结果后，会到达post过滤器。而后返回响应。

异常流程：

整个过程中，pre或者routing过滤器出现异常，都会直接进入error过滤器，再error处理完毕后，会将请求交给POST过滤器，最后返回给用户。

如果是error过滤器自己出现异常，最终也会进入POST过滤器，而后返回。

如果是POST过滤器出现异常，会跳转到error过滤器，但是与pre和routing不同的时，请求不会再到达POST过滤器了。

使用场景举例：

请求鉴权：一般放在pre类型，如果发现没有访问权限，直接就拦截了

异常处理：一般会在error类型和post类型过滤器中结合来处理。

服务调用时长统计：pre和post结合使用。

自定义过滤器：

@Component
public class LoginFilter extends ZuulFilter{
    @Override
    public String filterType() {
        // 登录校验，肯定是在前置拦截
        return "pre";
    }

    @Override
    public int filterOrder() {
        // 顺序设置为1
        return 1;
    }

    @Override
    public boolean shouldFilter() {
        // 返回true，代表过滤器生效。
        return true;
    }

    @Override
    public Object run() throws ZuulException {
        // 登录校验逻辑。
        // 1）获取Zuul提供的请求上下文对象
        RequestContext ctx = RequestContext.getCurrentContext();
        // 2) 从上下文中获取request对象
        HttpServletRequest req = ctx.getRequest();
        // 3) 从请求中获取token
        String token = req.getParameter("access-token");
        // 4) 判断
        if(token == null || "".equals(token.trim())){
            // 没有token，登录校验失败，拦截
            ctx.setSendZuulResponse(false);
            // 返回401状态码。也可以考虑重定向到登录页。
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        // 校验通过，可以考虑把用户信息放入上下文，继续向后执行
        return null;
    }
}

Zuul中默认就已经集成了Ribbon负载均衡和Hystrix熔断机制。但是所有的超时策略都是走的默认值，比如熔断超时时间只有1S，很容易就触发了。

zuul:
  retryable: true
ribbon:
  ConnectTimeout: 250 # 连接超时时间(ms)
  ReadTimeout: 2000 # 通信超时时间(ms)
  OkToRetryOnAllOperations: true # 是否对所有操作重试
  MaxAutoRetriesNextServer: 2 # 同一服务不同实例的重试次数
  MaxAutoRetries: 1 # 同一实例的重试次数
hystrix:
  command:
  	default:
        execution:
          isolation:
            thread:
              timeoutInMillisecond: 6000 # 熔断超时时长：6000ms