Nacos学习日记3 - Nacos 对Spring,SpringBoot,Springcloud框架集成的实例项目

快来打我* 2023-02-18 03:09 16阅读 0赞

# Nacos 对Spring,SpringBoot,Springcloud框架集成的实例项目 #

--------------------

*  [Nacos][]
 *  [Nacos Spring][]
 *  [Nacos Spring Boot][]
 *  [Spring Cloud Alibaba][]
 *  [Nacos Docker][]

--------------------

# Nacos 对 Spring 集成的使用 #

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

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

*  通过 Nacos server 和 Nacos Spring 配置管理模块，实现配置的动态变更；
 *  通过 Nacos server 和 Nacos Spring 服务发现模块，实现服务的注册与发现。

## 前提条件 ##

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

## 启动配置管理 ##

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

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

最新版本可以在 maven 仓库，如 "[mvnrepository.com][]" 中获取。

@Configuration
    @EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    @NacosPropertySource(dataId = "example", autoRefreshed = true)
    public class NacosConfiguration {
    
    }

@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;
        }
    }

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

## 启动服务发现 ##

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

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

最新版本可以在 maven 仓库，如 "[mvnrepository.com][]" 中获取。

@Configuration
    @EnableNacosDiscovery(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    public class NacosConfiguration {
    
    }

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

[
      {
        "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": {}
      }
    ]

--------------------

# Nacos 对 Spring Boot 集成的使用 #

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

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

## 前提条件 ##

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

## 启动配置管理 ##

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

<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][0.2.x.RELEASE] 对应的是 Spring Boot 1.x 版本。

nacos.config.server-addr=127.0.0.1:8848

@SpringBootApplication
    @NacosPropertySource(dataId = "example", autoRefreshed = true)
    public class NacosConfigApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(NacosConfigApplication.class, args);
        }
    }

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][]

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

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

nacos.discovery.server-addr=127.0.0.1:8848

@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);
        }
    }

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

[
      {
        "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": {}
      }
    ]

--------------------

# Nacos 对 Spring Cloud 集成的使用 #

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

关于 Nacos Spring Cloud 的详细文档请参看：[Nacos Config][] 和 [Nacos Discovery][]。

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

## 前提条件 ##

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

## 启动配置管理 ##

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

1.  添加依赖：

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

**注意**：版本 [2.1.x.RELEASE][] 对应的是 Spring Boot 2.1.x 版本。版本 [2.0.x.RELEASE][2.1.x.RELEASE] 对应的是 Spring Boot 2.0.x 版本，版本 [1.5.x.RELEASE][2.1.x.RELEASE] 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考：[版本说明 Wiki][Wiki]

1.  在 `bootstrap.properties` 中配置 Nacos server 的地址和应用名

spring.cloud.nacos.config.server-addr=127.0.0.1:8848
    
    spring.application.name=example

说明：之所以需要配置 `spring.application.name` ，是因为它是构成 Nacos 配置管理 `dataId`字段的一部分。

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

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

*  `prefix` 默认为 `spring.application.name` 的值，也可以通过配置项 `spring.cloud.nacos.config.prefix`来配置。
 *  `spring.profile.active` 即为当前环境对应的 profile，详情可以参考 [Spring Boot文档][Spring Boot]。 **注意：当 spring.profile.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 \{file-extension\}**
 *  `file-exetension` 为配置内容的数据格式，可以通过配置项 `spring.cloud.nacos.config.file-extension` 来配置。目前只支持 `properties` 和 `yaml` 类型。

1.  通过 Spring Cloud 原生注解 `@RefreshScope` 实现配置自动更新：

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

1.  首先通过调用 [Nacos Open API][] 向 Nacos Server 发布配置：dataId 为`example.properties`，内容为`useLocalCache=true`

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

1.  运行 `NacosConfigApplication`，调用 `curl http://localhost:8080/config/get`，返回内容是 `true`。
2.  再次调用 [Nacos Open API][] 向 Nacos server 发布配置：dataId 为`example.properties`，内容为`useLocalCache=false`

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

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

## 启动服务发现 ##

本节通过实现一个简单的 `echo service` 演示如何在您的 Spring Cloud 项目中启用 Nacos 的服务发现功能，如下图示:

![format_png][]

完整示例代码请参考：[nacos-spring-cloud-discovery-example][]

1.  添加依赖：

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

**注意**：版本 [2.1.x.RELEASE][2.1.x.RELEASE 1] 对应的是 Spring Boot 2.1.x 版本。版本 [2.0.x.RELEASE][2.1.x.RELEASE 1] 对应的是 Spring Boot 2.0.x 版本，版本 [1.5.x.RELEASE][2.1.x.RELEASE 1] 对应的是 Spring Boot 1.5.x 版本。

更多版本对应关系参考：[版本说明 Wiki][Wiki]

1.  配置服务提供者，从而服务提供者可以通过 Nacos 的服务注册发现功能将其服务注册到 Nacos server 上。

