SpringCloud Nacos，SpringCloud Config学习笔记

最新推荐文章于 2025-02-21 15:16:26 发布

手揽回忆怎么睡

最新推荐文章于 2025-02-21 15:16:26 发布

阅读量341

点赞数 1

本文链接：https://blog.youkuaiyun.com/qq_38006148/article/details/119680650

版权

SpringCloud Alibaba 专栏收录该内容

3 篇文章

订阅专栏

中文文档
github地址
spring官方文档
中文就是好，中文就是棒(๑•̀ㅂ•́)و✧

Nacos：动态服务发现、配置管理和服务管理平台

Nacos官网，

为什么叫Nacos？
答：前四个字母分别为Naming和Configuration的前两个字母，最后的s为Service。

是什么？
答：Dynamic Naming and Configuration Service，一个更易于构建云原生应用的动态服务发现、配置管理和服务管理平台。等价于：Eureka+Config+Bus

能干嘛？
答：代替Eureka做服务注册中心，代替Config做服务配置中心

下载地址

一、Nacos启动

在这里插入图片描述

1、启动服务器：启动命令(standalone代表着单机模式运行，非集群模式):

// 单机模式运行
startup.cmd -m standalone
// 关闭服务
shutdown.cmd

在这里插入图片描述

访问地址，账号密码都是：nacos

http://127.0.0.1:8848/nacos/index.html

2、服务注册&发现和配置管理

服务注册

curl -X POST 'http://127.0.0.1:8848/nacos/v1/ns/instance?>serviceName=nacos.naming.serviceName&ip=20.18.7.10&port=8080'

服务发现

curl -X GET 'http://127.0.0.1:8848/nacos/v1/ns/instance/list?serviceName=nacos.naming.serviceName'

发布配置

curl -X POST "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test&content=HelloWorld"

获取配置

curl -X GET "http://127.0.0.1:8848/nacos/v1/cs/configs?dataId=nacos.cfg.dataId&group=test"

二、Nacos Spring Cloud启动发现

前提条件

您需要先下载 Nacos 并启动 Nacos server。

1、父工程pom添加依赖

Spring Cloud Alibaba Reference Documentation

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--定义父工程-->
    <groupId>com.hzl</groupId>
    <artifactId>cloud-alibaba</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>
    <name>cloud-alibaba</name>
    <description>Demo project for Spring Cloud</description>

    <!--jar版本统一管理-->
    <properties>
        <java.version>1.8</java.version>
        <spring-boot.version>2.5.3</spring-boot.version>
        <spring-cloud.version>2020.0.3</spring-cloud.version>
        <spring-cloud-alibaba.version>2021.1</spring-cloud-alibaba.version>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <hutool.version>5.7.7</hutool.version>
        <nacos.version>2.0.2</nacos.version>
    </properties>

    <dependencies>
        <!--Lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <scope>provided</scope>
        </dependency>
        <!--测试依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <!--声明依赖，定义父工程jar包依赖-->
    <dependencyManagement>
        <dependencies>
            <!-- spring boot 依赖 -->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- spring cloud 依赖 -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!-- spring cloud alibaba 依赖 -->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

注意：版本 2.1.x.RELEASE 对应的是 Spring Boot 2.1.x 版本。版本 2.0.x.RELEASE 对应的是 Spring Boot 2.0.x 版本，版本 1.5.x.RELEASE 对应的是 Spring Boot 1.5.x 版本。
版本对应关系参考

2、子模块服务提供者Provider，端口9001，9002，提供者一般是多个

在这里插入图片描述

2.1、pom文件

<?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>cloud-alibaba</artifactId>
        <groupId>com.hzl</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-alibaba-provider-9002</artifactId>

    <dependencies>
        <!--引入Nacos发现-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--监控-->
<!--        <dependency>-->
<!--            <groupId>org.springframework.boot</groupId>-->
<!--            <artifactId>spring-boot-starter-actuator</artifactId>-->
<!--        </dependency>-->
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

