任何系统里面都少不了配置文件,或者是外接口地址、数据库连接、数量限制、bean信息等。大多的配置都是和服务端放到一起的,这完全是没有问题的。
现如今的后端服务,不论是小网站为了做到高可用,还是大网站为了应对请求流量压力,都会部署成集群形式。
此时,有些配置项可能需要不定期的修改,很可能是一种应急性配置,不能恰好赶上上线的时间修改,比如,设定某种阈值、缓存时间、限流、降级等。
对于需要线上修改的配置,我们一般要放到集中的配置中心,一次修改,及时、全部生效。
避免,一台一台修改,一台一台重启服务,而是能够不中断服务的热修改。
spring cloud提供了集中配置的组件config server。该组件提供了基于git上文件的集中配置、基于eureka的服务端高可用、基于git webhook和 spring cloud bus的修改自动更新。
这里需要提一下,我们常见的zookeeper集中配置相对来说不需要像config server这么多的辅助组件,有zookeeper服务器和actuator客户端类库就可以了,而且能够在zookeeper上的配置信息修改后,自动将修改推送到各个客户端。
但是zookeeper的服务端由于使用的Paxos算法,需要至少有3台服务器才能部署高可用,服务端会相对来说较重。
说道这里,要用好config server也必须用好他的高可用和修改自动更新。
先来看下git上配置文件的格式:
configs是git上的项目名称,对应到config server服务端配置的spring.cloud.config.server.git.uri
;
test可以认为是一个分组,对应到服务端配置spring.cloud.config.server.git.searchPaths
;
config-dev.properties和config-pro.peoperties是两个配置文件,dev对应到测试环境,pro对应到线上环境;其中config对应到客户端配置spring.application.name
;dev或者pro对应到客户端配置的spring.cloud.config.profile
;
文件可以是properties格式也可以是yaml格式,这和spring支持两种格式的配置文件是一样的。
比如,我这里config-dev.properties内容是:
app-name=1234455
config-pro.properties内容是:
app-name=asdfg
pom.xml文件:
<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.0modelVersion>
<groupId>com.dangdanggroupId>
<artifactId>config-serverartifactId>
<version>0.0.1-SNAPSHOTversion>
<packaging>jarpackaging>
<name>config-servername>
<description>Demo project for Spring Bootdescription>
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>1.5.8.RELEASEversion>
<relativePath/>
parent>
<properties>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
<java.version>1.8java.version>
<spring-cloud.version>Dalston.SR4spring-cloud.version>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-config-serverartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-dependenciesartifactId>
<version>${spring-cloud.version}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
plugin>
plugins>
build>
project>
application.yaml
server:
port: 8071
spring:
application:
name: config-server
cloud:
config:
server:
git:
uri: https://github.com/ZhangShufan15/configs.git
searchPaths: test
username: your user name
password: your password
label: master
ConfigServerApplication .java
package com.dangdang.configserver;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
添加@EnableConfigServer注解即可。
pom.xml文件:
<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.0modelVersion>
<groupId>com.dangdanggroupId>
<artifactId>config-clientartifactId>
<version>0.0.1-SNAPSHOTversion>
<packaging>jarpackaging>
<name>config-clientname>
<description>Demo project for Spring Bootdescription>
<parent>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-parentartifactId>
<version>1.5.8.RELEASEversion>
<relativePath/>
parent>
<properties>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8project.reporting.outputEncoding>
<java.version>1.8java.version>
<spring-cloud.version>Dalston.SR4spring-cloud.version>
properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-configartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-dependenciesartifactId>
<version>${spring-cloud.version}version>
<type>pomtype>
<scope>importscope>
dependency>
dependencies>
dependencyManagement>
<build>
<plugins>
<plugin>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-maven-pluginartifactId>
plugin>
plugins>
build>
project>
bootstrap.yaml,这个文件要特别注意了,spring cloud的配置信息加载顺序是 bootstrap.yaml > 远程仓库(config server) > application.yaml。
所以我们客户端的config server配置必须在bootstrap.yaml里面添加,否则在加载远程仓库配置的时候永远加载的是默认的http://localhost:8888.
spring:
cloud:
config:
uri: http://127.0.0.1:8071
profile: dev
label: master
application:
name: config
application.yaml
server:
port: 8072
ConfigClientApplication.java
package com.dangdang.configclient;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
@Value("${app-name}")
private String app_name;
@RequestMapping("hi")
public String hi(){
return "hello "+ app_name;
}
}