1、Config简介
当项目越来越多,每个项目又要去维护多个配置文件,而且每个配置文件还要区分各个环境(开发、测试、预发布、线上等),想想都头大,不过市面上已经存在很多好用的开源的配置中心,如百度的disconf,携程的Apollo等,这些开源的软件确实都很棒,但是SpringCloud Config确更加轻量级,功能也强大,可以无缝的和spring体系相结合,简单易用。它包含了Client和Server两个部分,server提供配置文件的存储、以接口的形式将配置文件的内容提供出去,client通过接口获取数据、并依据此数据初始化自己的应用。
在使用springcloud config之前我们可以想想一个配置中心应该提供哪些核心功能呢?
- 提供服务端和客户端支持
- 集中管理各环境的配置文件
- 配置文件修改之后,可以快速的生效
- 可以进行版本管理
- 支持大的并发查询
- 支持各种语言
2、创建配置文件
本文的配置文件从git拉取,我们再github上新增了仓库config-server用于放配置文件,我这里建了三个配置文件:https://github.com/xujiangdong/config-server,每个配置文件里面的key都一样,只是value不一样
3、配置中心Server端
另起个项目叫confif-server,引入核心依赖spring-cloud-config-server
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>config-server</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>config-server</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Finchley.RELEASE</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.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>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</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>
</repository>
</repositories>
</project>
配置文件application.yml
这里将配置中心服务端注册到注册中心,客户端通过注册中心获取配置中心服务端,当配置中心服务端集群部署的时候可以保证服务端的高可用
- uri:你的github地址
- search-paths:你的仓库名称,多个用逗号隔开,可以不配置,加在uri后面即可,如:https://github.com/xujiangdong/config-server
- username\password:公开库就不需要配置了,私有库需要
- basedir:配置文件下取下来后存储的本地地址,可以不配置
- label:对应的分支,可以不配置,默认master
server:
port: 8006
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/xujiangdong/
search-paths: config-server
username:
password:
basedir: G:\test
label: master
eureka:
instance:
prefer-ip-address: true
client:
service-url:
defaultZone: http://localhost:8000/eureka
启动类上开启注册中心(@EnableConfigServer),并将该实例注册到注册中心
@SpringBootApplication
@EnableConfigServer
@EnableDiscoveryClient
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
4、启动项目
注册中心还是用的第一篇文章的那个项目,启动后访问:http://localhost:8006/config-tst.properties,后缀还可以用yml或json,以不同的格式打印,如:http://localhost:8006/config-tst.yml
5、配置中心Client端
新建一个项目config-client1,并引入核心依赖spring-cloud-config-client
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.0.3.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>config-client1</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>config-client1</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Finchley.RELEASE</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.cloud</groupId>
<artifactId>spring-cloud-config-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
</exclusion>
</exclusions>
</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>
</repository>
</repositories>
</project>
新建配置文件bootstrap.yml,为啥不用application.yml?因为bootstrap.yml的加载顺序在application.yml之前,这样可以保证配置文件在项目编译前被拉取下来,这里通过注册中心获取配置中心服务端
- service-id:需要访问的实例名称
- name:需要读取的配置文件名
- profile:对应的环境
server:
port: 8007
spring:
application:
name: config-client1
cloud:
config:
discovery:
enabled: true
service-id: CONFIG-SERVER
profile: tst
name: config-tst
eureka:
instance:
prefer-ip-address: true
client:
service-url:
defaultZone: http://localhost:8000/eureka/
启动类
@SpringBootApplication
@EnableDiscoveryClient
public class ConfigClient1Application {
public static void main(String[] args) {
SpringApplication.run(ConfigClient1Application.class, args);
}
}
新建一个测试接口测试能否正常获取配置文件
/**
* @author XuJD
* @create 2019-11-28 17:21
**/
@RestController
public class TestController {
@Value("${db.url}")
private String url;
@RequestMapping("getConfig")
public String getConfig(){
return url;
}
}
访问:http://localhost:8007/getConfig,可以看到已经拿到配置项了