2.2、配置文件官网是application.properties，改成yml

server:
  port: 9001
spring:
  application:
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

#management:
#  endpoints:
#    web:
#      exposure:
#        include: '*'

2.3、启动类

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

2.4、 controller，读取配置端口，方便知道访问的是哪个Provider

@RestController
public class ProviderController {

    @Value("${server.port}")
    private String serverPost;

    @GetMapping("/provider/{string}")
    public String echo(@PathVariable String string) {
        return "Hello Nacos Discovery :" +serverPost + "，" + string;
    }
}

也可以直接拷贝虚拟端口映射服务提供者9003

虚拟参数
-DServer.port=9003
测试Provider
http://localhost:9003/provider/baba

`警告：要先启动Nacos，再启动应用程序，启动Nacos参考`Nacos官网

在这里插入图片描述

测试服务提供者：http://localhost:9001/provider/111111111

3、子模块服务消费者Consumer

访问报错、(•́へ•́╬)：springcloud nacos java.net.UnknownHostException:service-provider
我找不到原因、o(╥﹏╥)o
官方例子对比、(´థ౪థ)σ
服务提供者和消费者的服务发现是不同的依赖、꒰╬•᷅д•᷄╬꒱
老是错、o((⊙﹏⊙))o
又白忙活大半天、(｡•ˇ‸ˇ•｡)

3.1、pom文件

<?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>cloud-alibaba</artifactId>
        <groupId>com.hzl</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-alibaba-consumer</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>0.2.2.RELEASE</version>
            <exclusions>
                <exclusion>
                    <groupId>com.alibaba.nacos</groupId>
                    <artifactId>nacos-client</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>com.alibaba.nacos</groupId>
            <artifactId>nacos-client</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

3.2、application.yml

server:
  port: 80

spring:
  application:
    name: service-consumer
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

#management:
#  endpoints:
#    web:
#      exposure:
#        include: '*'

# 自定义服务地址配置
provider-url:
  nacos-user-service: http://service-provider

3.3、RestTemplate

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

3.4、启动类，启动测试服务发现

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

3.5、Controller

@RestController
public class ConsumerController {

    @Resource
    private RestTemplate restTemplate;

    @Value("${provider-url.nacos-user-service}")
    private String serviceUrl;

    @GetMapping("/provider/{str}")
    public String echo(@PathVariable String str) {
        return restTemplate.getForObject(serviceUrl + "/provider/" + str, String.class);
    }
}

测试服务消费者：http://localhost/provider/111111111

Nacos 支持AP和CP模式的切换

CAP原则又称CAP定理，指的是在一个分布式系统中，一致性（Consistency）、可用性（Availability）、分区容错性（Partition tolerance）。CAP 原则指的是，这三个要素最多只能同时实现两点，不可能三者兼顾。

C是所有节点在同一时间看到的数据是一致的；而A的定义是所有的请求都会收到响应。

何时选择使用何种模式？
一般来说，
如果不需要存储服务级别的信息且服务实例是通过nacos-client注册，并能够保持心跳上报，那么就可以选择AP模式。当前主流的服务如 Spring cloud 和 Dubbo 服务，都适用于AP模式，AP模式为了服务的可能性而减弱了一致性，因此AP模式下只支持注册临时实例。

如果需要在服务级别编辑或者存储配置信息，那么 CP 是必须，K8S服务和DNS服务则适用于CP模式。
CP模式下则支持注册持久化实例，此时则是以 Raft 协议为集群运行模式，该模式下注册实例之前必须先注册服务，如果服务不存在，则会返回错误

模式切换命令post
curl -X PUT '$NACOS_SERVER:8848/nacos/v1/ns/operator/switches?entry=serverMode&value=CP'

三、SpringCloud Config启动配置管理

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>cloud-alibaba</artifactId>
        <groupId>com.hzl</groupId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-alibaba-config-3377</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bootstrap</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>
