zuul路由网关

官网资料：

• https://github.com/Netflix/zuul/wiki/Getting-Started
• https://cloud.spring.io/spring-cloud-static/spring-cloud-netflix/2.2.1.RELEASE/reference/html/#router-and-filter-zuul

概述

是什么

Zuul是一种提供动态路由、监视、弹性、安全性等功能的边缘服务。

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

API网关为微服务架构中的服务提供了统一的访问入口，客户端通过API网关访问相关服务。API网关的定义类似于设计模式中的门面模式，它相当于整个微服务架构中的门面，所有客户端的访问都通过它来进行路由及过滤。它实现了请求路由、负载均衡、校验过滤、服务容错、服务聚合等功能。

Zuul包含了如下最主要的功能：

代理+路由+过滤三大功能

路由转发案例

zuul服务

新建Module模块cloud-zuul-gateway9527

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>tudou_cloud</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-zuul-gateway9527</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </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-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

YML

server:
  port: 9527

spring:
  application:
    name: cloud-zuul-gateway

eureka:
  client:
    service-url:
      #defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7003.com:7003/eureka
      defaultZone: http://eureka7001.com:7001/eureka
  instance:
    instance-id: gateway-9527.com
    prefer-ip-address: true

hosts修改: 127.0.0.1 myzuul.com

主启动类

@SpringBootApplication
@EnableZuulProxy
public class Zuul_9527_StartSpringCloudApp {
    public static void main(String[] args) {
        SpringApplication.run(Zuul_9527_StartSpringCloudApp.class, args);
    }
}

启动访问eureka

普通业务服务

原有：cloud-provider-payment8002

新建：cloud-provider-sms8008

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>tudou_cloud</artifactId>
        <groupId>org.example</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-provider-sms8008</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

yml

server:
  port: 8008

###服务名称(服务注册到eureka名称)
spring:
  application:
    name: cloud-provider-sms

eureka:
  client: #服务提供者provider注册进eureka服务列表内
    service-url:
      register-with-eureka: true
      fetch-registry: true
      defaultZone: http://eureka7001.com:7001/eureka   # eureka集群加@老本版

业务类

@RestController
public class SMSController {
    @Value("${server.port}")
    private String serverPort;

    @GetMapping("/sms")
    public String sms() {
        return "sms provider service: " + "\t" + serverPort;
    }
}

主启动

@SpringBootApplication
@EnableEurekaClient
public class MainAppSMS8008 {
    public static void main(String[] args) {
        SpringApplication.run(MainAppSMS8008.class, args);
    }
}

启动访问eureka

配置路由转发

未配置前，直接访问8001/8008

• http://localhost:8002/payment/get/1
• http://localhost:8008/sms/

成功访问

配置路由转发：在zuul服务的yml配置

zuul:
  routes: # 路由映射配置
    mypayment.serviceId: cloud-provider-service   #注册进eureka服务器的地址
    mypayment.path: /mypayment/**                 #浏览器地址栏输入的路径
    mysms.serviceId: cloud-provider-sms
    mysms.path: /mysms/**

配置后访问：通过9527转发到8001/8008

• http://localhost:9527/mypayment/payment/get/1
• http://localhost:9527/mysms/sms/

设置统一公共前缀

zuul:
  prefix: /tudou  #统一前缀
  routes: # 路由映射配置
    mypayment.serviceId: cloud-provider-service   #注册进eureka服务器的地址
    mypayment.path: /mypayment/**                 #浏览器地址栏输入的路径
    mysms.serviceId: cloud-provider-sms
    mysms.path: /mysms/**

• http://localhost:9527/tudou/mypayment/payment/get/1
• http://localhost:9527/tudou/mysms/sms/

查看路由信息

pom

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

yml

# 开启查看路由的端点
management:
  endpoints:
    web:
      exposure:
        include: 'routes' 

访问

• http://localhost:9527/actuator/routes

过滤器案例

zuul过滤器概述

Zuul 的核心逻辑是由一系列紧密配合工作的 Filter 来实现的，它们能够在进行 HTTP 请求或者响应的时候执行相关操作。可以说，没有 Filter 责任链，就没有如今的 Zuul，更不可能构成功能丰富的网关。基本上你想要在网关实现的功能都要与 Filter 有关。它是 Zuul 中最为开放与核心的功能。 Zuul Filter 的主要特性有以下几点：

• Filter 的类型：Filter 的类型决定了此 Filter 在 Filter 链中的执行顺序。
  • pre：在请求被路由到目标服务前执行，比如权限校验、打印日志等功能；
  • routing：在请求被路由到目标服务时执行
  • post：在请求被路由到目标服务后执行，比如给目标服务的响应添加头信息，收集统计数据等功能；
  • error：请求在其他阶段发生错误时执行。
• Filter 的执行顺序：同一种类型的 Filter 可以通过 flterOrder() 方法来设定执行顺序。一般会根据业务的执行顺序需求，来设定自定义 Filter 的执行顺序。
• Filter 的执行条件：Filter 运行所需要的标准或条件。
• Filter 的执行效果：符合某个 Filter 执行条件，产生的执行效果。

zuul过滤器案例

controller

/**
 * @Author LR
 * @Date 2022/6/22 20:43
 */
@Component
@Slf4j
public class PreLogFilter extends ZuulFilter {

    @Override
    public String filterType() {
        return "pre";
    }

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

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

    @Override
    public Object run() throws ZuulException {
        RequestContext requestContext = RequestContext.getCurrentContext();
        HttpServletRequest request = requestContext.getRequest();
        String host = request.getRemoteHost();
        String method = request.getMethod();
        String uri = request.getRequestURI();
        log.info("=====> Remote host:{},method:{},uri:{}", host, method, uri);
        System.out.println("********"+new Date().getTime());
        return null;
    }
}

测试

• http://localhost:9527/tudou/mysms/sms/

在调用8008时会先打印日志

参考

• https://www.bilibili.com/video/BV18E411x7eT?p=65&spm_id_from=pageDriver&vd_source=cebe2375651859d5f392f6ee8b296bb1

• https://blog.csdn.net/wo18237095579/article/details/83543592