首先在github上面创建了一个项目config-repo用来存放配置文件,为了模拟开发生产测试环境,我们创建以下四个配置文件:
// 开发环境
robot-dev.properties
// 测试环境
robot-test.properties
// 生产环境
robot-pro.properties
// 以上配置文件中共同内容
robot.properties
为了验证不同环境下,可以加载不同的配置值,每个环境中都添加server.port这个值来修改tomcat的启动端口。这样可以比较直观的看到程序读取了不同的配置。
server 端
1、 创建项目spring-cloud-config-server
2、添加依赖
<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>
3、配置文件
spring.application.name=spring-cloud-config-server
spring.cloud.config.server.git.uri=https://github.com/calcyu/config-repo
spring.cloud.config.server.git.username=calcyu
spring.cloud.config.server.git.password=密码
远程配置项目的本地缓存目录,注意不要指定为项目根目录,会把项目代码全部删除
spring.cloud.config.server.git.basedir=./config/basedir
eureka.client.service-url.defaultZone=http://localhost:8000/eureka/
4、启动类
启动类添加@EnableConfigServer,激活对配置中心的支持
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
到此server端相关配置已经完成
5、测试
首先我们先要测试server端是否可以读取到github上面的配置信息,直接访问:http://localhost:8080/robot-dev.yml
返回信息如下:
eureka:
client:
service-url:
defaultZone: http://localhost:8000/eureka/
mysql:
password: 321
username: root
password: 123
server:
port: 9090
spring:
application:
name: robot
rabbitmq:
host: 192.168.190.187
password: admin
port: 5672
username: admin
username: meimei
上述的返回的信息包含了配置文件的位置、版本、配置文件的名称以及配置文件中的具体内容,说明server端已经成功获取了git仓库的配置信息。
可以修改扩展名来返回不同格式的配置信息
例如:
http://localhost:8080/robot-dev.properties
http://localhost:8080/robot-dev.yml
http://localhost:8080/robot-dev.json
http://localhost:8080/robot-test.properties
http://localhost:8080/robot-test.yml
http://localhost:8080/robot-test.json
http://localhost:8080/robot-pro.properties
http://localhost:8080/robot-pro.yml
http://localhost:8080/robot-pro.json
本地管理配置文件
Spring Cloud Config也提供本地存储配置的方式。
把配置文件修改为
spring.application.name=spring-cloud-config-server
spring.cloud.config.server.git.uri=https://github.com/calcyu/config-repo
spring.cloud.config.server.git.username=calcyu
spring.cloud.config.server.git.password=密码
远程配置项目的本地缓存目录,注意不要指定为项目根目录,会把项目代码全部删除
spring.cloud.config.server.git.basedir=./config/basedir
eureka.client.service-url.defaultZone=http://localhost:8000/eureka/
spring.cloud.config.server.native.searchLocations=file:E:/calcyu/config
当客户端发送请求,配置中心会从E:/calcyu/config查找对应的配置文件。
虽然Spring Cloud Config提供了这样的功能,但是为了支持更好的管理内容和版本控制的功能,还是推荐使用git的方式。
client 端
主要展示如何在业务项目中去获取server端的配置信息
创建项目spring-cloud-robot
1、添加依赖
<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.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
新版本eureka客户端需要引入spring-boot-starter-web包,eureka服务端不需要,自身包含web依赖
2、配置文件
把配置文件application.properties改名为bootstrap.properties
配置bootstrap.properties如下:
spring.application.name=robot
eureka.client.service-url.defaultZone=http://localhost:8000/eureka/
从注册中心获取配置中心服务id
spring.cloud.config.discovery.service-id=spring-cloud-config-server
spring.cloud.config.discovery.enabled=true
spring.profiles.active=dev
默认分支为master
spring.cloud.config.label=master
以上配置:客户端会请求http://localhost:8080/robot-dev.yml获取配置信息。
spring.application.name:对应{application}部分
spring.profiles.active:对应{profile}部分
spring.cloud.config.label:对应git的分支。如果配置中心使用的是本地存储,则该参数无用
spring.cloud.config.uri:配置中心的具体地址
spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于扩展为高可用配置集群。
特别注意:上面这些与spring-cloud相关的属性必须配置在bootstrap.properties中,config部分内容才能被正确加载。因为config的相关配置会先于application.properties,而bootstrap.properties的加载也是先于application.properties。
3、启动类
启动类添加@EnableConfigServer,激活对配置中心的支持
@SpringBootApplication
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
}
启动类只需要@SpringBootApplication注解就可以
4、web测试
创建两个类MysqlConfig.java和GetConfigController.java
使用@ConfigurationProperties("mysql")定义参数前缀,通过成员变量username和password来获取参数的值
MysqlConfig.java
@Component
@ConfigurationProperties("mysql")
public class MysqlConfig {
private String username;
private String password;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
上面类可以获取以下配置项的值
mysql:
username: admin
password: 123
使用@Value注解来获取配置中username和password参数的值
GetConfigController.java
@RestController
public class GetConfigController {
@Value("${username}")
private String userName;
@Value("${password}")
private String password;
@GetMapping("userinfo")
public String getUserInfo() {
return String.format("用户名:%s,密码:%s", userName, password);
}
@Autowired
private MysqlConfig mysqlConfig;
@GetMapping("mysql")
public String getMysql() {
return String.format("用户名:%s,密码:%s", mysqlConfig.getUsername(), mysqlConfig.getPassword());
}
}
启动项目后依次访问:
http://desktop-deqbgel:9090/userinfo
http://desktop-deqbgel:9090/mysql
如果显示对应的值说明已经正确的从server端获取到了参数,
到此一个完整的服务端提供配置服务,客户端获取配置参数的例子就完成了。