SpringCloud Config简介
Spring Cloud Config 是 Spring Cloud 团队创建的一个全新项目,用来为分布式系统中的基础设施和微服务应用提供集中化的外部配置支持,它分为服务端与客户端两个部分。其中服务端也称为分布式配置中心,它是一个独立的微服务应用,用来连接配置仓库并为客户端提供获取配置信息、加密 / 解密信息等访问接口;而客户端则是微服务架构中的各个微服务应用或基础设施,它们通过指定的配置中心来管理应用资源与业务相关的配置内容,并在启动的时候从配置中心获取和加载配置信息。Spring Cloud Config 实现了对服务端和客户端中环境变量和属性配置的抽象映射,所以它除了适用于 Spring 构建的应用程序之外,也可以在任何其他语言运行的应用程序中使用。由于 Spring Cloud Config 实现的配置中心默认采用 Git 来存储配置信息,所以使用 Spring Cloud Config 构建的配置服务器,天然就支持对微服务应用配置信息的版本管理,并且可以通过 Git 客户端工具来方便的管理和访问配置内容。当然它也提供了对其他存储方式的支持,比如:GIT仓库、SVN 仓库、本地化文件系统。
Config Server端主要和Git/SVN服务器
通俗点,就是统一管理配置,包括方便切换环境配置,以及修改配置无需动代码,省心省力;
如果用上SpringCloud Bus,能实现无需重启,自动感知配置变化以及应用新配置;
Config服务端搭建(Server)
我们先在Github上建一个仓库,克隆到本地来,然后上传一个配置文件到Github上,我这里就上传了我后面要用的文件了
application.yml
---
spring:
profiles:
active: dev
---
spring:
profiles: dev
port: 111
---
spring:
profiles: test
port: 222
新建一个项目microservice-config-server-4001
然后新建一个项目导入pom依赖,修改你的父工程目录
<?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>com.lst</groupId>
<artifactId>springcloud</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>microservice-config-server-4001</artifactId>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</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>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
配置application.yml文件,把你Github仓库的https访问路径配置好
server:
port: 4001
spring:
application:
name: microservice-config
cloud:
config:
server:
git:
uri: https://github.com/liaosentao/microservice-config.git
给启动类添加注解
package com.lst.microserviceconfigserver4001;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
@SpringBootApplication
@EnableConfigServer
public class MicroserviceConfigServer4001Application {
public static void main(String[] args) {
SpringApplication.run(MicroserviceConfigServer4001Application.class, args);
}
}
本地Hosts加个本地域名映射:
127.0.0.1 configserver.lst.com
效果展示:
Config客户端搭建(Client)
在本地仓库添加两个配置文件并上传到Github
crm-dev.yml
port:
777
crm-test.yml
port:
888
新建项目microservice-config-client-5001
导入pom依赖,修改父工程
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
我们项目启动的时候,就要调用server config端,获取配置信息,所以这里要bootstrap.yml配置文件,优先级最高:
spring:
application:
name: application-dev
cloud:
config:
name: crm
uri: http://configserver.lst.com:4001
profile: dev
label: master
fail-fast: true
application.yml
server:
port: 5001
context-path: /
配置一个我们测试用的controller
ConfigClientController
package com.lst.microserviceconfigclient5001.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class ConfigClientController {
@Value("${port}")
private String port;
@GetMapping("/getPort")
public String getPort() {
return "测试你访问的yml文件的端口是:【"+port+"】";
}
}
本地hosts我们加给配置:
127.0.0.1 client-config.lst.com
启动项目:然后页面访问:
http://client-config.lst.com:5001/getPort
即可获取远程端口配置信息;
我们可以看到我们访问的端口号是777,因为我们在bootstrap.yml中配置的是dev,所以读取出来的是777,改成test就读取出888了
Config整合Eureka
eureka整合config以及服务器提供者整合config
我们先上传配置文件到Github
eureka_config.yml
spring:
profiles:
active:
- dev
---
server:
port: 2004
context-path: /
spring:
profiles: dev
eureka:
instance:
hostname: localhost
client:
register-with-eureka: false
fetch-registry: false
service-url:
defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
---
server:
port: 2005
context-path: /
spring:
profiles: test
eureka:
instance:
hostname: localhost
client:
register-with-eureka: false
fetch-registry: false
service-url:
defaultZone: http://${eureka.instance.hostname}:${server.port}/eureka/
新建项目:microservice-eureka-server-config
配置两个配置文件
application.yml
spring:
application:
name: microservice-student-provider-config
bootstrap.yml
spring:
application:
name: microservice-student-provider-config
cloud:
config:
name: provider_config
uri: http://configserver.lst.com:4001 # 配置configserver地址
profile: dev # 级别
label: master # 分支 git中 默认master
在启动类加上Eureka的注解:@EnableEurekaServer
然后再搭建一个生产者注册进这个注册中心:microservice-student-provider-config
一样的首先上传一个配置文件
provider_config.yml
spring:
profiles:
active: dev
---
server:
port: 1007
context-path: /
# 数据源配置
spring:
profiles: dev
application:
name: microservice-student
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/normal?useUnicode=true&characterEncoding=utf8
username: root
password: 123
jpa:
hibernate:
ddl-auto: update
show-sql: true
eureka:
instance:
hostname: localhost
appname: microservice-student
instance-id: microservice-student:1007
prefer-ip-address: true
client:
service-url:
defaultZone: http://localhost:2004/eureka
info:
groupId: com.lst.testSpringcloud
artifactId: microservice-student-provider-config-1007
version: 1.0-SNAPSHOT
userName: http://lst.com
phone: 123456
---
server:
port: 1008
context-path: /
# 数据源配置
spring:
profiles: test
application:
name: microservice-student
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driver-class-name: com.mysql.jdbc.Driver
url: jdbc:mysql://localhost:3306/normal?useUnicode=true&characterEncoding=utf8
username: root
password: 123
jpa:
hibernate:
ddl-auto: update
show-sql: true
eureka:
instance:
hostname: localhost
appname: microservice-student
instance-id: microservice-student:1008
prefer-ip-address: true
client:
service-url:
defaultZone: http://localhost:2004/eureka
info:
groupId: com.lst.testSpringcloud
artifactId: microservice-student-provider-config-1008
version: 1.0-SNAPSHOT
userName: http://lst.com
phone: 123456
导入所有的pom依赖
<?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>com.lst</groupId>
<artifactId>springcloud</artifactId>
<version>1.0-SNAPSHOT</version>
</parent>
<artifactId>microservice-student-provider-config</artifactId>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>com.lst</groupId>
<artifactId>microservice-common</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
</dependency>
<!-- 修改后立即生效,热部署 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>springloaded</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
</dependency>
<dependency>
<groupId>com.lst</groupId>
<artifactId>microservice-common</artifactId>
<version>1.0-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
<!--添加注册中心Eureka相关配置-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
<!-- actuator监控引入 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
启动项目,输入:localhost:2004
进入Eureka注册中心能看到你的项目注册成功就Ok
Config配置搜索路径
前面我们所有的GIT远程端配置文件都是跟目录的,所有请求默认都是根目录,但是有时候,项目很多,配置文件需要根据子目录来划分,这时候,就需要来配置搜索路径了;比如aaa项目的配置文件放aaa目录下,bbb项目的配置文件放bbb目录下,不配置的话 是找不到的那些配置文件的,我们需要配置search-paths属性实现;
microservice-config-server-4001 configserver端 加个配置
server:
port: 4001
spring:
application:
name: microservice-config
cloud:
config:
server:
git:
uri: https://github.com/liaosentao/microservice-config.git
search-paths: aaa,bbb,ccc
分别搞3个目录aaa,bbb,ccc 里面分别放3个配置文件 nns.yml,nns2.yml,nn3.yml;
配置内容大体差不多,随便写;
spring:
profiles:
active: dev
---
spring:
profiles: dev
name: aaadev
---
spring:
profiles: test
name: aaatest
然后传到远端git;
aaa
bbb
ccc
over。。。