聊聊SpringBoot整合Nacos自動(dòng)刷新配置的問(wèn)題

更新時(shí)間：2022年01月28日 14:30:37 作者：Naylor

Nacos作為SpringBoot服務(wù)的注冊(cè)中心和配置中心,本例將在配置文件中配置一個(gè)?cml.age=100?的配置項(xiàng)，程序中編寫一個(gè)方法讀取配置文件，并通過(guò)?Get--->/test/age?接口提供給瀏覽器訪問(wèn),感興趣的朋友跟隨小編一起看看吧

目的

Nacos作為SpringBoot服務(wù)的注冊(cè)中心和配置中心。

在NacosServer中修改配置文件，在SpringBoot不重啟的情況下，獲取到修改的內(nèi)容。

本例將在配置文件中配置一個(gè) cml.age=100 的配置項(xiàng)，程序中編寫一個(gè)方法讀取配置文件，并通過(guò) Get--->/test/age 接口提供給瀏覽器訪問(wèn)。

若配置文件中的 age 修改為 200 ，不用重新啟動(dòng)程序，直接訪問(wèn) /test/age 接口，將獲取到最新的值 200
若配置文件中沒(méi)有age 的配置項(xiàng)，或干脆沒(méi)有 cml 的配置項(xiàng)，訪問(wèn) /test/age 接口將返回默認(rèn)的值 18

環(huán)境

SpringCloud：2020.0.3
SpringCloudAlibaba：2021.1
SpringBoot：2.5.2

pom

pom中引入 nacos 相關(guān)配置：discovery，config，bootstrap

網(wǎng)上有人說(shuō)，需要引入 actuator ，其實(shí)不用。本例中還集成了 spring-cloud-starter-oauth2 ，根本沒(méi)有 SpringSecurity 攔截的問(wèn)題

問(wèn)題：NacosServer和NacosClient是如何通訊的？如果是http接口方式來(lái)回調(diào)用，為什么沒(méi)有被SpringSecurity攔截？是否是rpc？

 <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring.cloud.dependencies}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring.cloud.alibaba.dependencies}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <!-- nacos-discovery -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
           <!--nacos config -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
         <!--bootstrap-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
    </dependencies>

配置文件

bootstrap.yml

server:
  port: 9556
spring:
  application:
    name: app
  profiles:
    active: test
    nacos:
      discovery:
        username: nacos
        password: nacos
        server-addr: 192.168.1.61:8848
      config:
        server-addr: 192.168.1.61:8848
        file-extension: yaml

app-dev.yml

此配置指 NacosServer 中的配置文件 app-dev.yml ，僅截取 cml.age 部分

cml:
   age: 100

代碼

RefreshScope注解：必須加在 controller 上面，加在主啟動(dòng)內(nèi)上面不好使。哪些資源需要自動(dòng)刷新配置就在該controller上面添加此注解，可封裝一個(gè) BaseController 。
@Value("${cml.age:18}")：讀取配置文件中的 cml.age 配置項(xiàng)值，賦給變量 age ，默認(rèn)值為 18
getAge：獲取年齡接口
/test/age接口需要添加到 Security.permitAll

問(wèn)題：RefreshScope注解為什么一定要添加在 controller 上面？為什么在主啟動(dòng)類上面添加不生效

@RefreshScope
     @Api(tags = "測(cè)試 - api")
     @Slf4j
     @RestController
     @RequestMapping("/test")
     public class TestController {
     
         /**
          * 獲取配置文件中的 cml.age 內(nèi)容，若未獲取到，默認(rèn)值為18
          */
         @Value("${cml.age:18}")
         private String age;
         @ApiOperation(value = "獲取年齡 - 測(cè)試配置自動(dòng)刷新", notes = "獲取年齡 - 測(cè)試配置自動(dòng)刷新")
         @GetMapping("/age")
         public String getAge() {
             return age;
         }
     }

日志

開(kāi)啟 nacos-refresh 日志，打印配置內(nèi)容更新情況

logging:
  level:
     com.alibaba.cloud.nacos.refresh: debug

打印的日志：

2022-01-28 13:43:30.574 [com.alibaba.nacos.client.Worker.longPolling.fixed-192.168.1.61_8848-zjrkm-admin] DEBUG com.alibaba.cloud.nacos.refresh.NacosContextRefresher.innerReceive:136 - Refresh Nacos config group=DEFAULT_GROUP,dataId=identityQrCodeAdmin-service-cml-test.yaml,configInfo=spring:
application:
name: