【Nacos系列第一篇】-Nacos之Spring Discovery

╰半橙微兮° 2022-04-23 00:32 240阅读 0赞

## 前言 ##

作者：毕来生 微信：878799579

原文链接：[https://mp.weixin.qq.com/s/whpTlpYLykw8SNOoSKrqlw][https_mp.weixin.qq.com_s_whpTlpYLykw8SNOoSKrqlw]

个人比较看好Spring Cloud Alibaba家族。此系列以Nacos为主题，从Spring、Spring boot、Spring Cloud多个方面逐步进行演示，源码解读。目前来看官方文档还有待完善。网络上除了官网外缺少Nacos系列文章。都是零零散散的知识点。如此系列文章哪里写的有不周全，错误之处。欢迎大家指正。谢谢。

## 正文 ##

### 1、Nacos是什么？ ###

> 来自官网提供Nacos说明
> 
> 服务（Service）是 Nacos 世界的一等公民。Nacos 支持几乎所有主流类型的“服务”的发现、配置和管理：
> 
> Kubernetes Service
> 
> gRPC & Dubbo RPC Service
> 
> Spring Cloud RESTful Service
> 
> Nacos 的关键特性包括一下等等:
> 
>  *  **服务发现和服务健康监测**
>  *  **动态配置服务**
>  *  **动态 DNS 服务**
>  *  **服务及其元数据管理**

### Nacos架构图 ###

![640_wx_fmt_jpeg][]

### 2、准备工作 ###

工具：IDEA2018.3 、JDK： 1.8、Maven:3.5（通用配置。后续不在提及此部分。均已此版本演示）

Nacos：0.7.0(写此文章时最新版本，如后续更新。以最新版本给大家演示)

环境：Windows（演示用，后续更新完成后会有一章在linux下演示。有坑，但原理一样。不多赘述。）

Nacos稳定版本：https://github.com/alibaba/nacos/releases

Linux下请下载tar后解压。Windows下请下载zip。

1.  ` unzip nacos-server-$version.zip 或者 tar -xvf nacos-server-$version.tar.gz`

下载后启动Nacos。Nacos默认启动端口为8848，意为珠穆朗玛峰高度。如启动有端口冲突，请自行调整端口。

### 3、工程结构 ###

上面说了那么多，现在先整理来看一下我们的工程结构

![640_wx_fmt_png][]

附上关键部分代码。

NacosConfiguration

package org.nacos.spring;
    import com.alibaba.nacos.api.annotation.NacosProperties;
    import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
    import com.alibaba.nacos.spring.context.annotation.discovery.EnableNacosDiscovery;
    import org.springframework.beans.factory.annotation.Configurable;
    /**
    * @Author: bilaisheng
    * @Wechat: 878799579
    * @Date: 2019/1/13 19:28
    * @Todo: NacosConfiguration,用以注册以及测试Service Name ： nacos-spring
    * @Version : JDK8 , IDEA2018
    */
    
    @Configurable
    @EnableNacosConfig(globalProperties = @NacosProperties(serverAddr = "127.0.0.1:8848"))
    @NacosPropertySource(dataId = "nacos-spring", autoRefreshed = true)
    public class NacosConfiguration {
    }

*  `@EnableNacosConfig` 注解启用 Nacos Spring 的配置管理服务。
 *  @NacosPropertySource `加载了`dataId `为`nacos-spring\`的配置源，并开启自动更新。
 *  对 Nacos Spring 的用户来说，在自身应用中就只是设置 “autoRefreshed” 的一个布尔值。然后在需要修改配置的时候，调用 Nacos 修改配置的接口，或使用 Nacos 的控制台去修改，配置发生变更后， Nacos 就会把最新的配置推送到该应用的所有机器上。

NacosDiscoveryController

package org.nacos.spring.controller;
    import com.alibaba.nacos.api.annotation.NacosInjected;
    import com.alibaba.nacos.api.config.annotation.NacosValue;
    import com.alibaba.nacos.api.exception.NacosException;
    import com.alibaba.nacos.api.naming.NamingService;
    import com.alibaba.nacos.api.naming.pojo.Instance;
    import com.alibaba.nacos.spring.context.annotation.discovery.EnableNacosDiscovery;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.ResponseBody;
    import java.util.Date;
    import java.util.List;
    import static org.springframework.web.bind.annotation.RequestMethod.GET;
    
    /**
    * @Author: bilaisheng
    * @Wechat: 878799579
    * @Date: 2019/1/13 19:29
    * @Todo: NacosDisCoveryTest
    * @Version : JDK8 , IDEA2018
    */
    
    @Controller
    @RequestMapping("nacos")
    public class NacosDiscoveryController {
       @NacosInjected
       private NamingService namingService;
       @NacosValue(value = "${useLocalCache:false}", autoRefreshed = true)
       private boolean useLocalCache;
    
    
       @RequestMapping("/{str}")
       public String helloNacos(@PathVariable String str){
           return new Date() + "Hello Nacos " + str;
       }
    
    
       @RequestMapping("/instance")
       @ResponseBody
       public List<Instance> getInstance(@PathVariable  String serviceName) throws NacosException {
           return namingService.getAllInstances(serviceName);
       }
    
    
       @RequestMapping(value = "/get", method = GET)
       @ResponseBody
       public boolean get() {
           return useLocalCache;
       }
    }

此文件为普通Spring映射控制器，话说Nacos Spring还是小马哥@mercyblitz亲自操刀。大家可以不用怀疑质量啦。相信很多同学都快被小马哥逼的要劝退了。

着重说明一下，这个也是Nacos中常用的方法之一。

@RequestMapping("/instance")
    @ResponseBody
       public List<Instance> getInstance(@PathVariable  String serviceName) throws NacosException {
           return namingService.getAllInstances(serviceName);
       }

> 获取全部实例

List<Instance> getAllInstances(String serviceName) throws NacosException;
    List<Instance> getAllInstances(String serviceName, List<String> clusters) throws NacosException;

请求参数

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>serviceName</td> 
   <td>字符串</td> 
   <td>服务名</td> 
  </tr> 
  <tr> 
   <td>clusters</td> 
   <td>List</td> 
   <td>集群列表</td> 
  </tr> 
 </tbody> 
</table>

返回参数

List 实例列表。

> **获取配置**

描述

用于服务启动的时候从 Nacos 获取配置。

public String getConfig(String dataId, String group, long timeoutMs) throws NacosException

请求参数

<table> 
 <thead> 
  <tr> 
   <th>参数名</th> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>dataId</td> 
   <td>string</td> 
   <td>配置 ID，采用类似 package.class（如com.taobao.tc.refund.log.level）的命名规则保证全局唯一性，class 部分建议是配置的业务含义。全部字符小写。只允许英文字符和 4 种特殊字符（"."、":"、"-"、"_"），不超过 256 字节。</td> 
  </tr> 
  <tr> 
   <td>group</td> 
   <td>string</td> 
   <td>配置分组，建议填写产品名:模块名（Nacos:Test）保证唯一性，只允许英文字符和4种特殊字符（"."、":"、"-"、"_"），不超过128字节。</td> 
  </tr> 
  <tr> 
   <td>timeout</td> 
   <td>long</td> 
   <td>读取配置超时时间，单位 ms，推荐值 3000。</td> 
  </tr> 
 </tbody> 
</table>

返回值

<table> 
 <thead> 
  <tr> 
   <th>参数类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>string</td> 
   <td>配置值</td> 
  </tr> 
 </tbody> 
</table>

请求示例

try {
       String serverAddr = "{serverAddr}";
       String dataId = "{dataId}";
       String group = "{group}";
       Properties properties = new Properties();
       properties.put("serverAddr", serverAddr);
       ConfigService configService = NacosFactory.createConfigService(properties);
       String content = configService.getConfig(dataId, group, 5000);
       System.out.println(content);
    } catch (NacosException e) {
       // TODO Auto-generated catch block
       e.printStackTrace();
    }

上述两个文件中关于Nacos使用，请参考官网NacosSDK。里面详细标注了每个方法以及对应参数以及测试案例。

父pom.xml

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.bilaisheng.nacos</groupId>
     <artifactId>nacos-spring-examples</artifactId>
     <packaging>pom</packaging>
     <version>1.0-SNAPSHOT</version>
     <modules>
       <module>nacos-spring-discvoery</module>
     </modules>
     <name>nacos-spring-examples</name>
     <properties>
       <maven.compiler.source>1.8</maven.compiler.source>
       <maven.compiler.target>1.8</maven.compiler.target>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <spring.framework.version>5.1.3.RELEASE</spring.framework.version>
       <servlet-api.version>4.0.1</servlet-api.version>
       <nacos-spring-context.version>0.2.2-RC1</nacos-spring-context.version>
     </properties>
     <dependencyManagement>
       <dependencies>
         
         <dependency>
           <groupId>javax.servlet</groupId>
           <artifactId>javax.servlet-api</artifactId>
           <version>${servlet-api.version}</version>
           <scope>provided</scope>
         </dependency>
    
         
         <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-core</artifactId>
           <version>${spring.framework.version}</version>
         </dependency>
    
         
         <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-context</artifactId>
           <version>${spring.framework.version}</version>
         </dependency>
    
         
         <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-webmvc</artifactId>
           <version>${spring.framework.version}</version>
         </dependency>
    
         
         <dependency>
           <groupId>com.alibaba.nacos</groupId>
           <artifactId>nacos-spring-context</artifactId>
           <version>${nacos-spring-context.version}</version>
         </dependency>
       </dependencies>
     </dependencyManagement>
    </project>

**本工程pom.xml**

1.   
    
        <?xml version="1.0" encoding="UTF-8"?>
        <project xmlns="http://maven.apache.org/POM/4.0.0"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
           <parent>
               <artifactId>nacos-spring-examples</artifactId>
               <groupId>org.bilaisheng.nacos</groupId>
               <version>1.0-SNAPSHOT</version>
           </parent>
           <modelVersion>4.0.0</modelVersion>
           <artifactId>nacos-spring-discvoery</artifactId>
           <dependencies>
               
               <dependency>
                   <groupId>javax.servlet</groupId>
                   <artifactId>javax.servlet-api</artifactId>
               </dependency>
        
               
               <dependency>
                   <groupId>org.springframework</groupId>
                   <artifactId>spring-webmvc</artifactId>
               </dependency>
        
               
               <dependency>
                   <groupId>com.alibaba.nacos</groupId>
                   <artifactId>nacos-spring-context</artifactId>
               </dependency>
           </dependencies>
        </project>

页面请求

页面请求同普通Spring相同，启动后根据http://ip:端口/controller/xxx。

[https_mp.weixin.qq.com_s_whpTlpYLykw8SNOoSKrqlw]: https://mp.weixin.qq.com/s/whpTlpYLykw8SNOoSKrqlw
[640_wx_fmt_jpeg]: /images/20220325/83ee9dc3fc68417eb39cd54f68f3b50b.png
[640_wx_fmt_png]: /images/20220325/3b22eb7450bb499f84003035c7c29651.png