Spring Cloud Alibaba基础教程：Sentinel使用Apollo存储规则

时间 2019-11-24

标签 spring cloud alibaba 基础教程 sentinel 使用 apollo 存储规则栏目 Spring 繁體版

原文原文链接

上一篇咱们介绍了如何经过Nacos的配置功能来存储限流规则。Apollo是国内用户很是多的配置中心，因此，今天咱们继续说说Spring Cloud Alibaba Sentinel中如何将流控规则存储在Apollo中。java

使用Apollo存储限流规则

Sentinel自身就支持了多种不一样的数据源来持久化规则配置，目前包括如下几种方式：git

文件配置
Nacos配置
ZooKeeper配置
Apollo配置

本文咱们就来一块儿动手尝试一下，如何使用Apollo来存储限流规则。github

准备工做

下面咱们将同时使用到Apollo和Sentinel Dashboard，因此能够先把Apollo和Sentinel Dashboard启动起来。web

若是还没入门Sentinel Dashboard能够经过文末的系列目录先学习以前的内容。Apollo的话相对复杂一些，这里不作详细介绍了，若是尚未接触过Apollo的读者能够查看其官方文档进一步学习。spring

应用配置

第一步：在Spring Cloud应用的pom.xml中引入Spring Cloud Alibaba的Sentinel模块和Apollo存储扩展：json

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba.csp</groupId>
        <artifactId>sentinel-datasource-apollo</artifactId>
        <version>1.4.0</version>
    </dependency>
</dependencies>
复制代码

第二步：在Spring Cloud应用中配置的服务信息，在resource目录下，建立apollo-env.properties文件，内容样例：数组

local.meta=http://192.168.0.201:8080
dev.meta=http://192.168.0.202:8080
复制代码

这里须要了解Apollo对多环境的配置，这里设置的是每一个环境不一样的配置服务地址，读者须要根据本身的实际状况修改。bash

第三步：在Spring Cloud应用中添加配置信息：并发

spring.application.name=sentinel-datasource-apollo
server.port=8002

# apollo config
app.id=${spring.application.name}

# sentinel dashboard
spring.cloud.sentinel.transport.dashboard=localhost:8080

# sentinel datasource apollo
spring.cloud.sentinel.datasource.ds.apollo.namespaceName=application
spring.cloud.sentinel.datasource.ds.apollo.flowRulesKey=sentinel.flowRules
复制代码

app.id：Apollo中的建立的项目名称，这里采用spring.application.name参数的引用，从而达到服务名与配置项目名一致的效果
spring.cloud.sentinel.transport.dashboard：sentinel dashboard的访问地址，根据上面准备工做中启动的实例配置
spring.cloud.sentinel.datasource.ds.apollo.namespaceName：Apollo的空间名
spring.cloud.sentinel.datasource.ds.apollo.flowRulesKey：配置规则的key名称

关于Apollo相关配置的对应关系可见下图所示：app

第四步：建立应用主类，并提供一个rest接口，好比：

@EnableApolloConfig
@SpringBootApplication
public class TestApplication {

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

    @Slf4j
    @RestController
    static class TestController {

        @GetMapping("/hello")
        public String hello() {
            return "didispace.com";
        }

    }

}
复制代码

其中@EnableApolloConfig注解是开启Apollo的配置加载功能。

第五步：Apollo中配置限流规则，具体可见第三步的截图中的样子。其中，key值的内容是下面的json

[
    {
        "resource": "/hello",
        "limitApp": "default",
        "grade": 1,
        "count": 5,
        "strategy": 0,
        "controlBehavior": 0,
        "clusterMode": false
    }
]
复制代码

能够看到上面配置规则是一个数组类型，数组中的每一个对象是针对每个保护资源的配置对象，每一个对象中的属性解释以下：

resource：资源名，即限流规则的做用对象
limitApp：流控针对的调用来源，若为 default 则不区分调用来源
grade：限流阈值类型（QPS 或并发线程数）；0表明根据并发数量来限流，1表明根据QPS来进行流量控制
count：限流阈值
strategy：调用关系限流策略
controlBehavior：流量控制效果（直接拒绝、Warm Up、匀速排队）
clusterMode：是否为集群模式

这里咱们只作简单的配置解释，以便于理解这里的配置做用。实际上这里还有很是多可配置选项和规则，更复杂的配置后面咱们单独开一篇来深刻学习。

第六步：启动应用。若是一些顺利，能够看到相似下面的日志，表明已经成功从Nacos加载了一条限流规则：

2019-04-18 23:56:11.278  INFO 29149 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-apollo-datasource start to loadConfig
2019-04-18 23:56:11.279  INFO 29149 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-apollo-datasource load 1 FlowRule
复制代码

经过postman或者curl访问几下localhost:8002/hello接口：

$ curl localhost:8002/hello
didispace.com
复制代码

此时，在Sentinel Dashboard中就能够看到当前咱们启动的sentinel-datasource-apollo服务。点击左侧菜单中的流控规则，能够看到已经存在一条记录了，这条记录就是上面咱们在Apollo中配置的限流规则。

深刻思考

在使用Apollo存储规则配置的时候与Nacos存储同样，对于Sentinel控制台这些数据是只读的，也就是说：

Sentinel控制台中修改规则：仅存在于服务的内存中，不会修改Apollo中的配置值，重启后恢复原来的值。
Nacos控制台中修改规则：服务的内存中规则会更新，Apollo中持久化规则也会更新，重启后依然保持。

代码示例

本文介绍内容的客户端代码，示例读者能够经过查看下面仓库中的alibaba-sentinel-datasource-apollo项目：

Github：github.com/dyc87112/Sp…
Gitee：gitee.com/didispace/S…

若是您对这些感兴趣，欢迎star、follow、收藏、转发给予支持！

参考资料

下面是Sentinel的仓库地址与官方文档，读者也能够本身查阅文档学习：