(SpringCloud Config Server&Client)
SpringCloud的分布式配置中心
本文记录的是SpringCloud的分布式配置方式,多个微服务读取共同的配置及每个微服务特殊的配置,比较简单。
这个是我写的简单的eureka搭建https://blog.csdn.net/weixin_38837447/article/details/100537227
配置中心服务
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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.xxx.yyy</groupId>
<artifactId>config-server</artifactId>
<version>1.0.1-SNAPSHOT</version>
<description>config-server project for Spring Boot</description>
<packaging>pom</packaging>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
<dependencies>
<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>
</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>
主要是
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
eureka不加也可以,我这里是因为springcloud的项目中用到了eureka,如果只是单纯的做一个配置中心,可以不加。
application.yml
server:
port: 8891
spring:
application:
name: config-server
#本地配置方式
cloud:
config:
server:
native:
search-locations: classpath:/data
label: master
profiles:
active: native
#如果是磁盘地址则search-locations: file:/D://data
#git配置方式
# cloud:
# config:
# server:
# git:
# uri: https://github.com/xxxx/data
# search-paths: /**
# username:
# password:
# label: master
eureka:
client:
serviceUrl:
defaultZone: http://127.0.0.1:8890/eureka/
配置文件提供了本地和git两种读取方式,根据自己需求选择。
项目结构
如果是git上的配置
文件中按照yml的格式随便写几个键值对,或者properties也可以,文件后缀会自动识别。
启动类注解
@EnableEurekaClient
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
此时已经完成了配置服务的搭建,很简单吧。
测试
访问http://127.0.0.1:8891/base-dev.yml 或者 http://127.0.0.1:8891/base/dev 就可以看到文件中的内容了,请求的路径多种多样,有兴趣的可以自己去网上搜一下。大概就是${application} ${label} ${profile}用符号拼接起来,后缀yml或者properties都可以。
能看到文件内容说明服务端已经配置成功了。
配置简单客户端
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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.xxx.yyy</groupId>
<artifactId>config-client</artifactId>
<version>1.0.1-SNAPSHOT</version>
<description>config-client project for Spring Boot</description>
<packaging>pom</packaging>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.SR2</spring-cloud.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<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>
</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>
主要是
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
bootstrap.yml
#采用bootsrap.yml 优先级高于application.yml,高于类的加载。否则会导致有些远程配置还未读取到而报错。
spring:
application:
name: config-client
cloud:
config:
uri: http://127.0.0.1:8891/ #配置中心地址
discovery:
service-id: config-server #配置服务名
name: ${spring.application.name},base #读取的文件名的前缀,多个文件有相同的值以后面的为准
label: master #label 与配置服务保持一致 默认master
profile: dev #文件后缀名 (文件名: name-profile)
需要注意的点都写在文件中了,如果不是非要采用application.yml就采用bootstrap.yml吧,因为是读取配置中心的文件,所以有些数据需要提前获取,否则可能报错。而bootstrap的优先级高于application,也高于类的加载,所以会最先获取到远程文件中的数据,避免报错。如果非要用application,就去百度搜索一下怎么配置吧。
然后读取的配置中心的文件就是 $ {name} - ${profile}.yml。name可以有多个,放在后面的name优先级较高。所以这里会读取base-dev.yml和config-client-dev.yml中的数据。
启动类注解
@EnableEurekaClient
@SpringBootApplication
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
}
我这里用了eureka,而配置文件没有配置eureka,是由于将相关配置放在了配置中心。端口号同理。
Controller
@RestController
public class MyController {
@Value("${info}")
private String info;
@Value("${name1}")
private String name1;
@Value("${name2}")
private String name2;
@RequestMapping("/info")
public String info(){
return "info:"+info+",name1:"+name1+",name2:"+name2;
}
}
用一个Controller来测试读取配置中心的文件是否成功,不成功的话@Value会报错。
项目结构
测试
能启动成功就说明没有问题了 。访问http://127.0.0.1:8102/info可以看到返回的数据。
可以看出,2个文件中的值都能去读到了。从info的值可以看出,配置中name中放在后面的base的优先级较高。
小结
没什么难点,细心点就好,我在网上找资料的时候,yml配置空格多一个少一个就错了,然后读取不到文件而出错。如果怕错可以直接复制。eureka不需要的话记得把注解和相关pom都删除。