Spring Cloud Config分布式配置中心(学习总结)

其他 2018-09-23 05:17:25 阅读次数: 0

一、简介

在微服务中，每个功能模块其实都可以拆分成一个单独的服务实例，如果项目够大，必然会有很多服务单元，每个服务单元都有一份配置文件需要维护，这显得不太好维护，而且不方便协作开发。为了使服务实例的配置文件统一管理化，Spring Cloud Config提供了一套解决方案，建立一个配置服务中心，每个服务单元从config server中获取具体的配置文件，它支持配置服务放在配置服务的内存中（即本地），也支持放在远程Git仓库中。为了保证系统的稳定，配置服务端config server可以进行集群部署，即使某一个实例，因为某种原因不能提供服务，也还有其他的实例保证服务的继续进行。下面就讲解一下Spring Cloud Config的基本用法。

二、准备工程

a. springcloud_config_server: 配置服务中心，端口1111

b. springcloud_config_client: 具体服务实例，端口2222(在项目中就是具体某个服务单元，都相当于是一个config client)

三、新建springcloud_config_server工程

注意引入spring-cloud-config-server依赖，具体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.springcloud.wsh</groupId>
	<artifactId>springcloud_config_server</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>springcloud_config_server</name>
	<description>配置中心</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
		<spring-cloud.version>Camden.SR6</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-config-server</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.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>

四、启动类加上@EnableConfigServer注解

@EnableConfigServer注解主要是开启Spring Cloud Config分布式配置的功能

/**
 * 配置中心
 * 证明配置服务中心是否可以从远程程序获取配置信息:
 * 地址: localhost:1111/aaaa/dev实际是没有对应的文件。如果真有文件，返回的json在会有propertySources属性，它的值就是文件的内容。例如http://localhost:8888/config-client/dev 对应git仓库中的config-client-dev.propeties文件
 *
 * @author weishihuai
 * @date 2018/09/17 22:18
 */
@SpringBootApplication
//@EnableConfigServer注解用于开启Spring Cloud Config配置功能
@EnableConfigServer
public class SpringcloudConfigServerApplication {

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

五、git仓库等属性配置

首先创建一个放置配置文件的git仓库，这里是github,具体见下图：

在git仓库中新建一个repository（可以自定义名称）文件夹，文件夹下面可以新建config-client-dev.properties、config-client-test.properties、config-client-prod.properties表示不同环境的配置文件。

config-client-dev.properties的内容为：假设表示开发环境的配置文件

com.springcloud.wsh.message=Spring Cloud Config分布式配置中心(开发环境)

 config-client-test.properties的内容为：假设表示测试环境的配置文件

com.springcloud.wsh.message=Spring Cloud Config分布式配置中心(测试环境)

 config-client-prod.properties的内容为：假设表示生产环境的配置文件

com.springcloud.wsh.message=Spring Cloud Config分布式配置中心(正式生产环境)

接下来配置application.properties: 

#应用名称
spring.application.name=config-server
#端口号
server.port=1111
#配置中心git仓库地址，注意后面的/
spring.cloud.config.server.git.uri=对应你的git仓库地址
#配置中心git仓库路径
spring.cloud.config.server.git.search-paths=repository
#访问git仓库的用户名(如果Git仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写)
spring.cloud.config.server.git.username=对应你的github用户名
#访问git仓库的密码
spring.cloud.config.server.git.password=对应你的github密码
#配置git仓库的分支
spring.cloud.config.label=master

注意：

spring.cloud.config.server.git.uri：指定配置中心git仓库的地址

spring.cloud.config.server.git.search-paths： 指定配置中心仓库的路径，即创建的文件夹路径

spring.cloud.config.label：指定git仓库的分支

#访问git仓库的用户名(如果Git仓库为公开仓库，可以不填写用户名和密码，如果是私有仓库需要填写)

spring.cloud.config.server.git.username： 指定访问git仓库的用户名

spring.cloud.config.server.git.password：指定访问git仓库的密码

六、启动springcloud_config_server

启动完成之后，我们需要验证一下配置服务中心是否可以从远程程序获取配置信息：

我们在浏览器访问：http://localhost:1111/config-client/dev 或者 http://localhost:1111/master/config-client-dev.properties 或者

http://localhost:1111/config-client-dev.properties：可以看到接口返回信息为：

http://localhost:1111/config-client/dev返回如下图：

上图所见，因为git仓库确实存在config-client-dev.properties配置文件，所以接口成功返回配置文件的内容，如果我们访问http://localhost:1111/aaaa/dev，这时候就相当于查询git仓库中是否存在aaaa-dev.properties这个配置文件，如果不存在，返回的propertySources为空，但是也可以验证我们可以从远程git仓库获取配置文件的内容，简单理解就是我们在服务单元中跟git仓库是连通的。

http://localhost:1111/master/config-client-dev.properties返回： 

