nacos入门使用

分手后的思念是犯贱 2023-09-24 21:06 73阅读 0赞

![2f9fcf5e0f51424a94cb3f1281ba2927.png][]

> Nacos除了可以做注册中心，同样可以做配置管理来使用。

## 一.安装nacos ##

[Linux安装nacos][Linux_nacos]

## 二. 服务注册中心 ##

### 2.1服务注册到nacos ###

#### 2.1.1 引入依赖 ####

在父工程的pom文件中的<dependencyManagement>中引入SpringCloudAlibaba的依赖：

<dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-alibaba-dependencies</artifactId>
        <version>2.2.6.RELEASE</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>

然后在子工程中的pom文件中引入nacos-discovery客户端 依赖：

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

#### 2.1.2 配置nacos地址（配置文件） ####

在子工程的application.yml中添加nacos地址：

spring:
      cloud:
        nacos:
          server-addr: localhost:8848

#### 2.1.3 重启 ####

重启微服务后，登录nacos管理页面，可以看到微服务信息：

![4ef0cc064dbf29878358f9d7a2a8caeb.png][]

### 2.2**服务分级存储模型** ###

一个**服务**可以有多个**实例**，例如我们的user-service，可以有:

*  127.0.0.1:8081

*  127.0.0.1:8082

*  127.0.0.1:8083

假如这些实例分布于全国各地的不同机房，例如：

*  127.0.0.1:8081，在上海机房

*  127.0.0.1:8082，在上海机房

*  127.0.0.1:8083，在杭州机房

Nacos就将同一机房内的实例 划分为一个**集群**。

也就是说，user-service是服务，一个服务可以包含多个集群，如杭州、上海，每个集群下可以有多个实例，形成分级模型，如图：

![f158bca3f736d6754820e1eb2533366d.png][]

微服务互相访问时，应该尽可能访问同集群实例，因为本地访问速度更快。当本集群内不可用时，才访问其它集群。例如：

![23032003498530cf5dad714a6d623ec4.png][]

杭州机房内的order-service应该优先访问同机房的user-service。

#### **2.2.1给user-service配置集群** ####

修改user-service的application.yml文件，添加集群配置：

spring:
      cloud:
        nacos:
          server-addr: localhost:8848
          discovery:
            cluster-name: HZ # 集群名称

重启两个user-service实例后，我们可以在nacos控制台看到下面结果：

![607ced24869c585b8eee2e934e55f7b6.png][]

我们再次复制一个user-service启动配置，添加属性：

> \-Dserver.port=8083 -Dspring.cloud.nacos.discovery.cluster-name=SH

配置如图所示：

![990499a22e699a69aa3af8e54c2646a5.png][]

启动UserApplication3后再次查看nacos控制台：

![378abc5423a356395db3df74dce4e5ed.png][]

#### **2.2.2同集群优先的负载均衡** ####

默认的ZoneAvoidanceRule并不能实现根据同集群优先来实现负载均衡。

因此Nacos中提供了一个NacosRule的实现，可以优先从同集群中挑选实例。

1）给order-service配置集群信息

修改order-service的application.yml文件，添加集群配置：

spring:
      cloud:
        nacos:
          server-addr: localhost:8848
          discovery:
            cluster-name: HZ # 集群名称

2）修改负载均衡规则

修改order-service的application.yml文件，修改负载均衡规则：

userservice:
      ribbon:
        NFLoadBalancerRuleClassName: com.alibaba.cloud.nacos.ribbon.NacosRule # 负载均衡规则

#### 2.2.3 **权重配置** ####

实际部署中会出现这样的场景：

服务器设备性能有差异，部分实例所在机器性能较好，另一些较差，我们希望性能好的机器承担更多的用户请求。

但默认情况下NacosRule是同集群内随机挑选，不会考虑机器的性能问题。

因此，Nacos提供了权重配置来控制访问频率，权重越大则访问频率越高。

在nacos控制台，找到user-service的实例列表，点击编辑，即可修改权重：

![932c7e9b286a8592944a84363a0c7e31.png][]

在弹出的编辑窗口，修改权重：

![a52396a19e40cf95753edb15ea0500d2.png][]

**注意**：如果权重修改为0，则该实例永远不会被访问

### 2.3 环境隔离（namespace） ###

Nacos提供了namespace来实现环境隔离功能。

*  nacos中可以有多个namespace

*  namespace下可以有group、service等

*  不同namespace之间相互隔离，例如不同namespace的服务互相不可见

![63d74d4eab53837359437be8f26c323f.png][]

#### **2.3.1创建namespace** ####

默认情况下，所有service、data、group都在同一个namespace，名为public：

![0e8dc4dfed4badb0b516371b9fb26671.png][]

