Spring Cloud Alibaba 笔记

szc1767

已于 2024-09-26 09:26:33 修改

阅读量1.4k

点赞数 24

分类专栏： # springcloud 文章标签：笔记

于 2023-12-21 17:08:54 首次发布

本文链接：https://blog.youkuaiyun.com/szchen2/article/details/134059981

版权

springcloud 专栏收录该内容

5 篇文章

订阅专栏

编写全局过滤器（GlobalFilter）

过滤器执行顺序：

集成Ordered，重写getOrder：

一、相关组件与技术

1、服务治理 nacos

2、服务网管 gateway

3、服务容错 sentinel

4、服务间调用 openFegin

5、分布式事务 Seata

6、消息驱动 Rocketmq

7、链路追踪 Sleuth

各组件使用：一文读懂网关概念+Nginx正反向代理+负载均衡+Spring Cloud Gateway（多栗子）_nginx 网关_赵四司机的博客-优快云博客

注：版本关系：

版本说明 · alibaba/spring-cloud-alibaba Wiki · GitHub

二、服务治理 nacos

快速开始

官网地址：Nacos 快速开始

注：默认使用spring-boot 和spring-cloud

持久化配置：

nacos 默认使用嵌入式数据库实现数据的存储，我们将其改为外置数据库，目前只支持mysql

1、初始化mysql数据库，数据库初始化文件：mysql-schema.sql

2、修改conf/application.properties文件，增加支持mysql数据源配置（目前只支持mysql），添加mysql数据源的url、用户名和密码

spring.datasource.platform=mysql

db.num=1
db.url.0=jdbc:mysql://11.162.196.16:3306/nacos_devtest?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true
db.user=nacos_devtest
db.password=youdontknow

集群配置：

官网配置

准备

1、注意：nacos 配置需要配置到 bootstrap.yml 或 bootstrap.properties 文件中，而不能是application.yml/properties 文件。

在 SpringBoot 启动时对自定义配置文件有如下加载顺序：

1、bootstrap.yml（或bootstrap.properties）优先加载。这个文件用于应用程序的引导阶段，通常包含系统级别的一些参数配置，这些参数一般是不变的。
2、bootstrap.yml（或bootstrap.properties）由父Spring ApplicationContext加载，而父ApplicationContext被加载到使用application.yml（或application.properties）的之前。
3、application.yml（或application.properties）随后加载。这个文件通常用来定义单个应用级别的配置，如果搭配Spring Cloud Config使用，可以定义动态替换的文件。
4、application.yml（或application.properties）由当前的Spring ApplicationContext加载。

需要注意的是，一旦bootstrap.yml被加载，其内容不会被覆盖，即便后期加载的application.yml 的内容标签与bootstrap.yml的标签一致，application.yml也不会覆盖bootstrap.yml。而application.yml里面的内容可以动态替换。

综上所述，加载顺序为：bootstrap.yml（或bootstrap.properties）优先加载，然后是bootstrap.yml（或bootstrap.properties），接着是application.yml（或application.properties），最后是application.yml（或application.properties）。这样的加载顺序允许基础设施配置先于应用程序配置加载，并且允许后面加载的配置覆盖先前加载的配置。

2、SpringBoot 2.4.x及以上版本需要引入spring-cloud-starter-bootstrap依赖来支持bootstrap.yml或bootstrap.properties配置文件

    <!-- 支持 bootstrap.properties 或 bootstrap.yml 配置文件 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-bootstrap</artifactId>
    </dependency>

服务注册：

1、添加依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>${latest.version}</version>
</dependency>
<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2、设置配置

bootstrap.yml (spring cloud 会自动导入)

spring:
  application:
    name: shop-user
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #Nacos服务注册中心地址

3、添加启动类；在启动类上添加 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能：

@SpringBootApplication
@EnableDiscoveryClient
public class NacosProviderApplication {

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

4、调用的负载均衡

给 RestTemplate 实例添加 @LoadBalanced 注解，开启 @LoadBalanced 与 Ribbon 的集成：


@Configuration
public class RestTemplate {

    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
   
}

配置管理：

1、添加依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>${latest.version}</version>
</dependency>
<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2、添加配置

application.yml 中添加（可选，推荐添加）

spring:
  profiles:
    active: dev # 表示开发环境

bootstrap.yml (spring cloud 会自动导入)

spring:
  application:
    name: shop-user
  cloud:
    nacos:
      config:
        server-addr: localhost:8848 #Nacos作为配置中心地址
        file-extension: yaml #指定yaml格式的配置（可选）
        group: DEV_GROUP   # 配置分组（可选）
        namespace: e3fa1786299137a3766401539acc6bf4  # 配置命名空间（可选）

3、在nacos上添加配置文件

nacos 中Data Id 规则

${prefix}-${spring.profiles.active}.${file-extension}

注1 ： prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置

注2 ：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 ${prefix}.${file-extension}

注3 ： file-exetension 为配置内容的数据格式，可以通过配置项spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

4、通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${useLocalCache:false}")
    private boolean useLocalCache;

    @RequestMapping("/get")
    public boolean get() {
        return useLocalCache;
    }
}

三、服务网管 gateway

官网文档：Spring Cloud Gateway

工作原理：

基础配置：

1、依赖

<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-loadbalancer</artifactId>
</dependency>

2、配置文件

spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.178.129:8848
    gateway:
      routes:
        - id: shop-user
          uri: lb://shop-user    # nacos 中注册的服务名
          predicates:
            - Path=/config/test

        - id: shop-user2
          uri: lb://shop-user2
          predicates:
            - Path=/config/test2

过滤器：

参考：【精选】Spring Cloud Gateway自定义过滤器_springcloud gateway自定义过滤器-优快云博客

