启动配置管理

启动了 Nacos server 后,您就可以参考以下示例代码,为您的 Spring Cloud 应用启动 Nacos 配置管理服务了。完整示例代码请参考:nacos-spring-cloud-config-example

  1. 添加依赖:

    1. <dependency>
    2. <groupId>com.alibaba.cloud</groupId>
    3. <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId> <version>${latest.version}</version>
    4. </dependency>

    注意:版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本,版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。
    更多版本对应关系参考:版本说明 Wiki

  2. 在 bootstrap.properties 中配置 Nacos server 的地址和应用名

    1. spring.cloud.nacos.config.server-addr=127.0.0.1:8848
    2. spring.application.name=example

    说明:之所以需要配置 spring.application.name ,是因为它是构成 Nacos 配置管理 dataId字段的一部分。
    在 Nacos Spring Cloud 中,dataId 的完整格式如下:
    ${prefix}-${spring.profiles.active}.${file-extension}

  • prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
  • spring.profiles.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档注意:当 spring.profiles.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成 ${prefix}.${file-extension}
  • file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。
  1. 通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新:

    1. @RestController
    2. @RequestMapping("/config")
    3. @RefreshScope
    4. public class ConfigController {
    5. @Value("${useLocalCache:false}")
    6. private boolean useLocalCache;
    7. @RequestMapping("/get")
    8. public boolean get() {
    9. return useLocalCache;
    10. }
    11. }
  2. 首先通过调用 Nacos Open API 向 Nacos Server 发布配置:dataId 为example.properties,内容为

    1. useLocalCache=true
    1. curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=true"
  1. 运行 NacosConfigApplication,调用 curl http://localhost:8080/config/get,返回内容是 true。
  2. 再次调用 Nacos Open API 向 Nacos server 发布配置:dataId 为example.properties,内容为
    1. useLocalCache=false
    1. curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example.properties&group=DEFAULT_GROUP&content=useLocalCache=false"
    再次访问 http://localhost:8080/config/get,此时返回内容为false,说明程序中的useLocalCache值已经被动态更新了。