原创

Spring Cloud Alibaba基础教程第三篇:Nacos作为配置中心

在之前的两篇文章
Spring Cloud Alibaba基础教程第一篇:使用Nacos实现服务注册与发现
Spring Cloud Alibaba基础教程第二篇:消费方式
相信我们已经简单掌握,如何利用Nacos搭建注册中心并实现服务的注册与发现。还有在Alibaba Spring Cloud中,我们同样可以使用Ribbon和Feign两种服务消费方式。那么接下来,我们再来学习一下Nacos的配置管理,来感受它的美

一. Nacos配置管理简介

通过官方文档了解到,Nacos不仅有服务发现和服务健康监测,实现服务的注册发现之外,还有动态配置服务。Nacos动态配置服务可以让您以中心化、外部化和动态化的方式管理所有环境的应用配置和服务配置,我们可以将整个架构体系内的所有配置都集中在Nacos中存储。这个道理和Spring Cloud Config是一样的,优点主要有以下几点:

  • 动态配置消除了配置变更时重新部署应用和服务的需要,让配置管理变得更加高效和敏捷
  • 配置中心化管理让实现无状态服务变得更简单,让服务按需弹性扩展变得更容易

Nacos 提供用于存储配置和其他元数据的 key/value 存储,为分布式系统中的外部化配置提供服务器端和客户端支持。使用 Spring Cloud Alibaba Nacos Config,您可以在 Nacos Server 集中管理你 Spring Cloud 应用的外部属性配置。 Spring Cloud Alibaba Nacos Config 是 Config Server 和 Client 的替代方案,客户端和服务器上的概念与 Spring Environment 和 PropertySource 有着一致的抽象,在特殊的 bootstrap 阶段,配置被加载到 Spring 环境中。当应用程序通过部署管道从开发到测试再到生产时,您可以管理这些环境之间的配置,并确保应用程序具有迁移时需要运行的所有内容

二. Nacos配置实战

接下来介绍如何在Nacos中创建配置内容以及如何在Spring Cloud应用中获取Nacos的配置信息 演示相关版本:

Nacos: 1.0.1 Spring Boot: 2.1.6.RELEASE Spring Cloud: Greenwich.SR1 Spring Cloud Alibaba: 0.2.2.RELEASE

创建Nacos配置

打开浏览器输入: localhost:8848 输入账号密码 进入Nacos控制主页

点击右上角➕ 填入以下相关配置

PS:

  • Data ID:填入alibaba-nacos-config-client.properties(为什么这样?下面慢慢看)
  • Group:不修改,使用默认值DEFAULT_GROUP
  • 配置格式:支持六种格式 我这里选择Properties
  • 配置内容:应用要加载的配置内容,这里仅作为示例,做简单配置,比如:gongzhonghao=lihaodong_blog

在 Nacos Spring Cloud 中,dataId 的完整格式如下:${prefix}-${spring.profile.active}.${file-extension}

  • prefix 默认为 spring.application.name 的值,也可以通过配置项 spring.cloud.nacos.config.prefix来配置
  • spring.profile.active 即为当前环境对应的 profile,详情可以参考 Spring Boot文档。 注意:当 spring.profile.active 为空时,对应的连接符 - 也将不存在,dataId 的拼接格式变成${prefix}.${file-extension}
  • file-exetension 为配置内容的数据格式,可以通过配置项 spring.cloud.nacos.config.file-extension 来配置。目前只支持 properties 和 yaml 类型。

配置完成后是这样的

参数配置完毕,肯定需要程序来获取,安排!

创建配置客户端

这里使用的姿势和上篇文章一样

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>
    <parent>
        <groupId>com.xd</groupId>
        <artifactId>SpringCloudAlibabaLearn</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../</relativePath>
    </parent>
    <artifactId>alibaba-nacos-config-client</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>alibaba-nacos-config-client</name>
    <description>Nacos作为配置中心服务</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!--nacos config依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>
    </dependencies>

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

</project>
复制代码

主要还是在之前的基础作为子模块,集成父pom文件,添加nacos-config依赖

bootstrap.properties
server.port=8084
#配置客户端 Nacos中创建的配置Data Id匹配( 除了.properties或者.yaml后缀)
spring.application.name=alibaba-nacos-config-client
#注册服务到nacos
spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848
#配置中心地址
spring.cloud.nacos.config.server-addr=127.0.0.1:8848
复制代码

主要配置注册中心和配置中心 注意:这里必须使用bootstrap.properties。同时,spring.application.name值必须与上一阶段Nacos中创建的配置Data Id匹配(除了.properties或者.yaml后缀)

创建应用主类,并实现一个接口:
package com.xd.alibabanacosconfigclient;

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

@RestController
@RefreshScope //主要用来让这个类下的配置内容支持动态刷新
@SpringBootApplication
public class AlibabaNacosConfigClientApplication {

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


    // nacos配置的参数
    @Value("${gongzhonghao}")
    private String gongzhonghao;

    @GetMapping("/test")
    public String getGongzhonghao() {
        return gongzhonghao;
    }
}
复制代码

@SpringBootApplication: 定义是个Spring Boot应用
@RestController: @RestController注解,相当于@Controller+@ResponseBody两个注解的结合,返回json数据不需要在方法前面加@ResponseBody注解 @Value: 注入了key为gongzhonghao的配置(默认为空字符串),这个配置会通过/test接口返回,后续我们会通过这个接口来验证Nacos中配置的加载。 @RefreshScope: 主要用来让这个类下的配置内容支持动态刷新,也就是当我们的应用启动之后,修改了Nacos中的配置内容之后,这里也会马上生效

启动程序

控制台打印注册中心地址和配置中心相关信息 说明启动成功

测试

打开浏览器,输入 http://localhost:8084/test 内容显示如下:

获取的内容是我在nacos配置的验证配置成功
我们通过Nacos页面,修改这个内容,点击发布之后

重新查询 http://localhost:8084/test

可以看到返回结果变了

三. 参考资料:

四. 代码示例

如果您对这些感兴趣,欢迎star、follow、收藏、转发给予支持!

本文目录