# 从浅入深 学习 SpringCloud 微服务架构(十)--zuul(2)

从浅入深 学习 SpringCloud 微服务架构(十)–zuul(2)


1、zuul 路由:基础路由配置

1.1 在子工程(子模块) api_zuul_service 中,修改 配置文件 application.yml 添加基础路由配置。

##  spring_cloud_demo\api_zuul_service\src\main\resources\application.yml

server:
  port: 8088  # 启动端口 命令行注入。

spring:
  application:
    name: api-zuul-service  #spring应用名, # 注意 FeignClient 不支持名字带下划线

zuul:   # 基础路由配置。
  routes:
    product-service:  # 路由 id,随便写。# 商品微服务。
      path: /product-service/**   # 映射路径。 # localhost:8088/product-service
      url: http://127.0.0.1:9001  # 映射路径对应的实际微服务 url 地址。

1.2 启动 父工程 spring_cloud_demo 下 全部子项目的启动类,进行测试:

浏览器地址栏输入:localhost:8088/product-service 就相当于 http://127.0.0.1:9001
所以:localhost:8088/product-service/product/1 就相当于 http://127.0.0.1:9001/product/1

在这里插入图片描述

2、zuul 路由:面向服务的路由配置

2.1 在子工程(子模块) api_zuul_service 中,添加 eureka 的依赖坐标。

<?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_demo</artifactId>
        <groupId>djh.it</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>api_zuul_service</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-zuul</artifactId>
        </dependency>
        <!-- 引入 EurekaClient 依赖坐标 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
    </dependencies>

</project>
<!-- spring_cloud_demo\api_zuul_service\pom.xml -->

2.2 在子工程(子模块) api_zuul_service 的启动类,开启 eureka 客户端服务发现。

/**
 *   spring_cloud_demo\api_zuul_service\src\main\java\djh\it\zuul\ZuulServerApplication.java
 *
 *   2024-5-5 zuul 网关服务 启动类 ZuulServerApplication.java
 */
package djh.it.zuul;

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

@SpringBootApplication
@EnableZuulProxy   //开启 zuul 网关功能
@EnableEurekaClient  //激活 EurekaClient, 同 @EnableDiscoveryClient 注解相同。
public class ZuulServerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZuulServerApplication.class, args);
    }
}


2.3 在子工程(子模块) api_zuul_service 的 application.yml 配置文件中,添加 eureka 注册中心信息。

##  spring_cloud_demo\api_zuul_service\src\main\resources\application.yml

server:
  port: 8088  # 启动端口 命令行注入。

spring:
  application:
    name: api-zuul-service  #spring应用名, # 注意 FeignClient 不支持名字带下划线

