Nacos 教程

09、Nacos Spring Boot

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

关于Nacos Spring Boot 的详细文档请参看：nacos-spring-boot-project。

通过 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> 
    <groupId>com.alibaba.boot</groupId> 
    <artifactId>nacos-config-spring-boot-starter</artifactId> 
    <version>${latest.version}</version> 
</dependency>

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

1、在application.properties中配置Nacosserver的地址：

nacos.config.server-addr=127.0.0.1:8848

1、使用@NacosPropertySource加载dataId为example的配置源，并开启自动更新：

@SpringBootApplication 
@NacosPropertySource(dataId = "example", autoRefreshed = true) 
public class NacosConfigApplication { 

    public static void main(String[] args) { 
        SpringApplication.run(NacosConfigApplication.class, args); 
    } 
}

1、通过Nacos的@NacosValue注解设置属性值；

@Controller 
@RequestMapping("config") 
public class ConfigController { 

    @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true) 
    private boolean useLocalCache; 

    @RequestMapping(value = "/get", method = GET) 
    @ResponseBody 
    public boolean get() { 
        return useLocalCache; 
    } 
}

1、启动NacosConfigApplication，调用curlhttp://localhost:8080/config/get，返回内容是false；
2、通过调用NacosOpenAPI向Nacosserver发布配置：dataId为example，内容为useLocalCache=true；

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=example&group=DEFAULT_GROUP&content=useLocalCache=true"

1、再次访问http://localhost:8080/config/get，此时返回内容为true，说明程序中的useLocalCache值已经被动态更新了；

启动服务发现

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

1、添加依赖；

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

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

1、在application.properties中配置Nacosserver的地址：

nacos.discovery.server-addr=127.0.0.1:8848

1、使用@NacosInjected注入Nacos的NamingService实例：

@Controller 
@RequestMapping("discovery") 
public class DiscoveryController { 

    @NacosInjected 
    private NamingService namingService; 

    @RequestMapping(value = "/get", method = GET) 
    @ResponseBody 
    public List<Instance> get(@RequestParam String serviceName) throws NacosException { 
        return namingService.getAllInstances(serviceName); 
    } 
} 

@SpringBootApplication 
public class NacosDiscoveryApplication { 

    public static void main(String[] args) { 
        SpringApplication.run(NacosDiscoveryApplication.class, args); 
    } 
}

1、启动NacosDiscoveryApplication，调用curlhttp://localhost:8080/discovery/get?serviceName=example，此时返回为空JSON数组[]；
2、通过调用NacosOpenAPI向Nacosserver注册一个名称为example服务；

curl -X PUT 'http://127.0.0.1:8848/nacos/v1/ns/instance?serviceName=example&ip=127.0.0.1&port=8080'

1、再次访问curlhttp://localhost:8080/discovery/get?serviceName=example，此时返回内容为：

[ 
  { 
    "instanceId": "127.0.0.1-8080-DEFAULT-example", 
    "ip": "127.0.0.1", 
    "port": 8080, 
    "weight": 1.0, 
    "healthy": true, 
    "cluster": { 
      "serviceName": null, 
      "name": "", 
      "healthChecker": { 
        "type": "TCP" 
      }, 
      "defaultPort": 80, 
      "defaultCheckPort": 80, 
      "useIPPort4Check": true, 
      "metadata": {} 
    }, 
    "service": null, 
    "metadata": {} 
  } 
]

前提条件

启动配置管理

启动服务发现

相关项目