Spring Cloud Alibaba 整合Nacos Config

时间  2020-05-29 标签 spring cloud alibaba 整合 nacos config

前言

前面咱们学习了如何在Spring Boot中使用Nacos来管理配置，总体来讲仍是比较简单。web

为了可以在Spring Cloud中更加方便的使用Nacos，今天介绍下在Spring Cloud中如何简单，快速，方便的使用Nacos。spring

使用

须要在项目中加入spring-cloud-starter-alibaba-nacos-config的Maven依赖。bootstrap

  
     
 
   
  1. <dependencyManagement>缓存
    2.  
 
   
  2.  <dependencies>app
    3.  
 
   
  3.  <dependency>ide
    4.  
 
   
  4.  <groupId>org.springframework.cloud</groupId>spring-boot
    5.  
 
   
  5.  <artifactId>spring-cloud-dependencies</artifactId>学习
    6.  
 
   
  6.  <version>Greenwich.SR2</version>测试
    7.  
 
   
  7.  <type>pom</type>ui
    8.  
 
   
  8.  <scope>import</scope>
    9.  
 
   
  9.  </dependency>
    10.  
 
   
  10.  <dependency>
    11.  
 
   
  11.  <groupId>org.springframework.boot</groupId>
    12.  
 
   
  12.  <artifactId>spring-boot-starter-parent</artifactId>
    13.  
 
   
  13.  <version>2.1.6.RELEASE</version>
    14.  
 
   
  14.  <type>pom</type>
    15.  
 
   
  15.  <scope>import</scope>
    16.  
 
   
  16.  </dependency>
    17.  
 
   
  17.  </dependencies>
    18.  
 
   
  18. </dependencyManagement>
    19.  
 
   
  19. <dependencies>
    20.  
 
   
  20.  <dependency>
    21.  
 
   
  21.  <groupId>org.springframework.boot</groupId>
    22.  
 
   
  22.  <artifactId>spring-boot-starter-web</artifactId>
    23.  
 
   
  23.  </dependency>
    24.  
 
   
  24.  <dependency>
    25.  
 
   
  25.  <groupId>org.springframework.cloud</groupId>
    26.  
 
   
  26.  <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    27.  
 
   
  27.  <version>0.9.0.RELEASE</version>
    28.  
 
   
  28.  </dependency>
    29.  
 
   
  29. </dependencies>
    30.  

  
<dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Greenwich.SR2</version> <type>pom</type> <scope>import</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.6.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies></dependencyManagement><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-nacos-config</artifactId> <version>0.9.0.RELEASE</version> </dependency></dependencies>

版本选择请参考下面的规范：

因为 Spring Boot 1 和 Spring Boot 2 在 Actuator 模块的接口和注解有很大的变动，且 spring-cloud-commons 从 1.x.x 版本升级到 2.0.0 版本也有较大的变动，所以咱们采起跟 SpringBoot 版本号一致的版本:

1.5.x 版本适用于 Spring Boot 1.5.x 2.0.x 版本适用于 Spring Boot 2.0.x 2.1.x 版本适用于 Spring Boot 2.1.x

在bootstrap.properties中配置Nacos的信息，切记是bootstrap.properties不是application.properties，缘由你能够本身体验下。

  
     
 
   
  1. # 应用名称，用于配置文件命名
    2.  
 
   
  2. spring.application.name=example
    3.  
 
   
  3. # Nacos server 的地址
    4.  
 
   
  4. spring.cloud.nacos.config.server-addr=127.0.0.1:8848
    5.  
 
   
  5. # 配置内容的数据格式
    6.  
 
   
  6. spring.cloud.nacos.config.file-extension=properties
    7.  
 
   
  7. # 指定对应的环境
    8.  
 
   
  8. spring.profiles.active=test
    9.  

  
# 应用名称，用于配置文件命名spring.application.name=example# Nacos server 的地址spring.cloud.nacos.config.server-addr=127.0.0.1:8848# 配置内容的数据格式spring.cloud.nacos.config.file-extension=properties# 指定对应的环境spring.profiles.active=test

在 Nacos Spring Cloud 中，dataId 的完整格式以下：

  
     
 
   
  1. ${prefix}-${spring.profile.active}.${file-extension}
    2.  

  
${prefix}-${spring.profile.active}.${file-extension}

prefix 默认为 spring.application.name 的值，也能够经过配置项 spring.cloud.nacos.config.prefix来配置。

