Spring Cloud Alibaba-Nacos-创建服务提供者

左手的ㄟ右手 2024-03-30 12:12 10阅读 0赞

### 概述 ###

通过一个简单的示例来感受一下如何将服务注册到 Nacos，其实和 Eureka 没有太大差别。

### POM ###

创建一个工程名为 `hello-spring-cloud-alibaba-nacos-provider` 的服务提供者项目，`pom.xml` 配置如下：

> 1.  `<?xml version="1.0" encoding="UTF-8"?>`
> 2.  `<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"`
> 3.  `xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">`
> 4.  `<modelVersion>4.0.0</modelVersion>`
> 5.  
> 6.  `<parent>`
> 7.  `<groupId>com.dandelioncloud</groupId>`
> 8.  `<artifactId>hello-spring-cloud-alibaba-dependencies</artifactId>`
> 9.  `<version>1.0.0-SNAPSHOT</version>`
> 10. `<relativePath>../hello-spring-cloud-alibaba-dependencies/pom.xml</relativePath>`
> 11. `</parent>`
> 12. 
> 13. `<artifactId>hello-spring-cloud-alibaba-nacos-provider</artifactId>`
> 14. `<packaging>jar</packaging>`
> 15. 
> 16. `<name>hello-spring-cloud-alibaba-nacos-provider</name>`
> 17. `<url>http://www.dandelioncloud.cn</url>`
> 18. `<inceptionYear>2018-Now</inceptionYear>`
> 19. 
> 20. `<dependencies>`
> 21. ``
> 22. `<dependency>`
> 23. `<groupId>org.springframework.boot</groupId>`
> 24. `<artifactId>spring-boot-starter-web</artifactId>`
> 25. `</dependency>`
> 26. `<dependency>`
> 27. `<groupId>org.springframework.boot</groupId>`
> 28. `<artifactId>spring-boot-starter-actuator</artifactId>`
> 29. `</dependency>`
> 30. `<dependency>`
> 31. `<groupId>org.springframework.boot</groupId>`
> 32. `<artifactId>spring-boot-starter-test</artifactId>`
> 33. `<scope>test</scope>`
> 34. `</dependency>`
> 35. ``
> 36. 
> 37. ``
> 38. `<dependency>`
> 39. `<groupId>org.springframework.cloud</groupId>`
> 40. `<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>`
> 41. `</dependency>`
> 42. ``
> 43. `</dependencies>`
> 44. 
> 45. `<build>`
> 46. `<plugins>`
> 47. `<plugin>`
> 48. `<groupId>org.springframework.boot</groupId>`
> 49. `<artifactId>spring-boot-maven-plugin</artifactId>`
> 50. `<configuration>`
> 51. `<mainClass>com.dandelioncloud.hello.spring.cloud.alibaba.nacos.provider.NacosProviderApplication</mainClass>`
> 52. `</configuration>`
> 53. `</plugin>`
> 54. `</plugins>`
> 55. `</build>`
> 56. `</project>`

### Application ###

通过 `@EnableDiscoveryClient` 注解表明是一个 Nacos 客户端，该注解是 Spring Cloud 提供的原生注解

> 1.  `package cn.dandelioncloud.hello.spring.cloud.alibaba.nacos.provider;`
> 2.  
> 3.  `import org.springframework.boot.SpringApplication;`
> 4.  `import org.springframework.boot.autoconfigure.SpringBootApplication;`
> 5.  `import org.springframework.cloud.client.discovery.EnableDiscoveryClient;`
> 6.  `import org.springframework.web.bind.annotation.GetMapping;`
> 7.  `import org.springframework.web.bind.annotation.PathVariable;`
> 8.  `import org.springframework.web.bind.annotation.RestController;`
> 9.  
> 10. `@SpringBootApplication`
> 11. `@EnableDiscoveryClient`
> 12. `public class NacosProviderApplication {`
> 13. `public static void main(String[] args) {`
> 14. `SpringApplication.run(NacosProviderApplication.class, args);`
> 15. `}`
> 16. 
> 17. `@RestController`
> 18. `public class EchoController {`
> 19. `@GetMapping(value = "/echo/{message}")`
> 20. `public String echo(@PathVariable String message) {`
> 21. `return "Hello Nacos Discovery " + message;`
> 22. `}`
> 23. `}`
> 24. `}`

### application.yml ###

> 1.  `spring:`
> 2.  `application:`
> 3.  `name: nacos-provider`
> 4.  `cloud:`
> 5.  `nacos:`
> 6.  `discovery:`
> 7.  `server-addr: 127.0.0.1:8848`
> 8.  
> 9.  `server:`
> 10. `port: 8081`
> 11. 
> 12. `management:`
> 13. `endpoints:`
> 14. `web:`
> 15. `exposure:`
> 16. `include: "*"`