zuul:   # 基础路由配置。
  routes:
    product-service:  # 路由 id,随便写。# 商品微服务。
      path: /product-service/**   # 映射路径。 # localhost:8088/product-service
#      url: http://127.0.0.1:9001  # 映射路径对应的实际微服务 url 地址。
      serviceId: service-product  # 根据服务对象名(或称ID)进行映射。面向服务名的路由配置,好处是IP地址发生改变不会受影响。

eureka:  # 配置 Eureka
  client:
    service-url:
      defaultZone: http://localhost:9000/eureka/
    instance:
      prefer-ip-address: true  # 使用ip地址注册。

2.4 在子工程(子模块) api_zuul_service 的 application.yml 配置文件中,修改路由的映射配置。

##  spring_cloud_demo\api_zuul_service\src\main\resources\application.yml

server:
  port: 8088  # 启动端口 命令行注入。

spring:
  application:
    name: api-zuul-service  #spring应用名, # 注意 FeignClient 不支持名字带下划线

zuul:   # 基础路由配置。
  routes:
    product-service:  # 路由 id,随便写。# 商品微服务。
      path: /product-service/**   # 映射路径。 # localhost:8088/product-service
#      url: http://127.0.0.1:9001  # 映射路径对应的实际微服务 url 地址。
      serviceId: service-product  # 根据服务对象名(或称ID)进行映射。面向服务名的路由配置,好处是IP地址发生改变不会受影响。

eureka:  # 配置 Eureka
  client:
    service-url:
      defaultZone: http://localhost:9000/eureka/
    instance:
      prefer-ip-address: true  # 使用ip地址注册。

2.5 启动 父工程 spring_cloud_demo 下 全部子项目的启动类,进行测试:

浏览器地址栏输入:localhost:8088/product-service 就相当于 http://127.0.0.1:9001
所以:localhost:8088/product-service/product/1 就相当于 http://127.0.0.1:9001/product/1

在这里插入图片描述

3、zuul 路由:简化路由配置

3.1 在子工程(子模块) api_zuul_service 的 application.yml 配置文件中,修改路由的映射配置

##  spring_cloud_demo\api_zuul_service\src\main\resources\application.yml

server:
  port: 8088  # 启动端口 命令行注入。

spring:
  application:
    name: api-zuul-service  #spring应用名, # 注意 FeignClient 不支持名字带下划线

zuul:   # 基础路由配置。
  routes:
    service-order:    # 当前的微服务名称 service-order,默认的请求映射路径是 /service-order/**
    service-product: /product-service/**   # 如果路由 id 和对应的微服务的 serviceId 一致,可以简化成引。
#    product-service:  # 路由 id,随便写。# 商品微服务。
#      path: /product-service/**   # 映射路径。 # localhost:8088/product-service
##      url: http://127.0.0.1:9001  # 映射路径对应的实际微服务 url 地址。
#      serviceId: service-product  # 根据服务对象名(或称ID)进行映射。面向服务名的路由配置,好处是IP地址发生改变不会受影响。

eureka:  # 配置 Eureka
  client:
    service-url:
      defaultZone: http://localhost:9000/eureka/
    instance:
      prefer-ip-address: true  # 使用ip地址注册。

3.2 启动 父工程 spring_cloud_demo 下 全部子项目的启动类,进行测试,同样可以正常访问:

浏览器地址栏输入:localhost:8088/service-product 就相当于 http://127.0.0.1:9001
所以:localhost:8088/service-product/product/1 就相当于 http://127.0.0.1:9001/product/1

浏览器地址栏输入:localhost:8088/service-order 就相当于 http://127.0.0.1:9002
所以:localhost:8088/service-order/order/buy/1 就相当于 http://127.0.0.1:9002/order/buy/1

在这里插入图片描述

在这里插入图片描述


4、zuul 过滤器:入门

4.1 Zuul 加入微服务架构后,微服务架构大概如下:

在这里插入图片描述

4.2 Zuul 包含了两个核心功能:对请求的路由和过滤。

  • 其中路由功能负责将外部请求转发到具体的微服务实例上,是实现外部访问统一入口的基础;
    而过滤器功能则负责对请求的处理过程进行干预,是实现请求校验、服务聚合等功能的基础。

  • 其实,路由功能在真正运行时,它的路由映射和请求转发同样也由几个不同的过滤器完成的。
    所以,过滤器可以说是 Zuul 实现 API 网关功能最为核心的部件,

  • 每一个进入 Zuul 的 HTTP 请求都会经过一系列的过滤器处理链得到请求响应并返回给客户端。

4.3 ZuulFilter 过滤器 简介

Zuul 中的过滤器跟我们之前使用的 javax.servlet.Filter 不一样,javax,servlet.Filter 只有一种类型,可以通过配置 uriPatterns 来拦截对应的请求。而 zuul 中的过滤器总共有4种类型,且每种类型都有对应的使用场景。

  • 1、PRE : 这种过滤器在请求被路由之前调用。

    我们可利用这种过滤器实现身份验证、在集群中选择请求的微服务、记录调试信息等。

  • 2、ROUTING : 这种过滤器将请求路由到微服务。

    这种过滤器用于构建发送给微服务的请求,并使用 Apache HttpClient 或 Netfilx Ribbon 请求微服务。

  • 3、POST : 这种过滤器在路由到微服务以后执行。

    这种过滤器可用来为响应添加标准的 HTTPHeader、收集统计信息和指标、将响应从微服务发送给客户端等。

  • 4、ERROR : 在其他阶段发生错误时执行该过滤器。
    在这里插入图片描述

4.4 Zuul 提供了自定义过滤器的功能,实现起来十分简单,只需要编写一个类去实现 Zuul 提供的接口。

1)在子工程) api_zuul_service (子模块)中,创建自定义过滤器类 LoginFilter.java


/**
 *   spring_cloud_demo\api_zuul_service\src\main\java\djh\it\zuul\filter\LoginFilter.java
 *
 *   2024-5-5  自定义的 zuul 过滤器 LoginFilter.java,让它继承抽象父类。
 */