而后咱们在Nacos的后台建立一个配置，dataId为example-test.properties

  
     
 
   
  1. useLocalCache=false
    2.  

  
useLocalCache=false

再建立一个example-dev.properties

  
     
 
   
  1. useLocalCache=true
    2.  

  
useLocalCache=true

测试代码：

  
     
 
   
  1. @RestController
    2.  
 
   
  2. @RequestMapping("/config")
    3.  
 
   
  3. @RefreshScope
    4.  
 
   
  4. public class ConfigController {
    5.  
 
   
  5.  
 
   
  6.  @Value("${useLocalCache:false}")
    7.  
 
   
  7.  private boolean useLocalCache;
    8.  
 
   
  8.  
 
   
  9.  @RequestMapping("/get")
    10.  
 
   
  10.  public boolean get() {
    11.  
 
   
  11.  return useLocalCache;
    12.  
 
   
  12.  }
    13.  
 
   
  13.  
 
   
  14. }
    15.  

  
@RestController@RequestMapping("/config")@RefreshScopepublic class ConfigController { @Value("${useLocalCache:false}") private boolean useLocalCache; @RequestMapping("/get") public boolean get() { return useLocalCache; }}

配置变动须要刷新的话记得加上@RefreshScope注解。加载对应环境的配置是根据spring.profiles.active=test的值进行加载，当咱们指定test后，useLocalCache的值为false, 当spring.profiles.active=dev时，useLocalCache的值为true

方便的点在于不用启动时指定namespace来区分环境，而是跟Spring Boot中的spring.profiles.active进行了整合。这样的方式仍是只有默认的namespace，只不过是经过data-id的命名规则来区分环境。

多Data-Id的使用

若是咱们须要加载多个配置文件，能够用ext-config来配置

  
     
 
   
  1. spring.cloud.nacos.config.ext-config[0].data-id=app.properties
    2.  
 
   
  2. spring.cloud.nacos.config.ext-config[0].group=multi-data-ids
    3.  
 
   
  3. spring.cloud.nacos.config.ext-config[0].refresh=true
    4.  
 
   
  4.  
 
   
  5. spring.cloud.nacos.config.ext-config[1].data-id=user.properties
    6.  
 
   
  6. spring.cloud.nacos.config.ext-config[1].group=multi-data-ids
    7.  
 
   
  7. spring.cloud.nacos.config.ext-config[1].refresh=true
    8.  

  
spring.cloud.nacos.config.ext-config[0].data-id=app.propertiesspring.cloud.nacos.config.ext-config[0].group=multi-data-idsspring.cloud.nacos.config.ext-config[0].refresh=truespring.cloud.nacos.config.ext-config[1].data-id=user.propertiesspring.cloud.nacos.config.ext-config[1].group=multi-data-idsspring.cloud.nacos.config.ext-config[1].refresh=true

nacos-config端点