i. 在 `application.properties` 中配置 Nacos server 的地址：

server.port=8070
    spring.application.name=service-provider
    
    spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

ii. 通过 Spring Cloud 原生注解 `@EnableDiscoveryClient` 开启服务注册发现功能：

@SpringBootApplication
    @EnableDiscoveryClient
    public class NacosProviderApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(NacosProviderApplication.class, args);
        }
    
        @RestController
        class EchoController {
            @RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
            public String echo(@PathVariable String string) {
                return "Hello Nacos Discovery " + string;
            }
        }
    }

1.  配置服务消费者，从而服务消费者可以通过 Nacos 的服务注册发现功能从 Nacos server 上获取到它要调用的服务。

i. 在 `application.properties` 中配置 Nacos server 的地址：

server.port=8080
    spring.application.name=service-consumer
    
    spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

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

@SpringBootApplication
    @EnableDiscoveryClient
    public class NacosConsumerApplication {
    
        @LoadBalanced
        @Bean
        public RestTemplate restTemplate() {
            return new RestTemplate();
        }
    
        public static void main(String[] args) {
            SpringApplication.run(NacosConsumerApplication.class, args);
        }
    
        @RestController
        public class TestController {
    
            private final RestTemplate restTemplate;
    
            @Autowired
            public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}
    
            @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
            public String echo(@PathVariable String str) {
                return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
            }
        }
    }

1.  启动 `ProviderApplication` 和 `ConsumerApplication` ，调用 `http://localhost:8080/echo/2018`，返回内容为 `Hello Nacos Discovery 2018`。

[Nacos]: https://github.com/alibaba/nacos
[Nacos Spring]: https://github.com/nacos-group/nacos-spring-project
[Nacos Spring Boot]: https://github.com/nacos-group/nacos-spring-boot-project
[Spring Cloud Alibaba]: https://github.com/alibaba/spring-cloud-alibaba
[Nacos Docker]: https://github.com/nacos-group/nacos-docker
[nacos-spring-project]: https://github.com/nacos-group/nacos-spring-project/wiki/Nacos-Spring-Project-0.3.1-%E6%96%B0%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C
[Nacos 1]: https://nacos.io/zh-cn/docs/quick-start.html
[nacos-spring-config-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-example/nacos-spring-config-example
[mvnrepository.com]: https://mvnrepository.com/artifact/com.alibaba.nacos/nacos-spring-context
[nacos-spring-discovery-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-example/nacos-spring-discovery-example
[nacos-spring-boot-project]: https://github.com/nacos-group/nacos-spring-boot-project/wiki/spring-boot-0.2.2-%E4%BB%A5%E5%8F%8A-0.1.2%E7%89%88%E6%9C%AC%E6%96%B0%E5%8A%9F%E8%83%BD%E4%BD%BF%E7%94%A8%E6%89%8B%E5%86%8C
[nacos-spring-boot-config-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-boot-example/nacos-spring-boot-config-example
[0.2.x.RELEASE]: https://mvnrepository.com/artifact/com.alibaba.boot/nacos-config-spring-boot-starter
[nacos-spring-boot-discovery-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-boot-example/nacos-spring-boot-discovery-example
[0.2.x.RELEASE 1]: https://mvnrepository.com/artifact/com.alibaba.boot/nacos-discovery-spring-boot-starter
[Spring Cloud]: https://spring.io/projects/spring-cloud
[Nacos Config]: https://github.com/spring-cloud-incubator/spring-cloud-alibaba/wiki/Nacos-config
[Nacos Discovery]: https://github.com/spring-cloud-incubator/spring-cloud-alibaba/wiki/Nacos-discovery
[nacos-spring-cloud-config-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-cloud-example/nacos-spring-cloud-config-example
[2.1.x.RELEASE]: https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-starter-alibaba-nacos-config
[Wiki]: https://github.com/spring-cloud-incubator/spring-cloud-alibaba/wiki/%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E
[Spring Boot]: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-profiles.html#boot-features-profiles
[Nacos Open API]: https://nacos.io/zh-cn/docs/open-API.html
[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jZG4ubmxhcmsuY29tL2xhcmsvMC8yMDE4L3BuZy8xNTkxNC8xNTQyMTE5MTgxMzM2LWI2ZGMwZmMxLWVkNDYtNDNhNy05ZTVmLTY4YzljYTM0NGQ2MC5wbmc?x-oss-process=image/format,png
[nacos-spring-cloud-discovery-example]: https://github.com/nacos-group/nacos-examples/tree/master/nacos-spring-cloud-example/nacos-spring-cloud-discovery-example
[2.1.x.RELEASE 1]: https://mvnrepository.com/artifact/com.alibaba.cloud/spring-cloud-starter-alibaba-nacos-discovery
[RestTemplate]: https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-resttemplate.html
[Ribbon]: https://cloud.spring.io/spring-cloud-netflix/multi/multi_spring-cloud-ribbon.html