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

  • 通过 Nacos Server 和 nacos-config-spring-boot-starter 实现配置的动态变更;
  • 通过 Nacos Server 和 nacos-discovery-spring-boot-starter 实现服务的注册与发现。

前提条件

您需要先下载 Nacos 并启动 Nacos server。操作步骤参见 Nacos 快速入门

启动配置管理

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

  • 添加依赖。
  1. <dependency>
  2. <groupId>com.alibaba.boot</groupId>
  3. <artifactId>nacos-config-spring-boot-starter</artifactId>
  4. <version>${latest.version}</version>
  5. </dependency>

注意:版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本。

  • application.properties 中配置 Nacos server 的地址:
  1. nacos.config.server-addr=127.0.0.1:8848
  1. @SpringBootApplication
  2. @NacosPropertySource(dataId = "example", autoRefreshed = true)
  3. public class NacosConfigApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(NacosConfigApplication.class, args);
  6. }
  7. }
  • 通过 Spring 的 @Value 注解设置属性值。
    注意:需要同时有 Setter 方法才能在配置变更的时候自动更新。
  1. @Controller
  2. @RequestMapping("config")
  3. public class ConfigController {
  4. @Value("${useLocalCache:false}")
  5. private boolean useLocalCache;
  6. public void setUseLocalCache(boolean useLocalCache) {
  7. this.useLocalCache = useLocalCache;
  8. }
  9. @RequestMapping(value = "/get", method = GET)
  10. @ResponseBody
  11. public boolean get() {
  12. return useLocalCache;
  13. }
  14. }
  1. curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example&group=DEFAULT_GROUP&content=useLocalCache=true"

启动服务发现

本节演示如何在您的 Spring Boot 项目中启动 Nacos 的服务发现功能。完整示例代码请参考:nacos-spring-boot-discovery-example

  • 添加依赖。
  1. <dependency>
  2. <groupId>com.alibaba.boot</groupId>
  3. <artifactId>nacos-discovery-spring-boot-starter</artifactId>
  4. <version>${latest.version}</version>
  5. </dependency>

注意:版本 0.2.x.RELEASE 对应的是 Spring Boot 2.x 版本,版本 0.1.x.RELEASE 对应的是 Spring Boot 1.x 版本。

  • application.properties 中配置 Nacos server 的地址:
  1. nacos.discovery.server-addr=127.0.0.1:8848
  1. @Controller
  2. @RequestMapping("discovery")
  3. public class DiscoveryController {
  4. @NacosInjected
  5. private NamingService namingService;
  6. @RequestMapping(value = "/get", method = GET)
  7. @ResponseBody
  8. public List<Instance> get(@RequestParam String serviceName) throws NacosException {
  9. return namingService.getAllInstances(serviceName);
  10. }
  11. }
  12. @SpringBootApplication
  13. public class NacosDiscoveryApplication {
  14. public static void main(String[] args) {
  15. SpringApplication.run(NacosDiscoveryApplication.class, args);
  16. }
  17. }
  1. curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080'
  1. [
  2. {
  3. "instanceId": "127.0.0.1-8080-DEFAULT-example",
  4. "ip": "127.0.0.1",
  5. "port": 8080,
  6. "weight": 1.0,
  7. "healthy": true,
  8. "cluster": {
  9. "serviceName": null,
  10. "name": "",
  11. "healthChecker": {
  12. "type": "TCP"
  13. },
  14. "defaultPort": 80,
  15. "defaultCheckPort": 80,
  16. "useIPPort4Check": true,
  17. "metadata": {}
  18. },
  19. "service": null,
  20. "metadata": {}
  21. }
  22. ]

相关项目

原文: https://nacos.io/zh-cn/docs/quick-start-spring-boot.html