SpringCloud的学习（四）Micrometer、GateWay

Micrometer

分布式链路追踪

在微服务框架中，一个由客户端发起的请求在后端系统中会经过多个不同的的服务节点调用来协同产生最后的请求结果，每一个前段请求都会形成一条复杂的分布式服务调用链路，链路中的任何一环出现高延时或错误都会引起整个请求最后的失败。

分布式链路追踪技术要解决的问题，分布式链路追踪（Distributed Tracing），就是将一次分布式请求还原成调用链路，进行日志记录，性能监控并将一次分布式请求的调用情况集中展示。比如各个服务节点上的耗时、请求具体到达哪台机器上、每个服务节点的请求状态等等。

分布式链路追踪原理

一条链路追踪会在每个服务调用的时候加上Trace ID 和Span ID，链路通过Trace ID唯一标识，Span标识发起的请求信息，各个span通过parent id关联起来（Span：表示调用链路来源，通俗的理解就是一次请求信息）

Zipkin

Zipkin是一种分布式链路跟踪系统图形化的工具，Zipkin 是 Twitter 开源的分布式跟踪系统，能够收集微服务运行过程中的实时调用链路信息，并能够将这些调用链路信息展示到Web图形化界面上供开发人员分析，开发人员能够从ZipKin中分析出调用链路中的性能瓶颈，识别出存在问题的应用程序，进而定位问题和解决问题。

运行jar之后，浏览器输入地址：http://localhost:9411/zipkin/，就可以访问zikpin的控制台

使用步骤

父工程的pom文件导入依赖：

<!--micrometer-tracing-bom导入链路追踪版本中心  1-->
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-tracing-bom</artifactId>
    <version>${micrometer-tracing.version}</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>
<!--micrometer-tracing指标追踪  2-->
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-tracing</artifactId>
    <version>${micrometer-tracing.version}</version>
</dependency>
<!--micrometer-tracing-bridge-brave适配zipkin的桥接包 3-->
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-tracing-bridge-brave</artifactId>
    <version>${micrometer-tracing.version}</version>
</dependency>
<!--micrometer-observation 4-->
<dependency>
    <groupId>io.micrometer</groupId>
    <artifactId>micrometer-observation</artifactId>
    <version>${micrometer-observation.version}</version>
</dependency>
<!--feign-micrometer 5-->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-micrometer</artifactId>
    <version>${feign-micrometer.version}</version>
</dependency>
<!--zipkin-reporter-brave 6-->
<dependency>
    <groupId>io.zipkin.reporter2</groupId>
    <artifactId>zipkin-reporter-brave</artifactId>
    <version>${zipkin-reporter-brave.version}</version>
</dependency>

版本：

<micrometer-tracing.version>1.2.0</micrometer-tracing.version>
<micrometer-observation.version>1.12.0</micrometer-observation.version>
<feign-micrometer.version>12.5</feign-micrometer.version>
<zipkin-reporter-brave.version>2.17.0</zipkin-reporter-brave.version>

在要监测的服务端和服务客户端的模块的pom文件中引入依赖：

<!--micrometer-tracing指标追踪  1-->
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-tracing</artifactId>
    </dependency>
    <!--micrometer-tracing-bridge-brave适配zipkin的桥接包 2-->
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-tracing-bridge-brave</artifactId>
    </dependency>
    <!--micrometer-observation 3-->
    <dependency>
        <groupId>io.micrometer</groupId>
        <artifactId>micrometer-observation</artifactId>
    </dependency>
    <!--feign-micrometer 4-->
    <dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-micrometer</artifactId>
    </dependency>
    <!--zipkin-reporter-brave 5-->
    <dependency>
        <groupId>io.zipkin.reporter2</groupId>
        <artifactId>zipkin-reporter-brave</artifactId>
    </dependency>

同时加上yaml文件配置

# zipkin图形展现地址和采样率设置
management:
  zipkin:
    tracing:
      endpoint: <http://localhost:9411/api/v2/spans>
  tracing:
    sampling:
      probability: 1.0 #采样率默认为0.1(0.1就是10次只能有一次被记录下来)，值越大收集越及时。

GateWay网关