### 启动工程 ###

通过浏览器访问 `http://localhost:8848/nacos`，即 Nacos Server 网址

![27d99e94320e4b66b85bf3348858e71f.png][]

你会发现一个服务已经注册在服务中了，服务名为 `nacos-provider`

这时打开 `http://localhost:8081/echo/hi` ，你会在浏览器上看到：

> 1.  `Hello Nacos Discovery hi`

### 服务的端点检查 ###

spring-cloud-starter-alibaba-nacos-discovery 在实现的时候提供了一个 EndPoint, EndPoint 的访问地址为 `http://ip:port/actuator/nacos-discovery`。 EndPoint 的信息主要提供了两类:

> 1.  `1、subscribe: 显示了当前有哪些服务订阅者`
> 2.  `2、NacosDiscoveryProperties: 显示了当前服务实例关于 Nacos 的基础配置`

通过浏览器访问 `http://localhost:8081/actuator/nacos-discovery` 你会在浏览器上看到：

![9a81f108e2724125bb3d72cc5d6c38c3.png][]

### 附：Nacos Starter 更多配置项信息 ###

<table> 
 <thead> 
  <tr> 
   <th>配置项</th> 
   <th>Key</th> 
   <th>默认值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>服务端地址</td> 
   <td>spring.cloud.nacos.discovery.server-addr</td> 
   <td>无</td> 
   <td>Nacos Server 启动监听的ip地址和端口</td> 
  </tr> 
  <tr> 
   <td>服务名</td> 
   <td>spring.cloud.nacos.discovery.service</td> 
   <td>${spring.application.name}</td> 
   <td>给当前的服务命名</td> 
  </tr> 
  <tr> 
   <td>权重</td> 
   <td>spring.cloud.nacos.discovery.weight</td> 
   <td>1</td> 
   <td>取值范围 1 到 100，数值越大，权重越大</td> 
  </tr> 
  <tr> 
   <td>网卡名</td> 
   <td>spring.cloud.nacos.discovery.network-interface</td> 
   <td>无</td> 
   <td>当IP未配置时，注册的IP为此网卡所对应的IP地址，如果此项也未配置，则默认取第一块网卡的地址</td> 
  </tr> 
  <tr> 
   <td>注册的IP地址</td> 
   <td>spring.cloud.nacos.discovery.ip</td> 
   <td>无</td> 
   <td>优先级最高</td> 
  </tr> 
  <tr> 
   <td>注册的端口</td> 
   <td>spring.cloud.nacos.discovery.port</td> 
   <td>-1</td> 
   <td>默认情况下不用配置，会自动探测</td> 
  </tr> 
  <tr> 
   <td>命名空间</td> 
   <td>spring.cloud.nacos.discovery.namespace</td> 
   <td>无</td> 
   <td>常用场景之一是不同环境的注册的区分隔离，例如开发测试环境和生产环境的资源（如配置、服务）隔离等。</td> 
  </tr> 
  <tr> 
   <td>AccessKey</td> 
   <td>spring.cloud.nacos.discovery.access-key</td> 
   <td>无</td> 
   <td>当要上阿里云时，阿里云上面的一个云账号名</td> 
  </tr> 
  <tr> 
   <td>SecretKey</td> 
   <td>spring.cloud.nacos.discovery.secret-key</td> 
   <td>无</td> 
   <td>当要上阿里云时，阿里云上面的一个云账号密码</td> 
  </tr> 
  <tr> 
   <td>Metadata</td> 
   <td>spring.cloud.nacos.discovery.metadata</td> 
   <td>无</td> 
   <td>使用 Map 格式配置，用户可以根据自己的需要自定义一些和服务相关的元数据信息</td> 
  </tr> 
  <tr> 
   <td>日志文件名</td> 
   <td>spring.cloud.nacos.discovery.log-name</td> 
   <td>无</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>接入点</td> 
   <td>spring.cloud.nacos.discovery.enpoint</td> 
   <td>UTF-8</td> 
   <td>地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址</td> 
  </tr> 
  <tr> 
   <td>是否集成 Ribbon</td> 
   <td>ribbon.nacos.enabled</td> 
   <td>true</td> 
   <td>一般都设置成 true 即可</td> 
  </tr> 
 </tbody> 
</table>

[27d99e94320e4b66b85bf3348858e71f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/dbf231c7e97e427ba0feb3f6eb899412.png
[9a81f108e2724125bb3d72cc5d6c38c3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/30/74a78a0363844be5ad3896de4f11572f.png