之前我们在创建项目的时候,为每个项目都配置了一个或者多个配置文件。通过修改配置文件中的参数我们可以创建出不同的服务环境。
但这样做也有一些问题,如:
- 首先,服务拆分越多,配置项也就越多。而一旦有某项服务进行了调整,其他服务也需要相应调整。如果配置项都在每个项目的配置文件中配置,那么可想而知,只要一有改变,就得改配置文件,重新部署项目。
- 其次,运维安全。如果我们将一些数据库信息直接配置在配置文件中,那么对于运维的同学来说,显然带来了更大的挑战与风险。因为项目极有可能是多人协作开发,而多人都可以直接连接数据库将会具有不小的风险(删库跑路了解一下...)
因此,Spring Cloud 架构中专门集成了一套用于配置管理的组件 - 分布式配置中心(Spring Cloud Config)
一、Spring Cloud Config 介绍
Spring Cloud Config 的官方介绍文档地址如下:
https://cloud.spring.io/spring-cloud-static/Finchley.RELEASE/single/spring-cloud.html#_spring_cloud_config
大致意思是,Spring Cloud Config 提供一种基于客户端与服务端(C/S)模式的分布式的配置管理。我们可以把我们的配置管理在我们的应用之外(config server 端),并且可以在外部对配置进行不同环境的管理,比如开发/测试/生产环境隔离,并且还能够做到实时更新配置。
二、创建 git 项目管理配置
此处我们使用基于 git 的第三方代码托管远程仓库 github 作为我们的远程仓库的配置,当然你也可以使用 gitee 或者自己搭建的私服如 gitlab 或者也可以使用本地仓库。但建议使用远程仓库且创建私有项目(此处 github 只用于演示),你甚至还可以使用 svn 来作为配置托管。
创建过程此处省略。创建完成后,点击 README 可进入创建文件页面,我们把之前的 user-service.yml 配置文件的内容拷贝到内容编辑区并保存提交(当然也可以从本地使用 git 命令来提交)。
三、创建 Config Server 项目
创建 Config Server 项目过程略,请参考之前的创建 Eureka Server 的过程,其中:
由于 Config Server 同时也是一个 Eureka 的客户端。因此,我们需要将其注册到我们的 Eureka Server 上。
当然不选择也没关系,只需要在 pom.xml 中配置需要的依赖即可。
3.1 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.jiangzhuolin</groupId>
<artifactId>user-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>user-service</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.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>Finchley.RC2</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-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
<snapshots>
<enabled>false</enabled>
</snapshots>
</repository>
</repositories>
</project>
3.2 application.yml 配置
# application name
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/jiangzhuolin/config-manage.git
username: changeme
password: changeme
# server monitor port
server:
port: 8181
# eureka server cluster
eureka:
client:
service-url:
defaultZone: http://hadoop1:8000/eureka/,http://hadoop2:8000/eureka/,http://hadoop3:8000/eureka/
3.3 @EnableConfigServer
package com.jiangzhuolin.configserver;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.config.server.EnableConfigServer;
@SpringBootApplication
@EnableDiscoveryClient
@EnableConfigServer
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
添加 @EnableDiscoveryClient 注解使项目具备 Eureka Client 功能,添加 @EnableConfigServer 使其具备 Config Server 功能。
四、使用 Config Server
本地启动 config-server 项目,在浏览器上输入以下地址 http://localhost:8181/user-service.yml
可以看到,我们已经从 config-server 这个项目访问获取到了 github 远程仓库中存放的配置文件。
五、注意事项
Config Server 中配置文件的 HTTP 资源操作方式如下
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
其中,{application} 被用于 spring 配置的配置文件名称,在 spring boot 中通常默认为 application;{profile} 表示激活的配置文件,通常用于区分开发/测试/生产环境;{label} 则表示 git 的分支,默认为 master。