我们可以点击页面新增按钮，添加一个namespace：

![8f7aaca6eb556f82cf541f4e58909b8a.png][]

然后，填写表单：

![1eaef9038512c621a03129e1d4cfea00.png][]

就能在页面看到一个新的namespace：

![df10d073041d1be29e9e45ac99f99914.png][]

#### **2.3.2给微服务配置namespace** ####

给微服务配置namespace只能通过修改配置来实现。

例如，修改order-service的application.yml文件：

spring:
      cloud:
        nacos:
          server-addr: localhost:8848
          discovery:
            cluster-name: HZ
            namespace: 492a7d5d-237b-46a1-a99a-fa8e98e4b0f9 # 命名空间，填ID

重启order-service后，访问控制台，可以看到下面的结果：

public下已经没有orderservice服务了

![997dace0de382b2a9d99ae84e9e10d18.png][]

而出现在了dev下

![24aa0763e0c5857e6a0b619e6449ba63.png][]

此时访问order-service，因为namespace不同，会导致找不到userservice，控制台会报错：

![28c4c3d91699cd5f49290a59b919a839.png][]

## 二. 统一配置中心 ##

### 2.1 统一配置管理 ###

当微服务部署的实例越来越多，达到数十、数百时，逐个修改微服务配置就会让人抓狂，而且很容易出错。我们需要一种统一配置管理方案，可以集中管理所有实例的配置。

![620ef754027f7d70af0b91be7ab44cac.png][]

Nacos一方面可以将配置集中管理，另一方可以在配置变更时，及时通知微服务，实现配置的热更新。

#### **2.1在nacos中添加配置文件** ####

如何在nacos中管理配置呢？

![0dfa6144752a53301d50a2f0246a439b.png][]

然后在弹出的表单中，填写配置信息：

![3d9c4d6529f45731299ccd94a75fd669.png][]

> 注意：项目的核心配置，需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

#### **2.2从微服务拉取配置** ####

微服务要拉取nacos中管理的配置，并且与本地的application.yml配置合并，才能完成项目启动。

但如果尚未读取application.yml，又如何得知nacos地址呢？

因此spring引入了一种新的配置文件：bootstrap.yaml文件，会在application.yml之前被读取，流程如下：

![83fce6bba6ed52cccd3dae3235394194.png][]

##### 2.2.1 引入依赖 #####

首先，在user-service服务中，引入nacos-config的客户端依赖：

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

##### 2.2.2 添加bootstrap.yaml #####

然后，在user-service中添加一个bootstrap.yaml文件，内容如下：

spring:
      application:
        name: userservice # 服务名称
      profiles:
        active: dev #开发环境，这里是dev 
      cloud:
        nacos:
          server-addr: localhost:8848 # Nacos地址
          config:
            file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址，再根据

$\{spring.application.name\}-$\{spring.profiles.active\}.$\{spring.cloud.nacos.config.file-extension\}作为文件id，来读取配置。

本例中，就是去读取userservice-dev.yaml：

![466caf4494026a43e2fd70ec1c1a3ff3.png][]

##### 2.2.3 读取nacos配置 #####

在user-service中的UserController中添加业务逻辑，读取pattern.dateformat配置：

![71019c726392cdce2cd8aa27434200c6.png][]

完整代码：

package cn.itcast.user.web;
    
    import cn.itcast.user.pojo.User;
    import cn.itcast.user.service.UserService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.web.bind.annotation.*;
    
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    @Slf4j
    @RestController
    @RequestMapping("/user")
    public class UserController {
    
        @Autowired
        private UserService userService;
    
        @Value("${pattern.dateformat}")
        private String dateformat;
        
        @GetMapping("now")
        public String now(){
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat));
        }
        // ...略
    }

##### 2.2.4 在页面访问 #####

可以看到效果：

![f4b88bfd90bfff314beea58114202fbf.png][]

#### 2.3 **配置热更新** ####

我们最终的目的，是修改nacos中的配置后，微服务中无需重启即可让配置生效，也就是**配置热更新**。

要实现配置热更新，可以使用两种方式：

##### 2.3.1 方式一 #####

在@Value注入的变量所在类上添加注解@RefreshScope：

![322f1e5131b02fad05ac1360f25c92be.png][]

##### 2.3.2 方式二 #####

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中，添加一个类，读取patterrn.dateformat属性：

packagecn.itcast.user.config;
    
    importlombok.Data;
    importorg.springframework.boot.context.properties.ConfigurationProperties;
    importorg.springframework.stereotype.Component;
    
    @Component
    @Data
    @ConfigurationProperties(prefix="pattern")
    publicclassPatternProperties {
        privateStringdateformat;
    }

在UserController中使用这个类代替@Value：

