Nacos与Spring快速入门

Posted 科教小屋

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Nacos与Spring快速入门相关的知识,希望对你有一定的参考价值。

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

  • 通过 Nacos server 和 Nacos Spring 配置管理模块,实现配置的动态变更;

  • 通过 Nacos server 和 Nacos Spring 服务发现模块,实现服务的注册与发现。

前提条件

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

启动配置管理

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

  • 添加依赖。

 
   
   
 
  1. <dependency>

  2. <groupId>com.alibaba.nacos</groupId>

  3. <artifactId>nacos-spring-context</artifactId>

  4. <version>${latest.version}</version>

  5. </dependency>

  • 添加 @EnableNacosConfig 注解启用 Nacos Spring 的配置管理服务。以下示例中,我们使用 @NacosPropertySource 加载了 dataId 为 example 的配置源,并开启自动更新:

 
   
   
 
  1. @Configuration

  2. @EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))

  3. @NacosPropertySource(dataId = "example", autoRefreshed = true)

  4. public class NacosConfiguration {

  5. }

  • 通过 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. }

  • 启动 Tomcat,调用 curl http://localhost:8080/config/get尝试获取配置信息。由于此时还未发布过配置,所以返回内容是 false

  • 通过调用 Nacos Open API 向 Nacos Server 发布配置:dataId 为example,内容为useLocalCache=true

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

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

启动服务发现

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

  • 添加依赖。

 
   
   
 
  1. <dependency>

  2. <groupId>com.alibaba.nacos</groupId>

  3. <artifactId>nacos-spring-context</artifactId>

  4. <version>${latest.version}</version>

  5. </dependency>

  • 通过添加 @EnableNacosDiscovery 注解开启 Nacos Spring 的服务发现功能:

 
   
   
 
  1. @Configuration

  2. @EnableNacosDiscovery(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))

  3. public class NacosConfiguration {

  4. }

  • 使用 @NacosInjected 注入 Nacos 的 NamingService 实例:

 
   
   
 
  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. }

  • 启动 Tomcat,调用 curl http://localhost:8080/discovery/get?serviceName=example,此时返回为空 JSON 数组[]

  • 通过调用 Nacos Open API 向 Nacos server 注册一个名称为 example 服务。

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

  • 再次访问 curl http://localhost:8080/discovery/get?serviceName=example,此时返回内容为:

 复制代码
 
   
   
 
  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. ]


以上是关于Nacos与Spring快速入门的主要内容,如果未能解决你的问题,请参考以下文章

Spring Cloud Alibaba Seata 分布式事务使用快速入门,Nacos做Seata的注册中心和配置中心

Spring Cloud Alibaba Seata 分布式事务使用快速入门,Nacos做Seata的注册中心和配置中心

Spring Cloud Alibaba Seata 分布式事务使用快速入门,Nacos做Seata的注册中心和配置中心

【Nacos专题】Nacos 快速入门

Nacos使用快速入门

测试中间件 - Nacos 快速入门