 http://localhost:1111/config-client-dev.properties返回： 

可以看到，接口成功返回数据，说明我们可以从远程git仓库获取到配置文件的信息。(忽略中文乱码问题，后面会讲解决方法，这里只是验证是否可以从远程git仓库获取到配置文件的信息)

扩展：

URL与配置文件的映射关系如下：(主要有五种)

/{application}/{profile}[/{label}] 

/{application}-{profile}.yml 

/{label}/{application}-{profile}.yml 

/{application}-{profile}.properties 

/{label}/{application}-{profile}.properties

#label:表示git仓库的分支
#application：表示具体服务单元的名称，即后面config-client的application-name
#profile: 指定环境类型
dev-开发环境
prod-生产环境
test-测试环境

经过以上步骤，我们的config-server就算搭建成功了。下面我们搭建config-client

七、新建springcloud_config_client工程

引入spring-cloud-starter-config依赖，具体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.springcloud.wsh</groupId>
	<artifactId>springcloud_config_client</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>springcloud_config_client</name>
	<description>模拟配置中心客户端</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.2.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
		<spring-cloud.version>Camden.SR6</spring-cloud.version>
	</properties>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-config</artifactId>
		</dependency>

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>${spring-cloud.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>

八、confing-client配置文件bootstrap.properties

注意：新建bootstrap.properties，不是application.properties

#应用名称(对应的git仓库配置文件名称也应该是:config-client-dev、config-client-prod、config-client-test)
spring.application.name=config-client
#端口
server.port=2222
#配置git远程仓库的分支
spring.cloud.config.label=master
#配置服务中心地址(即config-server的地址)
spring.cloud.config.uri=http://localhost:1111/
#配置环境
#dev为开发环境配置文件
#test为测试环境
#pro为正式环境
spring.cloud.config.profile=dev

注意：

spring.cloud.config.label：指定git仓库的分支

spring.cloud.config.uri: 指定配置服务中心地址(即config-server的地址)

spring.cloud.config.profile=dev：指定所属环境

spring.application.name=config-client：应用名称(对应的git仓库配置文件名称也应该是:config-client-dev、config-client-prod、config-client-test)

九、新建GetPropertyFromConfigServerController

主要是暴露一个接口用于测试从远程git仓库获取配置文件的内容

/**
 * 测试客户端从配置服务中心获取配置文件中的内容
 *
 * @author weishihuai
 * @date 2018/9/17 22:05
 */
@RestController
public class GetPropertyFromConfigServerController {

    private static Logger logger = LoggerFactory.getLogger(GetPropertyFromConfigServerController.class);

    @Value("${com.springcloud.wsh.message}")
    String message;

    @RequestMapping("/getPropertyFromConfigServer")
    public String getPropertyFromConfigServer() {
        String msg = "hello, i am " + message + ", i'm come from config server";
        logger.info(msg);
        return msg;
    }

}

十、启动config-server以及config-client

浏览器访问http://localhost:2222/getPropertyFromConfigServer,

可以看到，我们成功从git远程仓库中获取了config-client-dev配置文件中的内容。可以看到中文出现乱码了，出现乱码的原因:

spring默认加载配置文件load方法中使用的是IOS-8859-1编码格式，解决方法：改造springcloud-config-server服务配置中心

a. 需要重写一个自定义的PropertySourceLoader，指定编码格式为utf-8：

/**
 * @Title: CustomPropertySourceLoader
 * @ProjectName springcloud_confing_center
 * @Description: 自定义PropertySourceLoader解决中文乱码问题
 * @Author WeiShiHuai
 * @Date 2018/9/18 13:43
 */
public class CustomPropertySourceLoader implements PropertySourceLoader {

    private static Logger logger = LoggerFactory.getLogger(CustomPropertySourceLoader.class);
    private static final String CHARACTER_ENCODING = "utf-8";

    /**
     * 指定文件扩展名称(.properties、.xml)
     *
     * @return
     */
    @Override
    public String[] getFileExtensions() {
        return new String[]{"properties", "xml"};
    }

    @Override
    public PropertySource<?> load(String name, Resource resource, String profile) throws IOException {
        if (null == profile) {
            Properties properties = getProperties(resource);
            if (!properties.isEmpty()) {
                return new PropertiesPropertySource(name, properties);
            }
        }
        return null;
    }

    private Properties getProperties(Resource resource) {
        Properties properties = new Properties();
        InputStream inputStream = null;
        try {
            inputStream = resource.getInputStream();
            //指定load方法的编码为utf-8,默认是ISO8859-1
            properties.load(new InputStreamReader(inputStream, CHARACTER_ENCODING));
            inputStream.close();
        } catch (IOException e) {
            logger.error("加载配置文件失败", e);
        } finally {
            if (null != inputStream) {
                try {
                    inputStream.close();
                } catch (IOException e) {
                    logger.error("关闭流失败", e);
                }
            }
        }
        return properties;
    }

}

b.在resources文件夹下面创建META-INF文件夹，新建一个spring.factories文件，文件内容为：

#指定自定义PropertySourceLoader,注意是全路径
org.springframework.boot.env.PropertySourceLoader=com.springcloud.wsh.sourceloader.CustomPropertySourceLoader

重启config-server,config-client，浏览器访问http://localhost:2222/getPropertyFromConfigServer

可以看到，中文正常显示了，乱码问题解决。

以上我们只是测试读取dev开发环境的配置文件内容，下面我们再测试一个读取test环境的配置文件：

修改config-client的bootstrap.properties中的spring.cloud.config.profile=test指定为测试环境，

重启项目，浏览器访问http://localhost:2222/getPropertyFromConfigServer，

可以看到，现在读取的就是测试环境下的配置文件信息。至此，我们实现了一个比较简单的config-server以及config-client，实现了从远程git仓库获取各个环境对应的配置文件信息。

十一、总结

在实际项目中，config server配置中心通常需要集群部署，这样某个配置中心挂掉也不会影响到其他服务单元的正常使用。本章搭建的config server并不是高可用的，下一章将会讲解config- server的高可用。本文是笔者在学习Spring Cloud Config的一些总结，仅供参考，共同学习，共同进步。

猜你喜欢

转载自blog.csdn.net/Weixiaohuai/article/details/82759084
今日推荐
基于大语言模型的开源知识库问答系统 MaxKB GitHub Star 数量突破 5,000 个！
美国拟限制 AI 大模型出口中国和俄罗斯
苹果将与 OpenAI 达成协议，将 ChatGPT 应用于 iPhone
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
《2024 年一季度互联网投融资运行情况》研究报告
报告：Django 仍然是 74% 开发者的首选
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
周排行
记一下去大梅沙的准备（2018-05-26）
Spring 注解 事务
基于HTTP协议的客户端缓存
阿里云rds 备份和还原
[PHP] 几个拖慢 PHP 程序/API 运行速度的点
python 代码风格------------PEP8规则
js控制json生成菜单——自制菜单（一）
将字符串: 'k:1|k1:2|k2:3|k3:4 ' ,处理成 python 字典: {'k':1, 'k1':2, ...}
微信小程序转支付宝小程序
Qt551.窗口滚动条
每日归档
更多
2024-05-13(18)
2024-05-12(0)
2024-05-11(38)
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022