</project>

2、配置application.yml，以及在 bootstrap.yml 中配置 Nacos server 的地址和应用名，（没有错，是`俩`）

在这里插入图片描述

spring:
  profiles:
    active: dev

server:
  port: 8080

spring:
  application:
    name: cloud-alibaba-config
  cloud:
    nacos:
      config:
        server-addr: 127.0.0.1:8848

说明（重要！）：

1.bootstrap.yml之所以需要配置 spring.application.name ，是因为它是构成 Nacos 配置管理 dataId字段的一部分。
2.在 Nacos Spring Cloud 中，dataId 的完整格式如下：
${prefix}-${spring.profiles.active}.${file-extension}
prefix 默认为 spring.application.name 的值，也可以通过配置项 spring.cloud.nacos.config.prefix来配置。
spring.profiles.active 即为当前环境对应的 profile，详情可以参考 Spring Boot文档。注意：当 spring.profiles.active 为空时，对应的连接符 - 也将不存在，dataId 的拼接格式变成 $ {prefix}.${file-extension}
file-exetension 为配置内容的数据格式，可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

3.启动类

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

4.通过 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新

@RestController
@RequestMapping("/config")
@RefreshScope
public class ConfigController {

    @Value("${useLocalCache:false}")
    private boolean useLocalCache;

    @RequestMapping("/get")
    public boolean get() {
        return useLocalCache;
    }
}

6.发布配置

API方式：通过调用 Nacos Open API 向 Nacos Server 发布配置：dataId 为example.yml，内容为useLocalCache=true

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

控制台方式（推荐，不容易写错）：

服务启动报错获取不到@Value，请仔细看上面的说明（重要！），Nacos的dataId组成包括spring.applicaiton.name

在这里插入图片描述

测试获取配置：http://localhost:8080/config/get

修改配置，Nacos自带动态刷新

四、Nacos作为配置中心-分类配置

1、命令空间(Namespace),配置管理的Data Id和Group

1.1、三者情况

最外层的namespace是可以用于区分部署环境的，Group和DataID逻辑上区分两个目标对象。

默认情况：
Namespace=public，Group=DEFAULT_GROUP, 默认Cluster是DEFAULT
Nacos默认的命名空间是public，Namespace主要用来实现隔离。
比方说我们现在有三个环境：开发、测试、生产环境，我们就可以创建三个Namespace，不同的Namespace之间是隔离的。
Group默认是DEFAULT_GROUP，Group可以把不同的微服务划分到同一个分组里面去
Service就是微服务；一个Service可以包含多个Cluster（集群），Nacos默认Cluster是DEFAULT，Cluster是对指定微服务的一个虚拟划分。
比方说为了容灾，将Service微服务分别部署在了杭州机房和广州机房，这时就可以给杭州机房的Service微服务起一个集群名称（HZ），给广州机房的Service微服务起一个集群名称（GZ），还可以尽量让同一个机房的微服务互相调用，以提升性能。
最后是Instance，就是微服务的实例。

2、配置加载方案

2.1、DataId方案

1.指定spring.profile.active和配置文件的DataID来使不同环境下读取不同的配置
2.默认空间+默认分组+新建dev和test两个DataID

3.通过spring.profile.active属性就能进行多环境下配置文件的读取
spring:
 profiles:
   active: dev

2.2、Group方案

1.新增Data Id相同的不同组名配置文件
在这里插入图片描述

在这里插入图片描述
2. 通过bootstrap+application实现：同时设置spring.profiles.active和spring.cloud.nacos.config.group

server:
 port: 8080

spring:
 application:
   name: cloud-alibaba-config
 cloud:
   nacos:
     discovery:
       server-addr: 127.0.0.1:8848     #Nacos服务注册中心地址
     config:
       server-addr: 127.0.0.1:8848     #Nacos作为配置中心地址
       file-extension: yaml            #配置内容的数据格式
       group: TEST_GROUP