系列学习 SpringCloud-Alibaba 框架之第 2 篇 —— NacosClient 环境搭建、配置中心

查看之前的博客可以点击顶部的【分类专栏】

 博客继上一篇：掌握 Nacos

1、nacos 客户端搭建

1、增加注册与发现的依赖【spring-cloud-starter-alibaba-nacos-discovery】

我们创建一个学习的项目 spring-cloud-alibaba，在 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>com.study</groupId>
    <artifactId>spring-cloud-alibaba</artifactId>
    <version>1.0-SNAPSHOT</version>

    <!-- SpringBoot 版本 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
    </parent>

    <!-- SpringCloud 版本 -->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR2</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!--web支持-->
        <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>
            <version>2.2.8.RELEASE</version>
        </dependency>

    </dependencies>

</project>

启动类 AlibabaApplication：

package com.study;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author 优快云 流放深圳
 * @description
 * @signature 让天下没有难写的代码
 * @create 2022-09-12 上午 10:03
 */
@SpringBootApplication
public class AlibabaApplication {

    public static void main(String[] args) {
        SpringApplication.run(AlibabaApplication.class, args);
    }
}

配置文件 bootstrap.yml（注意要使用 bootstrap 而不是 application）：

server:
  # 服务的端口号
  port: 8080

# 服务名称配置
spring:
  application:
    # 服务名称
    name: study-server
  cloud:
    nacos:
      # 配置 nacos 的注册中心地址
      discovery:
        server-addr: 127.0.0.1:8848

说明：

1、服务名称必填，否则启动报异常

java.lang.IllegalArgumentException: Param 'serviceName' is illegal, serviceName is blank

先启动注册中心，可以查看博客：系列学习 SpringCloud-Alibaba 框架之第 1 篇 —— 掌握 Nacos_流放深圳的博客-优快云博客

然后启动我们的微服务，启动后，进入 nacos 注册中心后台查看【服务管理】-【服务列表】：

 说明微服务已经成功注册到 nacos 注册中心。客户端搭建完毕。

2、配置中心

问：什么是配置中心？

答：配置中心就是一种统一管理各种应用配置的基础服务组件，配置中心将配置从各应用中剥离出来，对配置进行统一管理，应用自身不需要自己去管理配置。

配置中心的服务流程如下：

1、管理员在配置中心更新配置信息。

2、分布式配置中心服务端发现配置文件发生变化，就会通知本地项目去刷新配置文件（一般是通过 netty 长连接的技术手段实现）。

首先，在 pom.xml 增加配置中心的依赖：

        <!-- 配置中心依赖 -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
            <version>2.2.8.RELEASE</version>
        </dependency>

然后我们进入管理后台，找到【配置管理】->【配置列表】，右边 + 号增加配置：

 在新增页面，输入以下配置信息，然后点击后面的【发布】：

说明：

1、在 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 类型。默认是 properties 格式。

因为我的演示项目中没有指定 active 的文件（dev、test、prod），所以直接使用【${prefix}.${file-extension}】的配置方式。

2、配置文件加载的优先级（由高到低）

bootstrap.properties -> bootstrap.yml -> application.properties -> application.yml

也就是说，application.yml 的加载优先级是最低的。所以在搭建微服务架构中，建议优先使用 bootstrap 开头的配置，因为它的加载优先级最高。

bootstrap.yml 配置如下：

server:
  # 服务的端口号
  port: 8080

# 服务名称配置
spring:
  application:
    # 服务名称
    name: study-server
  cloud:
    nacos:
      server-addr: 127.0.0.1:8848
      # 配置 nacos 的注册中心地址
      discovery:
        server-addr: ${spring.cloud.nacos.server-addr}
      # 配置中心
      config:
        server-addr: ${spring.cloud.nacos.server-addr}
        # 文件扩展名
        file-extension: yml

说明：

1、要在 config 节点下增加 file-extension: yml 配置，因为 nacos 默认使用 properties 后缀文件的，否则抛出异常：

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'blog.nickname' in value "${blog.nickname}"

这时候返回到后台的【配置列表】即可看到：

点击【详情】：

出现一个 MD5 的值，这个值是用来记录配置内容是否发生改变的。一旦发生改变，MD5 的值就会发生变化，然后配置中心服务就会通知本地项目去刷新配置文件。

配置的内容都会保存在 nacos 服务器的 data 目录下：

然后我们新增一个 controller 类，在类名上增加 Spring Cloud 原生注解 @RefreshScope 实现配置自动更新：

package com.study.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author 优快云 流放深圳
 * @description
 * @create 2022-09-13 11:47
 * @since 1.0.0
 */
@RestController
@RefreshScope
public class BlogController {

    @Value("${blog.nickname}")
    private String nickname;

    @GetMapping("/getNickname")
    public String getNickname(){
        System.out.println(this.nickname);
        return this.nickname;
    }

}

 整体代码结构如下（注意要使用 bootstrap.yml 配置文件）：

启动服务，postman 输入 http://127.0.0.1:8080/getNickname

说明已经读取到 nacos 配置中心的内容。

然后，我们去后台修改配置中心内容，看下能否同步刷新：

然后弹出【内容对比】框，确认发布。 

 再次请求：

说明已经动态的刷新了配置。 

如果我们本地 yml 文件配置了相同内容，那么是使用我们本地的配置还是 nacos 配置中心的配置呢？

再次请求：

说明是优先使用了 nacos 配置中心的配置。

3、多配置文件

在企业级开发中，经常会用到多个配置文件，如：开发环境 dev，测试环境 test，预发布环境 pre，生产环境 prod 等等。之前的普遍做法是，在 resources 目录下创建很多个文件，比如：bootstrap-dev、bootstrap-test 等等，有了 nacos，我们怎么使用它来管理我们的多配置文件呢？

我们可以这样来做。首先在 nacos 后台增加需要的配置文件，如：

 

然后在代码里指定当前环境对应的 profile 即可，如：

然后启动服务，测试：

 

 

 OK，配置中心正式入门！