package djh.it.zuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.stereotype.Component;

@Component
public class LoginFilter extends ZuulFilter {
    /**
     *  定义过滤器类型:pre, routing, post, error
     */
    public String filterType() {
        return "pre";
    }

    /**
     *  指定过滤器的执行顺序,返回值越小,执行顺序越高。
     */
    public int filterOrder() {
        return 1;
    }

    /**
     *  当前过滤器是否生效:true : 使用此过滤器,false : 不使用此过滤器。
     */
    public boolean shouldFilter() {
        return true;
    }

    /**
     *  指定过滤器中的业务逻辑
     */
    public Object run() throws ZuulException {
        System.out.println("执行了过滤器 filter");
        return null;
    }
}

2)重新启动 父工程 spring_cloud_demo 下 全部子项目的启动类,进行测试,正常访问:

浏览器地址栏输入:localhost:8088/service-product 就相当于 http://127.0.0.1:9001
所以:localhost:8088/service-product/product/1 就相当于 http://127.0.0.1:9001/product/1

浏览器地址栏输入:localhost:8088/service-order 就相当于 http://127.0.0.1:9002
所以:localhost:8088/service-order/order/buy/1 就相当于 http://127.0.0.1:9002/order/buy/1

idea 控制后台输出业务逻辑。

在这里插入图片描述

5、zuul 过滤器:身份认证过滤器

5.1 在子工程 api_zuul_service (子模块)中,修改 自定义过滤器类 LoginFilter.java ,添加身份认证。

/**
 *   spring_cloud_demo\api_zuul_service\src\main\java\djh\it\zuul\filter\LoginFilter.java
 *
 *   2024-5-5  自定义的 zuul 过滤器 LoginFilter.java,让它继承抽象父类。
 */

package djh.it.zuul.filter;

import com.netflix.zuul.ZuulFilter;
import com.netflix.zuul.context.RequestContext;
import com.netflix.zuul.exception.ZuulException;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;

@Component
public class LoginFilter extends ZuulFilter {
    /**
     *  定义过滤器类型:pre, routing, post, error
     */
    public String filterType() {
        return "pre";
    }

    /**
     *  指定过滤器的执行顺序,返回值越小,执行顺序越高。
     */
    public int filterOrder() {
        return 1;
    }

    /**
     *  当前过滤器是否生效:true : 使用此过滤器,false : 不使用此过滤器。
     */
    public boolean shouldFilter() {
        return true;
    }

    /**
     *  指定过滤器中的业务逻辑: 身份认证:
     *      1)所有的请求需要携带一个参数:access-token
     *      2)获取 request 请求,
     *      3)通过 request 获取参数 access-token
     *      4)判断 token 是否为空:
     *      4.1 token == null : 身份验证失败。
     *      4.2 token != null : 执行后续操作。
     *   在 zuul 网关中,通过 RequestContext 的上下文对象,可以获取对象 request 对象。
     */
    public Object run() throws ZuulException {
        System.out.println("执行了过滤器 filter");
        //1.获取zuul提供的上下文对象 RequestContext
        RequestContext ctx = RequestContext.getCurrentContext();
        //2.从 RequestContext 中获取 request
        HttpServletRequest request = ctx.getRequest();
        //3.获取请求参数 access-token
        String token = request.getParameter("access-token");
        //4.判断
        if(token == null){
            //4.1 如果 token == null, 拦截请求返回认证失败。
            ctx.setSendZuulResponse(false);  //拦截请求
            ctx.setResponseStatusCode(HttpStatus.UNAUTHORIZED.value());
        }
        //4.2 如果 token != null 续费后续操作。
        return null;
    }
}


5.2 重新启动 父工程 spring_cloud_demo 下 全部子项目的启动类,进行测试,正常访问:

浏览器地址栏输入:localhost:8088/service-product/product/1 就相当于 http://127.0.0.1:9001/product/1
未带参数,原来能正常访问,有了过滤器就不行了,

带上参数,再次测试,可以正常访问。

在这里插入图片描述

在这里插入图片描述

上一节相关链接请点击:
# 从浅入深 学习 SpringCloud 微服务架构(十)–zuul(1)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

段子手-168

你的鼓励将是我你的创作最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值