spring-cloud-starter-alibaba-nacos-config内置了nacos-config端点，能够经过nacos-config端点查看配置相关信息，源码在org.springframework.cloud.alibaba.nacos.endpoint.NacosConfigEndpoint

  
     
 
   
  1. {
    2.  
 
   
  2.  "NacosConfigProperties": {
    3.  
 
   
  3.  "serverAddr": "127.0.0.1:8848", 
    4.  
 
   
  4.  "encode": null, 
    5.  
 
   
  5.  "group": "DEFAULT_GROUP", 
    6.  
 
   
  6.  "prefix": null, 
    7.  
 
   
  7.  "fileExtension": "properties", 
    8.  
 
   
  8.  "timeout": 3000, 
    9.  
 
   
  9.  "endpoint": null, 
    10.  
 
   
  10.  "namespace": null, 
    11.  
 
   
  11.  "accessKey": null, 
    12.  
 
   
  12.  "secretKey": null, 
    13.  
 
   
  13.  "contextPath": null, 
    14.  
 
   
  14.  "clusterName": null, 
    15.  
 
   
  15.  "name": null, 
    16.  
 
   
  16.  "sharedDataids": null, 
    17.  
 
   
  17.  "refreshableDataids": null, 
    18.  
 
   
  18.  "extConfig": [
    19.  
 
   
  19.  {
    20.  
 
   
  20.  "dataId": "example.properties", 
    21.  
 
   
  21.  "group": "DEFAULT_GROUP", 
    22.  
 
   
  22.  "refresh": true
    23.  
 
   
  23.  }, 
    24.  
 
   
  24.  {
    25.  
 
   
  25.  "dataId": "student.properties", 
    26.  
 
   
  26.  "group": "DEFAULT_GROUP", 
    27.  
 
   
  27.  "refresh": true
    28.  
 
   
  28.  }
    29.  
 
   
  29.  ]
    30.  
 
   
  30.  }, 
    31.  
 
   
  31.  "RefreshHistory": [], 
    32.  
 
   
  32.  "Sources": [
    33.  
 
   
  33.  {
    34.  
 
   
  34.  "lastSynced": "2019-08-18 13:07:42", 
    35.  
 
   
  35.  "dataId": "student.properties"
    36.  
 
   
  36.  }, 
    37.  
 
   
  37.  {
    38.  
 
   
  38.  "lastSynced": "2019-08-18 13:07:42", 
    39.  
 
   
  39.  "dataId": "null-test.properties"
    40.  
 
   
  40.  }, 
    41.  
 
   
  41.  {
    42.  
 
   
  42.  "lastSynced": "2019-08-18 13:07:42", 
    43.  
 
   
  43.  "dataId": "null.properties"
    44.  
 
   
  44.  }, 
    45.  
 
   
  45.  {
    46.  
 
   
  46.  "lastSynced": "2019-08-18 13:07:42", 
    47.  
 
   
  47.  "dataId": "example.properties"
    48.  
 
   
  48.  }
    49.  
 
   
  49.  ]
    50.  
 
   
  50. }
    51.  

  
{ "NacosConfigProperties": { "serverAddr": "127.0.0.1:8848",  "encode": null,  "group": "DEFAULT_GROUP",  "prefix": null,  "fileExtension": "properties",  "timeout": 3000,  "endpoint": null,  "namespace": null,  "accessKey": null,  "secretKey": null,  "contextPath": null,  "clusterName": null,  "name": null,  "sharedDataids": null,  "refreshableDataids": null,  "extConfig": [ { "dataId": "example.properties",  "group": "DEFAULT_GROUP",  "refresh": true },  { "dataId": "student.properties",  "group": "DEFAULT_GROUP",  "refresh": true } ] },  "RefreshHistory": [],  "Sources": [ { "lastSynced": "2019-08-18 13:07:42",  "dataId": "student.properties" },  { "lastSynced": "2019-08-18 13:07:42",  "dataId": "null-test.properties" },  { "lastSynced": "2019-08-18 13:07:42",  "dataId": "null.properties" },  { "lastSynced": "2019-08-18 13:07:42",  "dataId": "example.properties" } ]}

NacosConfigHealthIndicator

spring-cloud-starter-alibaba-nacos-config内置了Nacos健康状态检查的实现，当Nacos出现故障时，可以及时经过actuator/health进行反馈，源码在org.springframework.cloud.alibaba.nacos.endpoint.NacosConfigHealthIndicator

  
     
 
   
  1.  "status": "UP", 
    2.  
 
   
  2.  "details": {
    3.  
 
   
  3.  "diskSpace": {
    4.  
 
   
  4.  "status": "UP", 
    5.  
 
   
  5.  "details": {
    6.  
 
   
  6.  "total": 249795969024, 
    7.  
 
   
  7.  "free": 12436131840, 
    8.  
 
   
  8.  "threshold": 10485760
    9.  
 
   
  9.  }
    10.  
 
   
  10.  }, 
    11.  
 
   
  11.  "nacosConfig": {
    12.  
 
   
  12.  "status": "UP", 
    13.  
 
   
  13.  "details": {
    14.  
 
   
  14.  "dataId: 'student.properties', group: 'DEFAULT_GROUP'": "config is empty", 
    15.  
 
   
  15.  "dataId: 'null-test.properties', group: 'DEFAULT_GROUP'": "config is empty", 
    16.  
 
   
  16.  "dataId: 'null.properties', group: 'DEFAULT_GROUP'": "config is empty", 
    17.  
 
   
  17.  "dataId: 'example.properties', group: 'DEFAULT_GROUP'": "config is empty", 
    18.  
 
   
  18.  "dataIds": [
    19.  
 
   
  19.  "student.properties", 
    20.  
 
   
  20.  "null-test.properties", 
    21.  
 
   
  21.  "null.properties", 
    22.  
 
   
  22.  "example.properties"
    23.  
 
   
  23.  ]
    24.  
 
   
  24.  }
    25.  
 
   
  25.  }, 
    26.  
 
   
  26.  "refreshScope": {
    27.  
 
   
  27.  "status": "UP"
    28.  
 
   
  28.  }
    29.  
 
   
  29.  }
    30.  
 
   
  30. }
    31.  

  
 "status": "UP",  "details": { "diskSpace": { "status": "UP",  "details": { "total": 249795969024,  "free": 12436131840,  "threshold": 10485760 } },  "nacosConfig": { "status": "UP",  "details": { "dataId: 'student.properties', group: 'DEFAULT_GROUP'": "config is empty",  "dataId: 'null-test.properties', group: 'DEFAULT_GROUP'": "config is empty",  "dataId: 'null.properties', group: 'DEFAULT_GROUP'": "config is empty",  "dataId: 'example.properties', group: 'DEFAULT_GROUP'": "config is empty",  "dataIds": [ "student.properties",  "null-test.properties",  "null.properties",  "example.properties" ] } },  "refreshScope": { "status": "UP" } }}