Gate是在spring生态系统之上构建的api网关服务。它旨在为微服务架构提供一种简单有效的统一的api路由管理方式。

作用：反向代理、鉴权、流量控制、熔断、日志监控

它本身也是一个微服务，需要注册进服务注册中心。

GateWay三大核心

Route 路由：路由是构建网关的基本模块，它由ID，目标URI，一系列的断言和过滤器组成，如果断言为true则匹配改路由
Predicate 断言：开发人员可以匹配HTTP请求中的所有内容（例如请求头或请求参数），如果请求与断言相匹配则进行路由
Filter 过滤：使用过滤器，可以在请求被路由之前或者之后对请求进行修改

工作流程

客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由，将其发送到 Gateway Web Handler。Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑，然后返回。

使用步骤

新建一个模块，比如叫cloud-gateway9527，专门负责网关。

在这个模块的pom文件中引入依赖：

<dependencies>
        <!--gateway-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--服务注册发现consul discovery,网关也要注册进服务注册中心统一管控-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>
        <!-- 指标监控健康检查的actuator,网关是响应式编程删除掉spring-boot-starter-web dependency-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
    </dependencies>

配置yaml信息

server:
  port: 9527

spring:
  application:
    name: cloud-gateway #以微服务注册进consul或nacos服务列表内
  cloud:
    consul: #配置consul地址
      host: localhost
      port: 8500
      discovery:
        prefer-ip-address: true
        service-name: ${spring.application.name}
    gateway:
      routes:
        - id: pay_routh1 #pay_routh1                #路由的ID(类似mysql主键ID)，没有固定规则但要求唯一，建议配合服务名
          uri: <http://localhost:8001>                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/get/**              # 断言，路径相匹配的进行路由

        - id: pay_routh2 #pay_routh2                #路由的ID(类似mysql主键ID)，没有固定规则但要求唯一，建议配合服务名
          uri: <http://localhost:8001>                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/info/**              # 断言，路径相匹配的进行路由

在通用包中的FeignApi类上的@FeignClient中的服务名，使用GateWay对应的那个模块的服务名：

@FeignClient("cloud-gateway")
public interface PayFeignApi
{
    /**
     * GateWay进行网关测试案例01
     * @param id
     * @return
     */
    @GetMapping(value = "/pay/gateway/get/{id}")
    public ResultData getById(@PathVariable("id") Integer id);

    /**
     * GateWay进行网关测试案例02
     * @return
     */
    @GetMapping(value = "/pay/gateway/info")
    public ResultData<String> getGatewayInfo();
}

路由

按微服务名称动态路由服务URI

原来的URI是写死了端口的，如果有多个微服务，要按服务名来，要将uri写作 lb://服务名的方式。

