Nacos注册中心Day03-Spring集成Nacos

曾经终败给现在 2022-11-29 11:58 192阅读 0赞

### Spring集成Nacos ###

*  基本介绍
 *  配置
 *   *  多配置文件支持
     *  @ConfigurationProperties的prefix支持
     *  自定义配置文件类型解析
 *  配置管理
 *  服务发现与注册

# 基本介绍 #

*  **Spring**集成**Nacos**之前需要下载**Nacos**并启动**Nacos server**
 *  通过**Nacos server**和**Nacos Spring**配置管理模块,实现配置的动态变更
 *  通过**Nacos server**和**Nacos Spring**服务发现模块,实现服务的注册与发现

# 配置 #

## 多配置文件支持 ##

*  支持的配置文件类型 **: properties, yaml, json, xml**
 *  **@NacosPropertySource**中通过设置**type**参数配置文件类型,参数为**ConfigType**枚举类:

@NacosPropertySource(dataId = { data-id}, autoRefreshed = true, type = ConfigType.YAML)

*  **@NacosConfigurationProperties**通过设置**type**参数配置文件类型,参数为**ConfigType**枚举类:

@NacosConfigurationProperties(dataId = { data-id}, autoRefreshed = true, ignoreNestedProperties = true, type = ConfigType.YAML)

## @ConfigurationProperties的prefix支持 ##

*  **@NacosConfigurationProperties**配置**prefix**参数:

@NacosConfigurationProperties(prefix = "test", dataId = DATA_ID, groupId = GROUP_ID, autoRefreshed = true, ignoreNestedProperties = true)

## 自定义配置文件类型解析 ##

*  **nacos-spring-project**采用了可扩展模式,支持用户实现配置文件解析规则自定义实现,分为:
    
     *  **全局作用**
     *  **针对某一配置文件作用**
 *  **自定义配置文件:**
    
     *  继承抽象类**AbstractConfigParse**
     *  重写方法**Properties parse(String configText)** 以及**String processType()** 方法实现针对某一配置类型的文件解析
     *  设定作用范围:
        
         *  如果作用于全局,则使用默认配置,不需要其余操作
         *  如果作用于某一配置文件,需要重写**String dataId()** 和**String group()** 方法
     *  最后在**resources/META-INF**文件夹下创建**services**文件夹,创建**com.alibaba.nacos.spring.util.ConfigParse**文件,内容为实现的**AbstractConfigParse**类路径

# 配置管理 #

*  启动**Nacos server**后,为**Spring**应用启动**Nacos**配置管理服务
 *  **添加nacos-spring-context依赖:**

<dependency>
        <groupId>com.alibaba.nacos</groupId>
        <artifactId>nacos-spring-context</artifactId>
        <version>0.3.6</version>
    </dependency>

*  **启用Nacos Spring的配置管理服务:**
    
     *  添加 **@EnableNacosConfig**注解
     *  使用 **@NacosPropertySource**加载**dataId**为**nacosConfigs**的配置源,并开启自动更新

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

*  **设置Nacos属性值:** 通过**Nacos**的 **@NacosValue**注解设置属性值

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

*  **获取配置信息:**
    
     *  启动**Tomcat,** 调用**curl http://localhost:8080/config/get**尝试获取配置信息
     *  由于此时还未发布过配置,所以返回内容是**false**
 *  **发布配置信息:**
    
     *  通过调用**Nacos Open API**向**Nacos Server**发布配置
        
         *  **dataId**为**nacosConfigs**
         *  内容为**useLocalCache=true**

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

*  **获取动态变更的配置信息:**
    
     *  再次调用**curl http://localhost:8080/config/get**获取配置信息
     *  此时返回内容为**true,** 说明程序中的**useLocalCache**值已经被动态更新

# 服务发现与注册 #

*  **添加nacos-spring-context依赖:**

<dependency>
        <groupId>com.alibaba.nacos</groupId>
        <artifactId>nacos-spring-context</artifactId>
        <version>0.3.6</version>
    </dependency>

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

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

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

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

*  **获取服务实例,发现服务:**
    
     *  启动**Tomcat,** 调用**curl http://localhost:8080/discovery/get?serviceName=namingService.** 此时返回空**JSON**数组
 *  **注册服务:**
    
     *  通过**Nacos Open API**向**Nacos server**注册一个名为**namingService**服务

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=namingService,** 返回服务实例内容:

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