![778920bf36e3dd50fdfc42a5b8b65eb1.png][]

完整代码：

package cn.itcast.user.web;
    
    import cn.itcast.user.config.PatternProperties;
    import cn.itcast.user.pojo.User;
    import cn.itcast.user.service.UserService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.time.LocalDateTime;
    import java.time.format.DateTimeFormatter;
    
    @Slf4j
    @RestController
    @RequestMapping("/user")
    public class UserController {
    
        @Autowired
        private UserService userService;
    
        @Autowired
        private PatternProperties patternProperties;
    
        @GetMapping("now")
        public String now(){
            return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat()));
        }
    
        // 略
    }

##### 2.3.4 总结 #####

![96b9664316c9618d2ea79441ea002845.png][]

#### 2.4 配置共享 ####

其实微服务启动时，会去nacos读取多个配置文件，例如：

*  \[spring.application.name\]-\[spring.profiles.active\].yaml，例如：userservice-dev.yaml

*  \[spring.application.name\].yaml，例如：userservice.yaml

而\[spring.application.name\].yaml不包含环境，因此可以被多个环境共享。

下面我们通过案例来测试配置共享

##### **2.4.1添加一个环境共享配置** #####

我们在nacos中添加一个userservice.yaml文件：

![6c2eda50a1c934262a3868d2b9e6f159.png][]

##### **2.4.2 在user-service中读取共享配置** #####

在user-service服务中，修改PatternProperties类，读取新添加的属性：

![9bcc020f4b42fc68e90e541f0a90c3e0.png][]

在user-service服务中，修改UserController，添加一个方法：

![353ef8be37c896afcc662cdc06a212f1.png][]

##### **2.4.3 运行两个UserApplication，使用不同的profile** #####

修改UserApplication2这个启动项，改变其profile值：

![b9737f2b1697f8784a07a69836afcad1.png][]

![1cd11bdec4f5941eeea17af64c416c9a.png][]

这样，UserApplication(8081)使用的profile是dev，UserApplication2(8082)使用的profile是test。

启动UserApplication和UserApplication2

