7. SpringCloud之Zuul分布式服务网关

作者: 天还下着毛毛雨 | 来源:发表于2022-04-06 20:44 被阅读0次

image.png

简介

Zuul 是 springcloud 项目的流量入口，作为分布式网关分布式，理论上所有进入到微服务系统的请求都要经过 zuul 来过滤和路由。

1、zuul 服务网关的搭建

新建一个Springboot子工程

1.1、导入依赖

<!-- zuul也需要注册到注册中心-->       
<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>

1.2、配置详解

1.2.1、配置拦截的 url 和该 url 路由的服务

## zuul路由配置
## 使用路径方式#使用路径方式匹配路由规则。
##参数key结构: zuul.routes.customName.path=Xxx
##用于配置路径匹配规则。其中customName自定义。 通常使用要调用的服务名称，方便后期管理
##可使用的通配符有:* ** ?
## ? 单个字符
## * 任意多个字符，不包含多级路径
## ** 任意多个字符，包含多级路径

## /user/**开头的请求 路由到 micro-user 服务，不省略前缀
## /order/**开头的请求 路由到 micro-order 服务，不省略前缀
zuul.routes.micro-user.path=/user/**
zuul.routes.micro-user.serviceId=micro-user
## 不要忽略前缀 /user  比如/user/getUsername 路由到 micro-user 服务接口url还是/user/getUsername,默认为true,路由到micro-order 会去掉前缀为/getUsername
zuul.routes.micro-user.stripPrefix=false

zuul.routes.micro-order.path=/order/**
zuul.routes.micro-order.serviceId=micro-order
zuul.routes.micro-order.stripPrefix=false

1.2.2、配置敏感请求头过滤

## 配置敏感请求头过滤
#针对某个服务传输指定的headers信息，默认是过滤掉Cookie, Set-Cookie, Authorization
# 里置空就是不要过滤掉这三个
zuul.routes.micro-user.sensitive-headers=
zuul.routes.micro-order.sensitive-headers=

1.2.3、Zuul本地跳转

# Zuul本地跳转
#zuul.routes.zuul-server.path=/local/**
#zuul.routes.zuul-server.url=forward:/local

1.2.4、Zuul 跳转到指定地址

## 参数key结构:
## zuul.routes.customName.url=XXx
## ur1用于配置符合path的请求路径路由到的服务地址。
## zuul.routes.micro-order.path=/order/**
## zuul.routes.micro-order.url=http://localhost:8080/

最后还需要把zuul注册到注册中心

spring.application.name=zuul
#spring.cloud.controller.uri= http://localhost:9009/
server.port=9031
#eureka.client.service-url.defaultZone=http://localhost:9001/eureka/
eureka.client.serviceUrl.defaultZone=http://admin:admin@localhost:9001/eureka/

1.3、启动类

加上@EnableZuulProxy 注解

@SpringBootApplication
@EnableZuulProxy
public class ZuulApplication {

    public static void main(String[] args) {
        SpringApplication.run(ZuulApplication.class, args);
    }
}

1.4、获取路由规则的接口

http://localhost:9031/actuator/routes

image.png

注意, /actuator/**的接口是由 spring-boot-starter-actuator 这个包提供的,maven引入这个包

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

配置文件里，暴露 /actuator/** 之类的接口

management.endpoints.web.exposure.include=*

2、路由动态刷新

路由动态刷新其实就是分布式配置中心的思路，就是路由配置规则我们可以在项目启动后，通过修改远程 GitHub 上的配置，让配置在运行时生效，不需要重启机器。所以就需要加入配置中心的配置。

2.1、引入配置中心客户端依赖和SpringCloudBus消息依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

2.2、配置信息

# 指定配置中心拉取该服务master分支从dev环境的配置
spring.cloud.config.label=master
spring.cloud.config.profile=dev
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.serviceId=config-server

#如果连接不上获取配置有问题，快速响应失败
spring.cloud.config.fail-fast=true
#默认重试的间隔时间，默认1000ms
spring.cloud.config.retry.multiplier=1000
#下一间隔时间的乘数，默认是1.1
#spring.cloud.config.retry.initial-interval=1.1
#最大间隔时间，最大2000ms
spring.cloud.config.retry.max-interval=2000
#最大重试次数，默认6次
spring.cloud.config.retry.max-attempts=6

2.3、配置动态刷新类

由于默认的zuul配置加载类ZuulProperties 上没有@RefreshScope注解，所以无法刷新配置, 需要我们自己注册 ZuulProperties 类的bean,并加上@RefreshScope。

@Bean
@ConfigurationProperties(prefix = "zuul")
// bean刷新的作用域
@RefreshScope
// 一定要加这个,不然会和默认的配置bean 有冲突
@Primary
public ZuulProperties zuulProperties(){
    return new ZuulProperties();
}

之后把路由的配置信息统统挪到github上

/config/zuul-dev.properties

#其实就是连接 mq 的配置
spring.rabbitmq.host=***
spring.rabbitmq.port=5672
spring.rabbitmq.username=root
spring.rabbitmq.password=123456
# 刷新配置 url http://localhost:8081/actuator/bus-refresh
spring.cloud.bus.refresh.enabled=true
spring.cloud.bus.trace.enabled=true


## zuul路由配置
## 使用路径方式#使用路径方式匹配路由规则。
##参数key结构: zuul.routes.customName.path=Xxx
##用于配置路径匹配规则。其中customName自定义。 通常使用要调用的服务名称，方便后期管理
##可使用的通配符有:* ** ?
## ? 单个字符
## * 任意多个字符，不包含多级路径
## ** 任意多个字符，包含多级路径

zuul.routes.micro-user.path=/user/**
zuul.routes.micro-user.serviceId=micro-user
## 不要忽略前缀 /user  比如/user/getUsername 路由到 micro-user 服务接口url还是/user/getUsername,默认为true,路由到micro-order 会去掉前缀为/getUsername
zuul.routes.micro-user.stripPrefix=false

zuul.routes.micro-order.path=/order/**
zuul.routes.micro-order.serviceId=micro-order
zuul.routes.micro-order.stripPrefix=false

## 参数key结构:
## zuul.routes.customName.url=XXx
## ur1用于配置符合path的请求路径路由到的服务地址。
## zuul.routes.micro-order.url=http://localhost:8080/

## 配置敏感请求头过滤
#针对某个服务传输指定的headers信息，默认是过滤掉Cookie, Set-Cookie, Authorization
# 里置空就是不要过滤掉这三个
zuul.routes.micro-user.sensitive-headers=
zuul.routes.micro-order.sensitive-headers=

# 路由到本地
#zuul.routes.zuul-server.path=/local/**
#zuul.routes.zuul-server.url=forward: /local

启动之后，在github上修改配置文件,再随便调消息总线端点的刷新接口,就能动态的更改路由配置啦。

http://localhost:8085/actuator/bus-refresh

3、zuul 过滤器

Zuul 大部分功能都是通过过滤器来实现的，Zuul 定义了 4 种标准的过滤器类型，这些过滤器类型对应于请求的典型生命周期。

3.1、ZuulFilter 类

Zuul过滤器继承ZuulFilter 类,重写以下方法

filterType 过滤的类型,有error，post，pre，route四种,对应四种过滤器类型
filterOrder 过滤顺序
shouldFilter 是否需要过滤
run 过滤的逻辑

3.2、四种过滤器

3.2.1、pre

这种过滤器在请求被路由之前调用。可利用这种过滤器实现身份验证、在集群中选

择请求的微服务，记录调试信息等。

@Component
public class PreLogFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.PRE_TYPE;
    }

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

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

    @Override
    public Object run() throws ZuulException {
        return null;
    }
}

3.2.2、routing

这种过滤器将请求路由到微服务。这种过滤器用于构建发送给微服务的请求，并

使用 apache httpclient 或 netflix ribbon 请求微服务。

@Component
public class RouteFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.ROUTE_TYPE;
    }

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

    @Override
    public boolean shouldFilter() {
        return RequestContext.getCurrentContext().sendZuulResponse();
    }

    @Override
    public Object run() throws ZuulException {
        System.out.println("进入路由");
        return null;
    }

}

3.2.3、post

这种过滤器在路由到微服务以后执行。这种过滤器可用来为响应添加标准的 http

header、收集统计信息和指标、将响应从微服务发送给客户端等。

@Component
public class PostFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.ROUTE_TYPE;
    }

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

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

    @Override
    public Object run() throws ZuulException {
        return null;
    }
}

3.2.4、error

在其他阶段发送错误时执行该过滤器。

@Component
public class ErrLogFilter extends ZuulFilter {
    @Override
    public String filterType() {
        return FilterConstants.ERROR_TYPE;
    }

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

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

    @Override
    public Object run() throws ZuulException {
        return null;
    }
}

3.3、执行流程

image.png

网友评论

本文标题：7. SpringCloud之Zuul分布式服务网关

本文链接：https://www.haomeiwen.com/subject/pxjdsrtx.html

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

7. SpringCloud之Zuul分布式服务网关

简介

1、zuul 服务网关的搭建

1.1、导入依赖

1.2、配置详解

1.2.1、配置拦截的 url 和该 url 路由的服务

1.2.2、配置敏感请求头过滤

1.2.3、Zuul本地跳转

1.2.4、Zuul 跳转到指定地址

1.3、启动类

1.4、获取路由规则的接口

2、路由动态刷新

2.1、引入配置中心客户端依赖和SpringCloudBus消息依赖

2.2、配置信息

2.3、配置动态刷新类

3、zuul 过滤器

3.1、ZuulFilter 类

3.2、四种过滤器

3.2.1、pre

3.2.2、routing

3.2.3、post

3.2.4、error

3.3、执行流程

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

SpringCloud

一些收藏

7. SpringCloud之Zuul分布式服务网关

简介

1、zuul 服务网关的搭建

1.1、导入依赖

1.2、配置详解

1.2.1、配置拦截的 url 和该 url 路由的服务

1.2.2、配置敏感请求头过滤

1.2.3、Zuul本地跳转

1.2.4、Zuul 跳转到指定地址

1.3、启动类

1.4、获取路由规则的接口

2、路由动态刷新

2.1、引入配置中心客户端 依赖和SpringCloudBus消息依赖

2.2、配置信息

2.3、配置动态刷新类

3、zuul 过滤器

3.1、ZuulFilter 类

3.2、四种过滤器

3.2.1、pre

3.2.2、routing

3.2.3、post

3.2.4、error

3.3、执行流程

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

SpringCloud

一些收藏

2.1、引入配置中心客户端依赖和SpringCloudBus消息依赖