1.什么是Nacos？

Nacos 是阿里巴巴开源的一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。

2.Nacos Config整合

Nacos Config Starter实现Spring Cloud应用程序的外部化配置。

2.1 启动 Nacos Server 并添加配置

1.下载地址：

1. 直接下载：Nacos Server 下载页
2. 源码构建：Github 项目页面

2.启动

1. Linux/Unix/Mac 操作系统，执行命令 sh startup.sh -m standalone
2. Windows 操作系统，执行命令 cmd startup.cmd
3. 默认账户密码：nacos

3.在命令行执行如下命令，向 Nacos Server 中添加一条配置，也可在控制台中手动添加。

 curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos-config-example.properties&group=DEFAULT_GROUP&content=user.id=1%0Auser.name=james%0Auser.age=17"

添加的配置的详情如下

 dataId 为 nacos-config-example.properties
 group 为 DEFAULT_GROUP
 
 内容如下
 
 	user.id=1
 	user.name=james
 	user.age=17	

2.1 引入pom文件

 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
 </dependency>

2.2 添加bootstrap.properties

spring.application.name=nacos-config-example
spring.cloud.nacos.config.server-addr=ip:8848 #服务器ip或本地ip

2.3 获取相应的配置

@RefreshScope //打开动态刷新功能
 class SampleController {
    

 	@Value("${user.name}")
 	String userName;

 	@Value("${user.age}")
 	int age;
 }

2.4 应用启动

1.添加/application.properties

server.port=18084
management.endpoints.web.exposure.include=*

2.App启动

2.5 原理

1.Nacos Config 数据结构

Nacos Config 主要通过 dataId 和 group 来唯一确定一条配置.

Nacos Client 从 Nacos Server 端获取数据时，调用的是此接口 ConfigService.getConfig(String dataId, String group, long timeoutMs)。

2.Spring Cloud 应用获取数据

dataId

在 Nacos Config Starter 中，dataId 的拼接格式如下

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

• prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。

• spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档

  注意，当 activeprofile 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 $prefix.${file-extension}

• file-extension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension来配置。 目前只支持 properties 类型。

group

• group 默认为 DEFAULT_GROUP，可以通过 spring.cloud.nacos.config.group 配置。

3.自动注入

Nacos Config Starter 实现了 org.springframework.cloud.bootstrap.config.PropertySourceLocator接口，并将优先级设置成了最高。

在 Spring Cloud 应用启动阶段，会主动从 Nacos Server 端获取对应的数据，并将获取到的数据转换成 PropertySource 且注入到 Environment 的 PropertySources 属性中，所以使用 @Value 注解也能直接获取 Nacos Server 端配置的内容。

4.动态刷新

Nacos Config Starter 默认为所有获取数据成功的 Nacos 的配置项添加了监听功能，在监听到服务端配置发生变化时会实时触发 org.springframework.cloud.context.refresh.ContextRefresher 的 refresh 方法 。

如果需要对 Bean 进行动态刷新，给类添加 @RefreshScope 或 @ConfigurationProperties注解。

5.Endpoint 信息查看

Springboot支持这一点，Nacos Config也同时可以使用Endpoint来暴露信息。

在maven 中添加 spring-boot-starter-actuator依赖，并在配置中允许 Endpoints 的访问。

• Spring Boot 1.x 中添加配置 management.security.enabled=false
• Spring Boot 2.x 中添加配置 management.endpoints.web.exposure.include=*

Spring Boot 1.x 可以通过访问 http://127.0.0.1:18084/nacos_config 来查看 Nacos Endpoint 的信息。

Spring Boot 2.x 可以通过访问 http://127.0.0.1:18084/actuator/nacos-config 来访问。

2.6 更多

配置项	key	默认值	说明
服务端地址	spring.cloud.nacos.config.server-addr
DataId前缀	spring.cloud.nacos.config.prefix		spring.application.name
Group	spring.cloud.nacos.config.group	DEFAULT_GROUP
dataID后缀及内容文件格式	spring.cloud.nacos.config.file-extension	properties	dataId的后缀，同时也是配置内容的文件格式，目前只支持 properties
配置内容的编码方式	spring.cloud.nacos.config.encode	UTF-8	配置的编码
获取配置的超时时间	spring.cloud.nacos.config.timeout	3000	单位为 ms
配置的命名空间	spring.cloud.nacos.config.namespace		常用场景之一是不同环境的配置的区分隔离，例如开发测试环境和生产环境的资源隔离等。
AccessKey	spring.cloud.nacos.config.access-key
SecretKey	spring.cloud.nacos.config.secret-key
相对路径	spring.cloud.nacos.config.context-path		服务端 API 的相对路径
接入点	spring.cloud.nacos.config.endpoint	UTF-8	地域的某个服务的入口域名，通过此域名可以动态地拿到服务端地址
是否开启监听和自动刷新	spring.cloud.nacos.config.refresh.enabled	true

3.Nacos Discovery 整合

Nacos Discovery Starter 完成 Spring Cloud 应用的服务注册与发现。

3.1 添加依赖

<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
 </dependency>

3.2 application.properties

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

3.3 服务注册和发现

@SpringBootApplication
@EnableDiscoveryClient
public class ProviderApplication {
    

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

 	@RestController
 	class EchoController {
    