访问[http://localhost:8081/user/prop][http_localhost_8081_user_prop]，结果：

![24641a130d83ba53102ffe20ba173fd5.png][]

访问[http://localhost:8082/user/prop][http_localhost_8082_user_prop]，结果：

![0deda42bc93ebae4ecce509e656124d7.png][]

可以看出来，不管是dev，还是test环境，都读取到了envSharedValue这个属性的值。

##### **2.4.4配置共享的优先级** #####

当nacos、服务本地同时出现相同属性时，优先级有高低之分：

![56ede1775d0ddb7a304ef2e262091868.png][]

##### 2.4.5 总结 #####

![3571e837e2f8f94c7ce34cecea626c3b.png][]

[2f9fcf5e0f51424a94cb3f1281ba2927.png]: https://img-blog.csdnimg.cn/img_convert/2f9fcf5e0f51424a94cb3f1281ba2927.png
[Linux_nacos]: https://blog.csdn.net/weixin_53604412/article/details/129274303?spm=1001.2014.3001.5502
[4ef0cc064dbf29878358f9d7a2a8caeb.png]: https://img-blog.csdnimg.cn/img_convert/4ef0cc064dbf29878358f9d7a2a8caeb.png
[f158bca3f736d6754820e1eb2533366d.png]: https://img-blog.csdnimg.cn/img_convert/f158bca3f736d6754820e1eb2533366d.png
[23032003498530cf5dad714a6d623ec4.png]: https://img-blog.csdnimg.cn/img_convert/23032003498530cf5dad714a6d623ec4.png
[607ced24869c585b8eee2e934e55f7b6.png]: https://img-blog.csdnimg.cn/img_convert/607ced24869c585b8eee2e934e55f7b6.png
[990499a22e699a69aa3af8e54c2646a5.png]: https://img-blog.csdnimg.cn/img_convert/990499a22e699a69aa3af8e54c2646a5.png
[378abc5423a356395db3df74dce4e5ed.png]: https://img-blog.csdnimg.cn/img_convert/378abc5423a356395db3df74dce4e5ed.png
[932c7e9b286a8592944a84363a0c7e31.png]: https://img-blog.csdnimg.cn/img_convert/932c7e9b286a8592944a84363a0c7e31.png
[a52396a19e40cf95753edb15ea0500d2.png]: https://img-blog.csdnimg.cn/img_convert/a52396a19e40cf95753edb15ea0500d2.png
[63d74d4eab53837359437be8f26c323f.png]: https://img-blog.csdnimg.cn/img_convert/63d74d4eab53837359437be8f26c323f.png
[0e8dc4dfed4badb0b516371b9fb26671.png]: https://img-blog.csdnimg.cn/img_convert/0e8dc4dfed4badb0b516371b9fb26671.png
[8f7aaca6eb556f82cf541f4e58909b8a.png]: https://img-blog.csdnimg.cn/img_convert/8f7aaca6eb556f82cf541f4e58909b8a.png
[1eaef9038512c621a03129e1d4cfea00.png]: https://img-blog.csdnimg.cn/img_convert/1eaef9038512c621a03129e1d4cfea00.png
[df10d073041d1be29e9e45ac99f99914.png]: https://img-blog.csdnimg.cn/img_convert/df10d073041d1be29e9e45ac99f99914.png
[997dace0de382b2a9d99ae84e9e10d18.png]: https://img-blog.csdnimg.cn/img_convert/997dace0de382b2a9d99ae84e9e10d18.png
[24aa0763e0c5857e6a0b619e6449ba63.png]: https://img-blog.csdnimg.cn/img_convert/24aa0763e0c5857e6a0b619e6449ba63.png
[28c4c3d91699cd5f49290a59b919a839.png]: https://img-blog.csdnimg.cn/img_convert/28c4c3d91699cd5f49290a59b919a839.png
[620ef754027f7d70af0b91be7ab44cac.png]: https://img-blog.csdnimg.cn/img_convert/620ef754027f7d70af0b91be7ab44cac.png
[0dfa6144752a53301d50a2f0246a439b.png]: https://img-blog.csdnimg.cn/img_convert/0dfa6144752a53301d50a2f0246a439b.png
[3d9c4d6529f45731299ccd94a75fd669.png]: https://img-blog.csdnimg.cn/img_convert/3d9c4d6529f45731299ccd94a75fd669.png
[83fce6bba6ed52cccd3dae3235394194.png]: https://img-blog.csdnimg.cn/img_convert/83fce6bba6ed52cccd3dae3235394194.png
[466caf4494026a43e2fd70ec1c1a3ff3.png]: https://img-blog.csdnimg.cn/img_convert/466caf4494026a43e2fd70ec1c1a3ff3.png
[71019c726392cdce2cd8aa27434200c6.png]: https://img-blog.csdnimg.cn/img_convert/71019c726392cdce2cd8aa27434200c6.png
[f4b88bfd90bfff314beea58114202fbf.png]: https://img-blog.csdnimg.cn/img_convert/f4b88bfd90bfff314beea58114202fbf.png
[322f1e5131b02fad05ac1360f25c92be.png]: https://img-blog.csdnimg.cn/img_convert/322f1e5131b02fad05ac1360f25c92be.png
[778920bf36e3dd50fdfc42a5b8b65eb1.png]: https://img-blog.csdnimg.cn/img_convert/778920bf36e3dd50fdfc42a5b8b65eb1.png
[96b9664316c9618d2ea79441ea002845.png]: https://img-blog.csdnimg.cn/img_convert/96b9664316c9618d2ea79441ea002845.png
[6c2eda50a1c934262a3868d2b9e6f159.png]: https://img-blog.csdnimg.cn/img_convert/6c2eda50a1c934262a3868d2b9e6f159.png
[9bcc020f4b42fc68e90e541f0a90c3e0.png]: https://img-blog.csdnimg.cn/img_convert/9bcc020f4b42fc68e90e541f0a90c3e0.png
[353ef8be37c896afcc662cdc06a212f1.png]: https://img-blog.csdnimg.cn/img_convert/353ef8be37c896afcc662cdc06a212f1.png
[b9737f2b1697f8784a07a69836afcad1.png]: https://img-blog.csdnimg.cn/img_convert/b9737f2b1697f8784a07a69836afcad1.png
[1cd11bdec4f5941eeea17af64c416c9a.png]: https://img-blog.csdnimg.cn/img_convert/1cd11bdec4f5941eeea17af64c416c9a.png
[http_localhost_8081_user_prop]: http://localhost:8081/user/prop
[24641a130d83ba53102ffe20ba173fd5.png]: https://img-blog.csdnimg.cn/img_convert/24641a130d83ba53102ffe20ba173fd5.png
[http_localhost_8082_user_prop]: http://localhost:8082/user/prop
[0deda42bc93ebae4ecce509e656124d7.png]: https://img-blog.csdnimg.cn/img_convert/0deda42bc93ebae4ecce509e656124d7.png
[56ede1775d0ddb7a304ef2e262091868.png]: https://img-blog.csdnimg.cn/img_convert/56ede1775d0ddb7a304ef2e262091868.png
[3571e837e2f8f94c7ce34cecea626c3b.png]: https://img-blog.csdnimg.cn/img_convert/3571e837e2f8f94c7ce34cecea626c3b.png