Spring Cloud Config 支持 Git 和 JDBC 做为后端存储库,默认是 Git 存储库,对于开发来说是方便且易于理解的;但对于运维来说,因涉及 Git 操作,可能就不那么方便了。
另外,如果能给分布式配置管理提供 Web 控制台来操作就非常直观和方便了,JDBC 存储库就可以较好的应用在 Web 应用中。
Config Server JDBC 存储库
Config Server
使用 JDBC 存储库,需要有数据库、添加 JDBC 和 数据库驱动依赖。这里以 MySQL 为例。
创建数据库和表,填充表数据
首先准备数据库和表。数据库名可以自定义,默认情况下,表名必须为 PROPERTIES,必须包含 APPLICATION、PROFILE、LABEL、KEY、VALUE 字段。
创建数据库CREATE DATABASE `config_repo`CHARACTER SET utf8;
创建表
CREATE TABLE `properties` ( `id` int(11) unsigned NOT NULL AUTO_INCREMENT, `APPLICATION` varchar(100) DEFAULT NULL, `PROFILE` varchar(20) DEFAULT NULL, `LABEL` varchar(20) DEFAULT NULL, `property_key` varchar(200) DEFAULT NULL, `property_value` varchar(200) DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8
注意:创建表时自定义了 KEY 和 VALUE 字段为 property_key、property_value。因为这里用的是 MySQL 数据库, KEY 是保留字符,如果 SQL 语句里直接使用会报语法错误。
添加 jdbc、config-server、mysql-connector-java 依赖
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.4.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.springcloud</groupId> <artifactId>config-server-jdbc</artifactId> <version>v1.0.0</version> <name>config-server-jdbc</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <spring-cloud.version>Greenwich.SR1</spring-cloud.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </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>
启动类上添加 @EnableConfigServer 注解开启 Config Server
@EnableConfigServer @SpringBootApplication public class ConfigServerJdbcApplication { public static void main(String[] args) { SpringApplication.run(ConfigServerJdbcApplication.class, args); } }
Config Server 配置
配置文件里设置存储库类型,配置数据源,重写了 SQL。
application.propertiesserver.port=9020 spring.application.name=config-service spring.profiles.active=jdbc #=========== datasource ================ #spring.datasource.name=master spring.datasource.url=jdbc:mysql://localhost:3306/config_repo?characterEncoding=utf-8&allowMultiQueries=true&autoReconnect=true&serverTimezone=GMT%2B8 spring.datasource.username=panda spring.datasource.password=123456 #=========== spring cloud ================ #spring.cloud.config.server.jdbc.order=0 # 默认 SQL 语句 #spring.cloud.config.server.jdbc.sql=SELECT KEY, VALUE from PROPERTIES where APPLICATION=? and PROFILE=? and LABEL=? # 重写 SQL 语句 spring.cloud.config.server.jdbc.sql=SELECT property_key AS `KEY`, property_value AS `VALUE` from properties where application=? and profile=? and label=?
spring.profiles.active=jdbc 配置存储库类型,默认是 Git。
spring.cloud.config.server.jdbc.sql=SELECT property_key ASKEY
, property_value ASVALUE
from properties where application=? and profile=? and label=?
重写了 SQL 语句,默认的 SQL 语句查询的字段 KEY 是 MySQL 里的保留字符,会直接报错。
Config Client
创建一个订单服务应用作为 Config Client。
添加 config、actuator 依赖
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.3.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.springcloud</groupId> <artifactId>service-order</artifactId> <version>v1.0.0</version> <name>service-order</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <spring-cloud.version>Greenwich.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-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-devtools</artifactId> <scope>runtime</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </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>
设置启动引导配置文件
bootstrap.properties
# Cloud Client spring.application.name=orderService spring.profiles.active=dev management.endpoints.web.exposure.include=* # JDBC Config Server 地址 spring.cloud.config.uri=http://localhost:9020
给配置存储库 config_repo 在插入数据
insert into `properties`(`id`,`APPLICATION`,`PROFILE`,`LABEL`,`property_key`,`property_value`) values (1,'orderService','dev','master','server.port','8010'), (2,'orderService','dev','master','common.properties.app-id','112233445566');
启动订单服务应用
可以看到,应用使用端口为 8010,表示使用远程配置成功。如果失败,则使用默认的 8080 端口启动。
查看运行环境和环境变量,并动态更新
运行环境端点:http://localhost:8010/actuator/env
刷新运行环境端点:http://localhost:8010/actuator/refresh
修改数据库里参数值,刷新运行环境。
与 Eureka 集成
在上面示例的基础上整合 Eureka ,通过服务发现来与 Config Server 通信获取远程配置源。Config Server 和 Config Client 都作为 Eureka Client 注册到 Eureka Server。
注册 Config Server
添加 eureka-client 依赖
pom.xml
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>
配置文件添加注册到 Eureka Server 的配置
application.properties
eureka.client.service-url.defaultZone=http://admin:123456@eureka.master.com:8761/eureka,http://admin:123456@eureka.slave.com:8762/eureka
运行 Config Server 应用。
注册 Config Client
添加 eureka-client 依赖
pom.xml
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency>
修改 bootstrap.properties 中的配置
增加启用 discovery 服务发现设置,设置注册到 Eureka Server,指定 Config Server 的 service ID。
bootstrap.properties
# Cloud Client spring.application.name=orderService spring.profiles.active=dev management.endpoints.web.exposure.include=* # 启用 Discovery, 注册到 Eureka spring.cloud.config.discovery.enabled=true eureka.client.service-url.defaultZone=http://admin:123456@eureka.master.com:8761/eureka,http://admin:123456@eureka.slave.com:8762/eureka spring.cloud.config.discovery.service-id=config-service
运行 Config Client 应用
查看启动日志,使用了远程配置的 8080 端口,表示服务发现成功,调用配置服务器成功。
注意:如果没有发现配置服务器,则会使用默认的 8080 端口启动,可以增加重试。
Config 详细配置
注意:本文归作者所有,未经作者允许,不得转载