1 原理
随着服务越来越多,相应的配置文件也会越来越多。我们需要将配置文件拿出来单独管理, Spring Cloud Config对这种需求提供了支持。Spring Cloud Config分成两个部分
- Config Server
- Config client
Config Server用来关联外部配置, 并将获取到的配置信息提供给客户端使用。 Config client就是我们的各个微服务应用,我们在Config client上指定Config Server的位置,Config client在启动的时候就会自动去从Config Server获取和加载配置信息。
Config Server可以从四个地方获取配置信息,分别是:
- git:默认值,表示去Git仓库读取配置文件。
- subversion:表示去SVN仓库读取配置文件。
- native:将会去本地的文件系统中读取配置文件。
- vault:去Vault中读取配置文件,Vault是一款资源控制工具,可对资源实现安全访问。
2 Config Server
创建一个spring boot项目,就叫config-server,增加spring-cloud-config-server配置文件,pom文件如下:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Dalston.SR3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>
编写启动类,并增加注解@EnableConfigServer,代码如下:
@SpringBootApplication
@EnableConfigServer
public class ServerApp {
public static void main(String[] args) {
new SpringApplicationBuilder(ServerApp.class).run(args);
}
}
本例使用git方式存储配置文件,在Git上建一个repo,名称为springcloud-learn,包括一个config文件夹,其中有四个文件,分别是:
- app-dev.properties,内容 feng=dev config
- app-prod.properties,内容 feng=prod config
- app.properties,内容 feng=default config
- app-test.properties,内容 feng=test.config
配置文件如下:
server:
port: 8888
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/javaDuQing/springcloud-learn.git
search-paths: config
username: javaDuQing
password: xxx
启动启动类,通过/{application}/{profile}/{label}就能访问到我们的配置文件了,其中application表示配置文件的名字,对应我们上面的配置文件就是app,profile表示环境,我们有dev、test、prod还有默认,label表示分支,默认我们都是放在master分支上,我们在浏览器上访问结果如下:
实际上配置中心还会通过git clone命令将配置文件在本地保存了一份,这样可以确保在git仓库挂掉的时候我们的应用还可以继续运行,此时我们断掉网络,再访问http://localhost:8888/app/master,一样还可以拿到数据,此时的数据就是从本地获取的。
默认情况下,Config Server 克隆下来的文件保存在C:\Users<当前用户>\AppData\Local\Temp目录下,
我们可以通过如下配置来修改: spring.cloud.config.server.git.basedir=E:\test\
先不要创建test文件夹,会自动创建,当你访问localhost:8888/app/master时,会自动拷贝到本地,如下:
3 config client
其实有点感觉config server像是git和config client之间的桥梁,或者像的网关。服务都通过config server获取到git上的配置信息。
下面创建一个config client项目,就叫config-client,pom文件如下:
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Dalston.SR3</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
<version>1.5.4.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
</dependencies>
编写启动类如下:
@SpringBootApplication
public class ClientApp {
public static void main(String[] args) {
new SpringApplicationBuilder(ClientApp.class).run(args);
}
}
编写配置文件,uri是config-server的地址,application.name相当于/{application}/{profile}/{label}中的application。
server:
port: 2008
spring:
application:
name: app
cloud:
config:
profile: dev
label: master
uri: http://localhost:8888/
编写control,如下:
public class TestController {
@Autowired
Environment env;
@RequestMapping("/feng")
public String sang() {
return env.getProperty("feng", "未定义");
}
}
有一点需要注意:server-client的配置名称要是bootstrap.yml或者bootstrap.properties,因为server-client读取配置文件是通过引导程序来加载的,而引导程序是加载名为bootstrap的配置文件。也就说当在我们的spring boot项目中有一个application.yml的配置文件,其实在加载application.yml文件前,会先加载名为bootstrap的配置文件。
参考
- 杨恩雄 《疯狂spring cloud微服务架构实战》