 		@RequestMapping(value = "/echo/{string}", method = RequestMethod.GET)
 		public String echo(@PathVariable String string) {
    
 				return string;
 		}
 	}
 }

3.4 启动Nacos服务端

1. 通过从源代码下载或构建来安装Nacos Server。推荐的最新版本Nacos Server
   1. 下载Nacos Server 下载页面
   2. 从源代码构建：通过git clone [email protected]获取源代码：来自Github Nacos的alibaba / Nacos.git并构建您的代码。有关详细信息，请参阅构建
2. 运行
   1. Linux / Unix / Mac，执行 sh startup.sh -m standalone
   2. Windows，执行 cmd startup.cmd

3.5 启动客户端

1.添加application.properties配置

 spring.application.name=service-provider
 server.port=18082

3.6 查询服务

http://127.0.0.1:8848/nacos/v1/ns/instances?serviceName=service-provider

3.7 服务发现

Nacos Discovery Starter默认集成了Ribbon，因此对于使用Ribbon进行负载平衡的组件，您可以直接使用Nacos服务发现。

NacosServerList实现com.netflix.loadbalancer.ServerList接口并在@ConditionOnMissingBean下自动注入它。

使用RestTemplate和FeignClient

1. 添加@LoadBlanced注释以使Ribbon可以访问RestTemplate

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
          
        return new RestTemplate();
    }
   

2. FeignClient默认集成了功能区，显示了如何配置FeignClient。

    @FeignClient(name = "service-provider")
    public interface EchoService {
          
        @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
        String echo(@PathVariable("str") String str);
    }
   

   使用@FeignClient批注将EchoService接口包装为FeignClient，其属性名称对应于服务名称service-provider。

   方法的@RequestMapping注释echo将echo方法与URL对应/echo/{str}，@PathVariable注释映射{str}到strecho方法的参数的URL路径中。

3. 完成上述配置后，将它们注入TestController。

    @RestController
    public class TestController {
          
    
        @Autowired
        private RestTemplate restTemplate;
        @Autowired
        private EchoService echoService;
   
        //RestTemplate
        @RequestMapping(value = "/echo-rest/{str}", method = RequestMethod.GET)
        public String rest(@PathVariable String str) {
          
            return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);
        }
        //FeignClient
        @RequestMapping(value = "/echo-feign/{str}", method = RequestMethod.GET)
        public String feign(@PathVariable String str) {
          
            return echoService.echo(str);
        }
    }
   

4. 添加application.properties配置

    spring.application.name=service-consumer
    server.port=18083
   

5. 运行

验证

1. http://127.0.0.1:18083/echo-rest/1234在浏览器地址栏中输入并单击转到，我们可以看到浏览器显示nacos-discovery-provider-example返回的消息“hello Nacos Discovery 1234”，以证明服务发现有效。
   

1. http://127.0.0.1:18083/echo-feign/12345在浏览器地址栏中输入并单击转到，我们可以看到浏览器显示nacos-discovery-provider-example返回的消息“hello Nacos Discovery 12345”，以证明服务发现有效。

3.8 原理

服务注册

在Spring云应用程序的启动阶段，将监视WebServerInitializedEvent事件。在初始化Web容器后收到WebServerInitializedEvent事件时，将触发注册操作，并调用ServiceRegistry注册方法以将服务注册到Nacos Server。

服务发现

NacosServerList实现com.netflix.loadbalancer.ServerList接口并在@ConditionOnMissingBean下自动注入它。功能区默认为集成。

端点

Nacos Discovery Starter还支持Spring Boot执行器端点的实现。

先决条件：

将依赖spring-boot-starter-actuator添加到pom.xml文件中，并配置端点安全策略。

Spring Boot 1.x：添加配置management.security.enabled = false

Spring Boot 2.x：添加配置management.endpoints.web.exposure.include = *

要查看端点信息，请访问以下URL：

Spring Boot1.x：Nacos Discovery端点URL是http://127.0.0.1:18083/nacos_discovery。

Spring Boot2.x：Nacos Discovery端点URL是http://127.0.0.1:18083/actuator/nacos-discovery。

3.9 更多

配置项	键	默认值	描述
服务器地址	spring.cloud.nacos.discovery.server-addr		nacos注册中心地址
服务名	spring.cloud.nacos.discovery.service	spring.application.name	服务名
权重	spring.cloud.nacos.discovery.weight	1	值从1到100，值越大，重量越大
IP	spring.cloud.nacos.discovery.ip		ip address to registry，最高优先级
网络接口	spring.cloud.nacos.discovery.network-interface		未配置IP时，注册的IP地址为网络接口对应的IP地址。如果未配置此项，则默认采用第一个网络接口的地址。
端口	spring.cloud.nacos.discovery.port	-1	注册端口，无需配置即可自动检测
namesapce	spring.cloud.nacos.discovery.namespace		开发环境（dev、pro等）
accesskey	spring.cloud.nacos.discovery.access-key
secretkey	spring.cloud.nacos.discovery.secret-key
元数据	spring.cloud.nacos.discovery.metadata		扩展数据，使用Map格式配置
日志名称	spring.cloud.nacos.discovery.log-name
端点	spring.cloud.nacos.discovery.endpoint		服务的域名，通过该域名可以动态获取服务器地址。
集成功能区	ribbon.nacos.enabled	true