spring:
  application:
    name: cloud-gateway #以微服务注册进consul或nacos服务列表内
  cloud:
    consul: #配置consul地址
      host: localhost
      port: 8500
      discovery:
        prefer-ip-address: true
        service-name: ${spring.application.name}
    gateway:
      routes:
        - id: pay_routh1 #pay_routh1                #路由的ID(类似mysql主键ID)，没有固定规则但要求唯一，建议配合服务名
          # uri: <http://localhost:8001>                #匹配后提供服务的路由地址
          uri: lb://cloud-payment-service            #按照服务名来匹配路由地址
          predicates:
            - Path=/pay/gateway/get/**              # 断言，路径相匹配的进行路由

断言

两种配置语法

Shortcut Configuration（简短的配置）
```
          predicates:
            - cookie=mycookie,mycookievalue
```
- 等于号左边是过滤项名称，比如路径、cookie等等，等号右边是条件相应的值，如果是kv信息，key和value用逗号隔开，左边是key，右边是value值。多个参数的信息也是各个参数之间使用逗号分隔。
- 以cookie为例，以上代码要cookie中有一个名为mycookie的key，以及这个key对应的value值为mycookievalue的时候，通过断言，判定为true。

Fully Expanded Arguments（全面的配置）

          predicates:
            - name: cookie
              args: 
                name: mycookie
                regexp: mycookievalue

过滤项名称写在name属性上，args属性又是一个新的集合用于配置过滤

一般用简短配置多些。

After Route配置（和Before）

例：

 	    	 predicates:
           - Path=/pay/gateway/get/**              # 断言，路径相匹配的进行路由
           - After=2023-11-20T17:38:13.586918800+08:00[Asia/Shanghai]

After的配置项的值是一个ZoneDateTime类型的时间信息。此配置表示只有当前时间在这个配置的时间值之后，才能断言为true，否则是false。

Before配置项同理，不过是当前时间要在配置的值的时间之前才能断言为true。

Between Route配置

时间信息同上，不过是开始时间和结束时间以：- Between=开始时间,结束时间的方式配置，用逗号分隔即可。

Cookie Route配置

Cookie Route Predicate 需要两个参数，一个是Cookie name，一个是正则表达式。路由规则会通过获取对应的Cookie name值和正则表达式去匹配，如果匹配上就会断言为true执行路由。

使用 - cookie=cookiename,正则表达式的方式。

      predicates:
        - cookie=mycookie,mycookievalue

Header Route配置

根据请求头的信息进行断言，参数也是两个，一个是属性名称，一个是正则表达式，这个属性值和正则表达式匹配，则断言为true。

          predicates:
            - Header=X-Request-Id, \\d+  # 请求头要有X-Request-Id属性并且值为整数的正则表达式

Host Route配置

通过主机地址进行断言，参数是一组匹配的域名列表，这个模板是一个ant分割的模板，使用.号作为分隔符。

          predicates:
            - Host=**.atguigu.com,**.ergou.com

Path Route配置

请求路径相匹配的断言为true进行路由。

          predicates:
            - Path=/pay/gateway/get/**              # 断言，路径相匹配的进行路由

Query Route配置

根据请求的param参数进行匹配，有对应属性以及属性值匹配对应的正则表达式的请求的断言通过进行路由。

          predicates:
            - Query=username, \\d+  # 要有参数名username并且值还要是整数才能路由

两个参数，一个是属性名，一个是属性值对应的正则表达式。

RemoteAddr Route配置

根据访问ip的限制来断言，符合ip的通过路由。具体写法参照：无类别域间路由（CIDR）。

      predicates:
        - RemoteAddr=192.168.124.1/24 # 外部访问我的IP限制，最大跨度不超过32，目前是1~24它们是 CIDR 表示法。

Method Route配置

通过请求方式来断言，符合请求方式的通过断言，多个请求方式用逗号隔开

     predicates:
       -Method=GET,POST

总之，Predicate断言就是为了实现一组匹配规则，让请求过来找到对应的Route进行处理。

自定义Predicate断言

步骤：

新建类名xxx需要以RoutePredicateFactory结尾，并继承AbstractRoutePredicateFactory类。、

@Component //此注解不可忘
public class MyRoutePredicateFactory extends AbstractRoutePredicateFactory<MyRoutePredicateFactory.Config>
{
    
}

重写apply方法

@Override
public Predicate<ServerWebExchange> apply(MyRoutePredicateFactory.Config config)
{
    return null;
}

新建apply所需要的静态内部类MyRoutePredicateFactory.Config，这个类就是我们路由断言规则。（重要）

@Validated
public static class Config{
    @Setter
    @Getter
    @NotEmpty
    private String userType; //钻、金、银等用户等级
}

空参构造方法，内部调用super。

public MyRoutePredicateFactory()
{
    super(MyRoutePredicateFactory.Config.class);
}

apply具体的重写

@Override
public Predicate<ServerWebExchange> apply(MyRoutePredicateFactory.Config config)
{
    return new Predicate<ServerWebExchange>()
    {
        @Override
        public boolean test(ServerWebExchange serverWebExchange)
        {
            //检查request的参数里面，userType是否为指定的值，符合配置就通过
            String userType = serverWebExchange.getRequest().getQueryParams().getFirst("userType");

            if (userType == null) return false;

            //如果说参数存在，就和config的数据进行比较
            if(userType.equals(config.getUserType())) {
                return true;
            }

            return false;
        }
    };
}

加上支持shortcut

@Override
public List<String> shortcutFieldOrder() {
  return Collections.singletonList("userType");
}

完整代码：

@Component
public class MyRoutePredicateFactory extends AbstractRoutePredicateFactory<MyRoutePredicateFactory.Config>
{
    public MyRoutePredicateFactory()
    {
        super(MyRoutePredicateFactory.Config.class);
    }

    @Validated
    public static class Config{
        @Setter
        @Getter
        @NotEmpty
        private String userType; //钻、金、银等用户等级
    }

		@Override
		public List<String> shortcutFieldOrder() {
		  return Collections.singletonList("userType");
		}
		
    @Override
    public Predicate<ServerWebExchange> apply(MyRoutePredicateFactory.Config config)
    {
        return new Predicate<ServerWebExchange>()
        {
            @Override
            public boolean test(ServerWebExchange serverWebExchange)
            {
                //检查request的参数里面，userType是否为指定的值，符合配置就通过
                String userType = serverWebExchange.getRequest().getQueryParams().getFirst("userType");

                if (userType == null) return false;

                //如果说参数存在，就和config的数据进行比较
                if(userType.equals(config.getUserType())) {
                    return true;
                }

                return false;
            }
        };
    }
}

过滤

GateWay内置过滤器

请求头相关组

以AddRequestHeader GatewayFilter为例

        route: 
          - id: pay_routh3 #pay_routh3
          uri: lb://cloud-payment-service                #匹配后提供服务的路由地址
          predicates:
            - Path=/pay/gateway/filter/**              # 断言，路径相匹配的进行路由
          filters:
            - AddRequestHeader=X-Request-atguigu1,atguiguValue1  # 请求头kv，若一头含有多参则重写一行设置
            - AddRequestHeader=X-Request-atguigu2,atguiguValue2

当断言为true通过路由，就会在请求上加上请求头。

RemoveRequestHeader也是同理，当断言通过，就删除指定请求头

- RemoveRequestHeader=sec-fetch-site      # 删除请求头sec-fetch-site

SetRequestHeader就是更新请求头的值，将指定的请求头的值更新为指定的值。

- SetRequestHeader=sec-fetch-mode, Blue-updatebyzzyy # 将请求头sec-fetch-mode对应的值修改为Blue-updatebyzzyy

请求参数相关组

这个组有两个配置项，使用方式基本同上。

   - AddRequestParameter=customerId,9527001 # 新增请求参数Parameter：k ，v
   - RemoveRequestParameter=customerName   # 删除url请求参数customerName，你传递过来也是null

响应头相关组

响应头相关组也是同请求头相关组一样，有着add、remove、set三种方式。

- AddResponseHeader=X-Response-atguigu, BlueResponse # 新增请求参数X-Response-atguigu并设值为BlueResponse
- SetResponseHeader=Date,2099-11-11 # 更新设置回应头Date值为2099-11-11
- RemoveResponseHeader=Content-Type # 将默认自带Content-Type回应属性删除

前缀和路径相关组

PrefixPath，就是在请求地址上添加前缀

- PrefixPath=/pay # <http://localhost:9527/pay/gateway/filter>

通过路由的请求，会加上前缀/pay

SetPath，就是将路径中的指定的部分修改

          predicates: 
            - Path=/XYZ/abc/{segment}           # 断言，为配合SetPath测试，{segment}的内容最后被SetPath取代
          filters:
            - SetPath=/pay/gateway/{segment}  # {segment}表示占位符，你写abc也行但要上下一致

要取出来使用的路径部分，使用{}占位符取出后使用，此时：

浏览器访问地址: http://localhost:9527/XYZ/abc/filter

实际微服务地址：http://localhost:9527/pay/gateway/filter

RedirectTo，就是重定向到某个地址

          predicates:
            - Path=/pay/gateway/filter/** # 真实地址
          filters:
            - RedirectTo=302, <http://www.atguigu.com/> # 访问http://localhost:9527/pay/gateway/filter跳转到http://www.atguigu.com/

DefaultFiters

当要配置全局过滤器的时候（当然通常建议不用全局），即使用的不是filters配置项，而是替换为default-filters配置项。

GateWay自定义过滤器

自定义全局过滤器

要实现自定义全局过滤器，要实现两个接口，并实现其方法：

例：

@Component //不要忘记
@Slf4j
public class MyGlobalFilter implements GlobalFilter, Ordered
{
    private static final String BEGIN_VISIT_TIME = "begin_visit_time";//开始访问时间
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
    {
        //先记录下访问接口的开始时间
        exchange.getAttributes().put(BEGIN_VISIT_TIME, System.currentTimeMillis());

        return chain.filter(exchange).then(Mono.fromRunnable(()->{
            Long beginVisitTime = exchange.getAttribute(BEGIN_VISIT_TIME);
            if (beginVisitTime != null){
                log.info("访问接口主机: " + exchange.getRequest().getURI().getHost());
                log.info("访问接口端口: " + exchange.getRequest().getURI().getPort());
                log.info("访问接口URL: " + exchange.getRequest().getURI().getPath());
                log.info("访问接口URL参数: " + exchange.getRequest().getURI().getRawQuery());
                log.info("访问接口时长: " + (System.currentTimeMillis() - beginVisitTime) + "ms");
                log.info("我是美丽分割线: ###################################################");
                System.out.println();
            }
        }));
    }

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

这样，只要是gateway管理的请求，即能匹配到路由并断言通过的请求，都会经过此过滤器。

自定义条件过滤器

新建的自定义条件过滤器的类名要以GatewayFilterFactory结尾，并继承AbstractGatewayFilterFactory类，也记得加上@Component注解
```
@Component  //此注解不可忘
public class MyGatewayFilterFactory extends AbstractGatewayFilterFactory<MyGatewayFilterFactory.Config>
{

}
```

新建一个Config内部类：

    public static class Config {
        @Setter @Getter
        private String status;//设定一个状态值/标志位，它等于多少，匹配之后才可以访问
    }

重写apply方法

@Override
    public GatewayFilter apply(MyGatewayFilterFactory.Config config)
    {
        return new GatewayFilter() {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                ServerHttpRequest request =  exchange.getRequest();
                System.out.println("进入自定义网关过滤器MyGatewayFilterFactory，status===="+config.getStatus());
                if(request.getQueryParams().containsKey("atguigu")) {
                    return chain.filter(exchange);
                }else {
                    exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
                    return exchange.getResponse().setComplete();
                }
            }
        };
    }

重写shortcutFieldOrder方法

@Override
public List<String> shortcutFieldOrder() {
    List<String> list = new ArrayList<String>();
    list.add("status");
    return list;
}

新建空参构造方法，内部调用super

public MyGatewayFilterFactory() {
    super(MyGatewayFilterFactory.Config.class);
}

完整代码：

@Component
public class MyGatewayFilterFactory extends AbstractGatewayFilterFactory<MyGatewayFilterFactory.Config>
{
    public MyGatewayFilterFactory()
    {
        super(MyGatewayFilterFactory.Config.class);
    }

    @Override
    public GatewayFilter apply(MyGatewayFilterFactory.Config config)
    {
        return new GatewayFilter()
        {
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
            {
                ServerHttpRequest request = exchange.getRequest();
                System.out.println("进入了自定义网关过滤器MyGatewayFilterFactory，status："+config.getStatus());
                if(request.getQueryParams().containsKey("atguigu")){
                    return chain.filter(exchange);
                }else{
                    exchange.getResponse().setStatusCode(HttpStatus.BAD_REQUEST);
                    return exchange.getResponse().setComplete();
                }
            }
        };
    }

    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("status");
    }

    public static class Config
    {
        @Getter@Setter
        private String status;//设定一个状态值/标志位，它等于多少，匹配和才可以访问
    }
}

yaml文件中使用：
- 即将自己自定义类名中的GatewayFilterFactory之前的部分当作过滤配置项的名字，比如上面的例子就叫My
```
filters:
  - My=……
```

秒客网

SpringCloud的学习（四）Micrometer、GateWay

Micrometer

分布式链路追踪

分布式链路追踪原理

Zipkin

使用步骤

GateWay网关

使用步骤

路由

按微服务名称动态路由服务URI

断言

两种配置语法

After Route配置（和Before）

Between Route配置

Cookie Route配置

Header Route配置

Host Route配置

Path Route配置

Query Route配置

RemoteAddr Route配置

Method Route配置

自定义Predicate断言

过滤

GateWay内置过滤器

GateWay自定义过滤器

相关文章