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

經過上一篇《使用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 Cloud Alibaba基礎教程》連載目錄

專題推薦

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