自定义GatewayFilter 工厂：

1、前置过滤

@Component
public class PreGatewayFilterFactory extends AbstractGatewayFilterFactory<PreGatewayFilterFactory.Config> {

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

    @Override
    public GatewayFilter apply(Config config) {
        // 从配置对象中获取配置
        return (exchange, chain) -> {
            //如果你想构建一个“预”过滤器，你需要操作请求之前调用chain.filter
            ServerHttpRequest.Builder builder = exchange.getRequest().mutate();
            //使用生成器操作请求
            return chain.filter(exchange.mutate().request(builder.build()).build());
        };
    }

    @Data
    public static class Config {
        //将过滤器的配置属性放在这里
    }

}

2、后置过滤

@Component
public class PostGatewayFilterFactory extends AbstractGatewayFilterFactory<PostGatewayFilterFactory.Config> {

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

    @Override
    public GatewayFilter apply(Config config) {
        // 从配置对象中获取配置
        return (exchange, chain) -> {
            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                ServerHttpResponse response = exchange.getResponse();
                //以某种方式操纵反应
            }));
        };
    }

    @Data
    public static class Config {
        //将过滤器的配置属性放在这里
    }

}

3 注意：

自定义筛选器类名应以 GatewayFilterFactory 结尾

配置文件中应该的配置

spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
       - id: baidu
         uri: https://www.baidu.com
         predicates:
           - Path=/baidu/**
         filters:
           - name: GatewayFilterFactory前的name，如：PostGatewayFilterFactory的Post
             args:
               message: My Custom Message
               preLogger: true
               postLogger: true

另一种写法

spring:
  application:
    name: gateway
  cloud:
    gateway:
      routes:
       - id: baidu
         uri: https://www.baidu.com
         predicates:
           - Path=/baidu/**
         filters:
            - Post = My Custom Message, true, true

不过这种写法读取需要重写shortcutFieldOrder方法，该方法返回一个List列表，列表中指定参数使用的顺序和数量：

@Override
public List<String> shortcutFieldOrder() {
  return Arrays.asList("message", "preLogger", "postLogger");
}

编写全局过滤器（GlobalFilter）

@Component
@Slf4j
public class CustomGlobalFilter implements GlobalFilter, Ordered {
    // 前置过滤器
    @Bean
    public GlobalFilter customGlobalFilter() {
        return (exchange, chain) -> exchange.getPrincipal()
                .map(Principal::getName)
                .defaultIfEmpty("Default User")
                .map(userName -> {
                    //将标头添加到代理请求
                    exchange.getRequest().mutate().header("CUSTOM-REQUEST-HEADER", userName).build();
                    return exchange;
                })
                .flatMap(chain::filter);
    }

    //  后置过滤器
    @Bean
    public GlobalFilter customGlobalPostFilter() {
        return (exchange, chain) -> chain.filter(exchange)
                .then(Mono.just(exchange))
                .map(serverWebExchange -> {
                    //向响应添加标头
                    serverWebExchange.getResponse().getHeaders().set("CUSTOM-RESPONSE-HEADER",
                            HttpStatus.OK.equals(serverWebExchange.getResponse().getStatusCode()) ? "It worked": "It did not work");
                    return serverWebExchange;
                })
                .then();
    }
}

过滤器执行顺序：

集成Ordered，重写getOrder：

//  前置
@Component
@Slf4j
public class CustomGlobalFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        log.info("custom global filter");
        return chain.filter(exchange);
    }

    @Override
    public int getOrder() {
        return -1;
    }
}


// 后置
@Component
@Slf4j
public class PostGlobalCustomFilter implements GlobalFilter, Ordered {

    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        return chain.filter(exchange)
                .then(Mono.fromRunnable(
                        () -> log.info("Global Post Filter Execute...")
                ));
    }

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

修改重写的apply方法：

修改重写的apply方法，放回 new 一个OrderedGatewayFilter，在构造方法中的第二个参数中设置执行顺序

@Override
public GatewayFilter apply(Config config) {
    return new OrderedGatewayFilter(new GatewayFilter() {
        @Override
        public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
            if (config.isPreLogger()) {
                log.info("CustomGatewayFilterFactory pre message is {}", config.getMessage());
            }

            return chain.filter(exchange).then(Mono.fromRunnable(() -> {
                if (config.isPostLogger()) {
                    log.info("CustomGatewayFilterFactory post message is {}", config.getMessage());
                }
            }));
        }
    }, -1);
}

注：

这边执行的逻辑是order的值越小，前置过滤器越先执行，后置过滤器越后执行。

四、服务容错 sentinel

官网：Sentinel中文文档

github：GitHub - alibaba/Sentinel

Spring-Cloud-Alibaba适配（推荐）： Sentinel · alibaba/spring-cloud-alibaba Wiki

基本配置

1、依赖

<dependency>
      <groupId>com.alibaba.cloud</groupId>
      <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
 </dependency>

2、配置文件

spring:
  cloud:
    sentinel:
      transport:
        dashboard: 192.168.180.137:8080   #sentinel控制台的请求地址
        port: 8719     # 默认为8719，如果修改了可以使用此配置

动态数据源支持

1、nacos配置

1、依赖

<dependency>
   <groupId>com.alibaba.csp</groupId>
   <artifactId>sentinel-datasource-nacos</artifactId>
</dependency>

2、添加配置

spring:
  cloud:
    sentinel:
      datasource:
        ds2:
          nacos:
            server-addr: localhost:8848
            data-id: sentinel
            group-id: DEFAULT_GROUP
            data-type: json
            rule-type: flow
            username: nacos  #非必填
            password: nacos  #非必填

3、注册到nacos的JSON格式

Sentinel 持久化数据到Nacos中配置json及SpringCloud代码集成