Spring Cloud Nacos实现分布式环境下的配置管理和服务注册发现

本文主要面向 Spring Cloud 的使用者，通过两个示例来介绍如何使用 Nacos 来实现分布式环境下的配置管理和服务注册发现。

一、前提条件：

安装和启动Nacos Server，请参考：https://github.com/nicxsky/springboot-collection/blob/main/springboot-nacos-alibaba/README.md

二、Spring Cloud集成Nacos

• 通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-config 实现配置的动态变更

代码地址：https://github.com/nicxsky/springboot-collection/tree/main/springcloud-nacos-alibaba

1、添加pom依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>${spring-cloud-starter-alibaba-nacos}</version>
</dependency>

2、在resources下新建bootstrap.yml配置文件，添加Nacos Server配置

spring:
  application:
    name: my-service-provider
  cloud:
    nacos:
      config:
        # 配置Nacos Server地址，用于配置的动态变更
        server-addr: 192.168.164.128:8848
# Nacos 注册中心客户端心跳日志禁用 get changedGroupKeys:[] 刷屏
logging:
  level:
    com.alibaba.nacos.client.config.impl: WARN

注：之所以需要配置 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 类型。

3、通过Spring Cloud原生注解@RefreshScope实现配置自动更新

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

4、通过调用Nacos Open API向Nacos Server发布配置：dataId为my-example.properties，内容为useLocalCache=true

curl -X POST "http://192.168.164.128:8848/nacos/v1/cs/configs?dataId=my-service-provider&group=DEFAULT_GROUP&content=useLocalCache=true"

5、启动运行SpringCloudNacosApplication，调用http://localhost:8082/cloud-nacos/config/get，返回内容是ture

6、再次通过调用Nacos Open API向Nacos Server发布配置：dataId为my-example.properties，内容为useLocalCache=false

curl -X POST "http://192.168.164.128:8848/nacos/v1/cs/configs?dataId=my-service-provider&group=DEFAULT_GROUP&content=useLocalCache=false"

7、此时再调用http://localhost:8082/cloud-nacos/config/get，返回内容是false，说明程序中的useLocalCache值已经被动态更新了，至此就实现的配置的动态更新。

• 通过 Nacos Server 和 spring-cloud-starter-alibaba-nacos-discovery 实现服务的注册与发现

代码地址：https://github.com/nicxsky/springboot-collection/tree/main/springcloud-nacos-consumer

新建服务生产者项目

1、添加pom依赖

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>${spring-cloud-starter-alibaba-nacos}</version>
</dependency>

2、在application.properties中配置Nacos server的地址

# 配置Nacos Server地址，用于服务注册、发现
spring.application.name=my-service-provider
spring.cloud.nacos.discovery.server-addr=192.168.164.128:8848

3、通过Spring Cloud原生注解@EnableDiscoveryClient开启服务注册发现功能

@SpringBootApplication
@EnableDiscoveryClient
public class SpringCloudNacosApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudNacosApplication.class, args);
    }
}

@RestController
@RequestMapping("discovery")
public class DiscoveryController {
    @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
    public String echo(@PathVariable String string) {
        return "Hello Nacos Discovery1 " + string;
    }
    @RequestMapping(value = "/echo2/{string}", method = RequestMethod.GET)
    public String echo2(@PathVariable String string) {
        return "Hello Nacos Discovery2 " + string;
    }
}

4、测试服务提供者，成功返回，说明没问题

新建服务消费者项目

1、添加pom依赖，同生产者

2、在application.properties中配置Nacos server的地址

# 配置Nacos Server地址，用于服务注册、发现
spring.application.name=my-service-consumer
spring.cloud.nacos.discovery.server-addr=192.168.164.128:8848

3、通过Spring Cloud原生注解@EnableDiscoveryClient开启服务注册发现功能。给RestTemplate实例添加@LoadBalanced注解，开启@LoadBalanced与Ribbon的集成

@SpringBootApplication
@EnableDiscoveryClient
public class SpringCloudNacosApplication {
    /**
     * 通过 Spring Cloud 原生注解 @EnableDiscoveryClient 开启服务注册发现功能。
     * 给 RestTemplate 实例添加 @LoadBalanced 注解，开启 @LoadBalanced 与 Ribbon 的集成
     * @return
     */
    @LoadBalanced
    @Bean
    public RestTemplate restTemplate() {
        return new RestTemplate();
    }
    public static void main(String[] args) {
        SpringApplication.run(SpringCloudNacosApplication.class, args);
    }
}
@RestController
@RequestMapping("consumer")
public class DiscoveryController {
    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    public DiscoveryController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}
    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    public String echo(@PathVariable String str) {
        return restTemplate.getForObject("http://my-service-provider/cloud-nacos/discovery/echo/" + str, String.class);
    }
}

4、启动服务消费者Application，测试

5、查看服务列表