通過上一篇《使用Sentinel實現接口限流》的介紹，相信大家對Sentinel已經有了初步的認識。在Spring Cloud Alibaba的整合封裝之下，接口限流這件事情可以非常輕易的整合到我們的Spring Cloud應用中。但是，通過上篇的整合，依然還不能完美的滿足我們日常的生產需求。其中，非常重要的一點就是限流規則的持久化問題。不少細心的讀者也在留言中提出了Dashboard中設置的限流規則在應用重啟之後就丟失了的問題。那麽，接下來我們就來說說Sentinel的規則持久化如何實現。

使用Nacos存儲限流規則

Sentinel自身就支持了多種不同的數據源來持久化規則配置，目前包括以下幾種方式：

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

本文我們就來一起動手嘗試一下，使用Spring Cloud Alibaba的中整合的配置中心Nacos存儲限流規則。

準備工作

下面我們將同時使用到Nacos和Sentinel Dashboard，所以可以先把Nacos和Sentinel Dashboard啟動起來。

默認配置下啟動後，它們的訪問地址（後續會用到）為：

• Nacos：http://localhost:8848/
• Sentinel Dashboard：http://localhost:8080/

如果還沒入門Nacos和Sentinel Dashboard可以通過文末的系列目錄先學習之前的內容。

應用配置

第一步：在Spring Cloud應用的pom.xml中引入Spring Cloud Alibaba的Sentinel模塊和Nacos存儲擴展：

 <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-nacos</artifactId>
        <version>1.4.0</version>
    </dependency>
</dependencies>
 

第二步：在Spring Cloud應用中添加配置信息：

spring.application.name=alibaba-sentinel-datasource-nacos
server.port=8003

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

# sentinel datasource nacos ：http://blog.didispace.com/spring-cloud-alibaba-sentinel-2-1/
spring.cloud.sentinel.datasource.ds.nacos.server-addr=localhost:8848
spring.cloud.sentinel.datasource.ds.nacos.dataId=${spring.application.name}-sentinel
spring.cloud.sentinel.datasource.ds.nacos.groupId=DEFAULT_GROUP

• spring.cloud.sentinel.transport.dashboard：sentinel dashboard的訪問地址，根據上面準備工作中啟動的實例配置
• spring.cloud.sentinel.datasource.ds.nacos.server-addr：nacos的訪問地址，，根據上面準備工作中啟動的實例配置
• spring.cloud.sentinel.datasource.ds.nacos.groupId：nacos中存儲規則的groupId
• spring.cloud.sentinel.datasource.ds.nacos.dataId：nacos中存儲規則的dataId

這裏對於dataId使用了${spring.application.name}變量，這樣可以根據應用名來區分不同的規則配置。

註意：Spring Cloud Alibaba的Sentinel整合文檔中有一些小問題，比如：並沒有spring.cloud.sentinel.datasource.ds2.nacos.rule-type這個參數。可能是由於版本叠代更新，文檔失修的緣故。讀者在使用的時候，可以通過查看org.springframework.cloud.alibaba.sentinel.datasource.config.DataSourcePropertiesConfiguration和org.springframework.cloud.alibaba.sentinel.datasource.config.NacosDataSourceProperties兩個類來分析具體的配置內容，會更為準確。

比如，Nacos存儲的具體配置類源碼如下：

public class NacosDataSourceProperties extends AbstractDataSourceProperties {

    private String serverAddr;
    private String groupId;
    private String dataId;

    // commercialized usage

    private String endpoint;
    private String namespace;
    private String accessKey;
    private String secretKey;

}

上面我們使用了前三個屬性，後四個屬性是阿裏雲的商業化產品使用的，這裏就不具體介紹了，有使用阿裏雲商業產品的童鞋可以了解一下。

第三步：創建應用主類，並提供一個rest接口，比如：

@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";
        }

    }

}

第四步：Nacos中創建限流規則的配置，比如：

其中：Data ID、Group就是上面第二步中配置的內容。配置格式選擇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-16 14:24:42.919  INFO 89484 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-nacos-datasource start to loadConfig
2019-04-16 14:24:42.938  INFO 89484 --- [           main] o.s.c.a.s.c.SentinelDataSourceHandler    : [Sentinel Starter] DataSource ds-sentinel-nacos-datasource load 1 FlowRule

通過postman或者curl訪問幾下localhost:8003/hello接口：

$ curl localhost:8003/hello
didispace.com

此時，在Sentinel Dashboard中就可以看到當前我們啟動的alibaba-sentinel-datasource-nacos服務。點擊左側菜單中的流控規則，可以看到已經存在一條記錄了，具體如下：

這條記錄就是上面我們在Nacos中配置的限流規則。

深入思考

在完成了上面的整合之後，對於接口流控規則的修改就存在兩個地方了：Sentinel控制臺、Nacos控制臺。

這個時候，需要註意當前版本的Sentinel控制臺不具備同步修改Nacos配置的能力，而Nacos由於可以通過在客戶端中使用Listener來實現自動更新。所以，在整合了Nacos做規則存儲之後，需要知道在下面兩個地方修改存在不同的效果：

• Sentinel控制臺中修改規則：僅存在於服務的內存中，不會修改Nacos中的配置值，重啟後恢復原來的值。
• Nacos控制臺中修改規則：服務的內存中規則會更新，Nacos中持久化規則也會更新，重啟後依然保持。

代碼示例

本文介紹內容的客戶端代碼，示例讀者可以通過查看下面倉庫中的alibaba-sentinel-datasource-nacos項目：

• Github：https://github.com/dyc87112/SpringCloud-Learning/
• Gitee：https://gitee.com/didispace/SpringCloud-Learning/

如果您對這些感興趣，歡迎star、follow、收藏、轉發給予支持！

參考資料

下面是Sentinel的倉庫地址與官方文檔，讀者也可以自己查閱文檔學習：

• Github
• Sentinel官方文檔：動態規則
• Spring Cloud Alibaba Sentinel文檔

專題推薦

• Spring Boot基礎教程
• Spring Cloud基礎教程

Spring Cloud Alibaba基礎教程：Sentinel使用Nacos存儲規則