【SpringCloud】之 Nacos 组件

深藏阁楼爱情的钟 2022-12-11 02:21 182阅读 0赞

# 一、Nacos 注册中心 #

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

#### 1、下载 Nacos 注册服务 ####

Nacos 服务可以在官网中进行下载：[https://github.com/alibaba/nacos/releases][https_github.com_alibaba_nacos_releases]，一般选择下载 `nacos-server-xxx.zip`，Nacos 既可以在 Windows 中运行也可以在 Linux 中运行，在 bin 目录中提供了两种运行方式：

*  **startup.cmd**：运行在 Windows 上的 Nocos 启动脚本
 *  **shutdown.cmd**：运行在 Windows 的 Nocos 停止脚本
 *  **startup.sh**：运行在 Linux 上的 Nocos 启动脚本
 *  **shutdown.sh**：运行在 Linux 的 Nocos 停止脚本

#### 2、启动 Nacos 注册服务 ####

*  Windows 操作系统，执行命令
    
        cmd startup.cmd
 *  Linux/Unix/Mac 操作系统，执行命令
    
        sh startup.sh -m standalone

#### 3、项目中接入 Nacos ####

首先，修改 pom.xml 文件，引入 Nacos Discovery Starter 依赖：

<dependencies>
        
        <dependency>
             <groupId>com.alibaba.cloud</groupId>
             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
         </dependency>
    </dependencies>
    
    <dependencyManagement>
        
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-alibaba-dependencies</artifactId>
            <version>2.1.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencyManagement>

在应用的 `/src/main/resources/application.properties` 配置文件中配置 Nacos Server 地址：

# 注意这里是 discovery
     spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

使用 `@EnableDiscoveryClient` 注解开启服务注册与发现功能：

@SpringBootApplication
     @EnableDiscoveryClient
     public class ProviderApplication { 
     	public static void main(String[] args) { 
     		SpringApplication.run(ProviderApplication.class, args);
     	}
     }

注意：要成功使用服务发现，必须为每个服务起一个服务名称：

spring.application.name=server-name

#### 4、服务发现 ####

**集成 Ribbon**

为了便于使用，NacosServerList 实现了 com.netflix.loadbalancer.ServerList 接口，并在 @ConditionOnMissingBean 的条件下进行自动注入，如果有定制化的需求，可以自己实现自己的 ServerList。

Nacos Discovery Starter 默认集成了 Ribbon ，所以对于使用了 Ribbon 做负载均衡的组件，可以直接使用 Nacos 的服务发现。

**使用 RestTemplate**

添加 @LoadBlanced 注解，使得 RestTemplate 接入 Ribbon：

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

**配置 FeignClient**

Feign 模块使用的是 OpenFeign：

<dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
        <version>Hoxton.SR8</version>
    </dependency>

FeignClient 的声明使用的是 `@FeignClient` 注解：

@FeignClient(name = "service-provider")
    public interface EchoService { 
        @GetMapping(value = "/echo/{str}")
        String echo(@PathVariable("str") String str);
    }

使用 @FeignClient 注解修饰的接口类会被包装成一个 Feign 客户端：

*  属性 name 声明指定要调用的服务名称，这个服务名称为 Nacos 注册中心所注册的服务名称
 *  `@PathVariable` 注解将 URL 路径中的 `{str}` 对应成方法的参数 `str`
 *  `@GetMapping` 上的请求路径要写完整的请求地址，而非调用服务所对应接口函数上的简写请求地址

**开启服务发现**

想要开启服务发现功能，需要在 SpringBootApplication 中添加 `@EnableFeignClients(basePackages = "FeignClient 所在的包路径")` 注解，这样就能扫描所有标有 `@FeignClient` 注解的 Feign 客户端。

服务调用方法为：创建 FeignClient 接口类的对象，然后调用其中的方法即可：

@Autowired
    private EchoService echoService;
    
    @Test
    public void test() { 
        String str = echoService.echo("Hello Nacos!");
        System.out.println(str);
    }

# 二、Nacos 配置中心 #

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

Nacos 除了可以作为微服务注册和发现中心，以及拥有远程服务调用功能之外，还可以作为配置中心统一管理配置。

### 接入 Nacos 配置服务步骤如下： ###

**1、引入依赖**

修改 pom.xml 文件，引入 Nacos Config Starter：

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

**2、配置 Nacos Config 元数据**

要配置 Nacos Config 元数据，需要在微服务模块的 `resource/` 下创建 `bootstrap.properties（bootstrap.yml）` 配置文件，SpringBoot 工程的配置文件加载顺序如下：

1.  检查 resource 下是否含有 bootstrap.properties（bootstrap.yml） 配置文件，如果有则优先使用 bootstrap.properties 中的配置数据
2.  然后加载 application.properties（application.yml）配置文件中的配置数据
3.  如果 application.properties 中使用了 `spring.profiles.active=dev/prod/test`则加载对应的 application-dev.properties、application-prod.properties、application-test.properties 配置文件中的配置数据

配置中心加载的元数据需要放在 `bootstrap.properties（bootstrap.yml）` 配置文件中，下面我们以 `properties` 形式创建该文件并添加如下元数据：

# 设置 Nacos 配置服务名
    spring.application.name=myservice
    
    # 设置 Nacos 配置服务器地址：注意这里是 config
    spring.cloud.nacos.config.server-addr=127.0.0.1:8848

**3、在 Nacos 配置服务中心添加对应的配置文件**

进入 nacos 控制台页面，在**配置管理**下的**配置列表**页面右侧点击 `+` 号添加配置文件。

在新建配置页面中我们需要输入 Data ID，其内容为 bootstrap.properties 配置中设置的服务名 + `.properties`，比如，服务名设置为：spring.application.name=myservice，则 Data ID 的内容为：myservice.properties。描述可以自由填写，配置格式我们选择 Properties。

配置内容则填写你需要写在 Nacos 配置中心的配置数据，这里有个优先顺序的规则需要注意：**如果 Nacos 配置中心和当前应用的配置文件中都配置了相同的项时，会优先使用 Nacos 配置中心的配置项**。

**4、加载和使用配置内容**

完成上述配置步骤之后，应用启动时会从 Nacos Config 配置中心获取相应的配置，并添加在 Spring Environment 的 PropertySources 中。

我们可以使用 **@Value** 注解来将对应的配置内容注入到属性当中，同时使用 **@RefreshScope** 注解来打开动态刷新功能，只要配置中心的内容发生了变化，那么相应的属性值也会跟着发生动态改变：

@RefreshScope	// 动态刷新
     class SampleController { 
    
     	@Value("${user.name}")
     	String userName;
    
     	@Value("${user.age}")
     	int age;
     }

# 三、Nacos 命名空间与配置策略 #

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

### 命名空间 ###

Nacos 命名空间的作用是实现配置隔离，比如开发环境、测试环境和生产环境各自独立使用一个命名空间的配置，这样就可以实现各种环境之间的配置互不干扰。

Nacos 命名空间默认使用 public（保留空间），默认新增的所有配置都在 public 空间。添加命名空间步骤如下：

1.  进入 Nacos 控制台页面，点击`命名空间`切换到命名空间页面，页面中展示了所有命名空间列表
2.  点击右上角的`新增命名空间`按钮
3.  填写`命名空间名`和`描述`即可（命名空间ID自动生成），比如，命名空间名：dev ，描述：开发环境，点击确定即可保存

添加命名空间成功后可以在`配置列表`页面顶部看到刚添加成功的命名空间，点击即可切换命名空间。

想要加载指定的命名空间上的配置，需要在 bootstrap.properties 配置文件上设置要加载的命名空间的 `命名空间ID` 值：

# 填写命名空间对应的 命名空间ID
    spring.cloud.nacos.config.namespace=7fb4b12f-4b23-49ab-a800-d3aa03da3250

当然，除了按照开发环境来做配置隔离之外，还可以做成微服务之间的配置隔离，具体做法就是为每个微服务创建自己的命名空间，然后在配置文件中填写自己命名空间的`命名空间ID`，这样就只加载自己命名空间下的配置。

### 配置分组 ###