Spring Cloud Alibaba 使用Nacos作为配置中心

通过前面学习《Spring Cloud Alibaba:使用Nacos实现服务注册与发现》《Spring Cloud Alibaba 支持的几种服务消费方式(RestTemplate、WebClient、Feign)》,我们知道了如何利用Nacos实现服务的注册与发现。同时,也介绍了在Spring Cloud中,我们可以使用的几种不同编码风格的服务消费方式。接下来,我们再来学习一下Nacos的另外一个重要能力:配置管理。

简介

Nacos除了实现了服务的注册发现之外,还将配置中心功能整合在了一起。通过Nacos的配置管理功能,我们可以将整个架构体系内的所有配置都集中在Nacos中存储。这样做的好处,主要有以下几点:

  • 分离的多环境配置,可以更灵活的管理权限,安全性更高
  • 应用程序的打包更为纯粹,以实现一次打包,多处运行的特点

Nacos的配置管理模型与淘宝开源的配置中心Diamond类似,基础层面都通过DataIdGroup来定位配置内容,除此之外还增加了很多其他的管理功能。

快速入门

下面我们通过一个简单的例子来介绍如何在Nacos中创建配置内容以及如何在Spring Cloud应用中加载Nacos的配置信息。

创建配置

第一步:进入Nacos的控制页面,在配置列表功能页面中,点击右上角的“+”按钮,进入“新建配置”页面,如下图填写内容:

Spring Cloud Alibaba 使用Nacos作为配置中心_第1张图片

Spring Cloud Alibaba 使用Nacos作为配置中心_第2张图片 

其中:

  • Data ID:填入alibaba-nacos-config-client.properties
  • Group:不修改,使用默认值DEFAULT_GROUP
  • 配置格式:选择Properties
  • 配置内容:应用要加载的配置内容,这里仅作为示例,做简单配置,比如:didispace.title=spring-cloud-alibaba-learning

创建应用

第一步:创建一个Spring Boot应用,可以命名为:alibaba-nacos-config-client

第二步:编辑pom.xml,加入必要的依赖配置,比如:


	org.springframework.boot
	spring-boot-starter-parent
	2.0.5.RELEASE
	 


		
			
				org.springframework.cloud
				spring-cloud-dependencies
				Finchley.SR1
				pom
				import
			
			
				org.springframework.cloud
				spring-cloud-alibaba-dependencies
				0.2.2.RELEASE
				pom
				import
			
		
	

	
		
			org.springframework.boot
			spring-boot-starter-web
		
		
			org.springframework.cloud
			spring-cloud-starter-alibaba-nacos-config
		
		
			org.projectlombok
			lombok
			1.18.2
			true
		

上述内容主要三部分:

  • parent:定义spring boot的版本
  • dependencyManagement:spring cloud的版本以及spring cloud alibaba的版本,由于spring cloud alibaba还未纳入spring cloud的主版本管理中,所以需要自己加入
  • dependencies:当前应用要使用的依赖内容。这里主要新加入了Nacos的配置客户端模块:spring-cloud-starter-alibaba-nacos-config。由于在dependencyManagement中已经引入了版本,所以这里就不用指定具体版本了。

可以看到,这个例子中并没有加入nacos的服务发现模块,所以这两个内容是完全可以独立使用的

第三步:创建应用主类,并实现一个HTTP接口:

package com.example.demo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
import org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class, HibernateJpaAutoConfiguration.class})
public class DemoApplication {
	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);
	}
	@Slf4j
	@RestController
	@RefreshScope
	static class TestController {
		@Value("${didispace.title:}")
		private String title;
		@GetMapping("/test")
		public String hello() {
			return title;
		}
	}
}

内容非常简单,@SpringBootApplication定义是个Spring Boot应用;还定义了一个Controller,其中通过@Value注解,注入了key为didispace.title的配置(默认为空字符串),这个配置会通过/test接口返回,后续我们会通过这个接口来验证Nacos中配置的加载。另外,这里还有一个比较重要的注解@RefreshScope,主要用来让这个类下的配置内容支持动态刷新,也就是当我们的应用启动之后,修改了Nacos中的配置内容之后,这里也会马上生效。

第四步:创建配置文件bootstrap.properties,并配置服务名称和Nacos地址

spring.application.name=alibaba-nacos-config-client
server.port=8001
spring.cloud.nacos.config.server-addr=127.0.0.1:8848

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

第五步:启动上面创建的应用。

Spring Cloud Alibaba 使用Nacos作为配置中心_第3张图片

在启动的时候,我们可以看到类似上面的日志信息,这里会输出应用程序要从Nacos中获取配置的dataId和group。如果在启动之后,发现配置信息没有获取到的时候,可以先从这里着手,看看配置加载的目标是否正确。

第六步:验证配置获取和验证动态刷新

用curl或者postman等工具,访问接口: localhost:8001/test,一切正常的话,将返回Nacos中配置的spring-cloud-alibaba-learning。然后,再通过Nacos页面,修改这个内容,点击发布之后,再访问接口,可以看到返回结果变了。

同时,在应用的客户端,我们还能看到如下日志:

Spring Cloud Alibaba 使用Nacos作为配置中心_第4张图片

Spring Cloud Alibaba 使用Nacos作为配置中心_第5张图片 在Nacos中修改了Key,在用到这个配置的应用中,也自动刷新了这个配置信息。

 

参考资料

  • Nacos官方文档
  • Nacos源码分析

代码示例

本文示例读者可以通过查看下面仓库的中的alibaba-nacos-config-client项目:

  • Gitee:https://gitee.com/wys0518/spring-cloud-learning.git

你可能感兴趣的:(spring,cloud,nacos,alibaba,java)