目前我本身看下来，感受这块有那么一点点问题，现象是Nacos服务所有停掉以后，Nacos的health状态仍是UP, 并非咱们指望的DOWN。

看了下源码，发现了缘由，在最后一行设置了UP信息，就算前面设置了DOWN,最后都会变成UP, 不知道这是否是BUG, 哈哈。。。

  
     
 
   
  1. @Override
    2.  
 
   
  2. protected void doHealthCheck(Health.Builder builder) throws Exception {
    3.  
 
   
  3.  for (String dataId : dataIds) {
    4.  
 
   
  4.  try {
    5.  
 
   
  5.  String config = configService.getConfig(dataId,
    6.  
 
   
  6.  nacosConfigProperties.getGroup(),
    7.  
 
   
  7.  nacosConfigProperties.getTimeout());
    8.  
 
   
  8.  if (StringUtils.isEmpty(config)) {
    9.  
 
   
  9.  builder.down().withDetail(String.format("dataId: '%s', group: '%s'",
    10.  
 
   
  10.  dataId, nacosConfigProperties.getGroup()), "config is empty");
    11.  
 
   
  11.  }
    12.  
 
   
  12.  }
    13.  
 
   
  13.  catch (Exception e) {
    14.  
 
   
  14.  builder.down().withDetail(String.format("dataId: '%s', group: '%s'",
    15.  
 
   
  15.  dataId, nacosConfigProperties.getGroup()), e.getMessage());
    16.  
 
   
  16.  }
    17.  
 
   
  17.  }
    18.  
 
   
  18.  // 问题出在这边
    19.  
 
   
  19.  builder.up().withDetail("dataIds", dataIds);
    20.  
 
   
  20. }
    21.  

  
@Overrideprotected void doHealthCheck(Health.Builder builder) throws Exception { for (String dataId : dataIds) { try { String config = configService.getConfig(dataId, nacosConfigProperties.getGroup(), nacosConfigProperties.getTimeout()); if (StringUtils.isEmpty(config)) { builder.down().withDetail(String.format("dataId: '%s', group: '%s'", dataId, nacosConfigProperties.getGroup()), "config is empty"); } } catch (Exception e) { builder.down().withDetail(String.format("dataId: '%s', group: '%s'", dataId, nacosConfigProperties.getGroup()), e.getMessage()); } } // 问题出在这边 builder.up().withDetail("dataIds", dataIds);}

我以为最后一行应该加一个判断，当前面已经设置DOWN的时候，这边就不要再设置成UP了

  
     
 
   
  1. if( builder.build().getStatus() != Status.DOWN ) {
    2.  
 
   
  2.  builder.up().withDetail("dataIds", dataIds);
    3.  
 
   
  3. }
    4.  

  
if( builder.build().getStatus() != Status.DOWN ) { builder.up().withDetail("dataIds", dataIds);}

这边改完以后，仍是有个问题，就是Nacos其实在本地也有缓存配置信息，固然这个失效时间我没去看代码，还不知道多久失效。也就是说当Nacos全部的服务都挂掉后，这边也不能及时将健康状态设置成DOWN, 由于configService.getConfig的时候，内部会优先从本地缓存中获取配置，因此配置是能够获取到的，也就是健康检查在这种状况下是无效的。

我我的感受健康检查既然要作的话，那么就不要走这个逻辑，最简单的方式每次直接从Nacos服务读取，读取异常这个时候就能够设置成DOWN，就是这么简单。

不说了，去Github提个issues问问大佬们....

联系我们 沪ICP备13005482号-10