1 Config介绍
1.1 目前遇到的问题
我们现在已经有十多个工程了,并且每加一个工程,一定会有一个application.properties
,类似的东西多了,就会产生两个问题:代码膨胀和不易于统一管理。如果我们有40个这样的微服务,只是数据库地址迁移,就得改40次,运维工程师就得偷偷哭了。
并且在实际的生产中,开发,测试,上线等配置并不相同,仅仅通过简单的配置文件无法满足我们的需求。
1.2 Config Server
我们希望可以统一对配置进行管理。spring cloud提供的解决方案是Config Server.
2 Config配置总控中心的搭建
推荐将Config
和git与github整合。
2.1 准备工作
在GitHub上新建一个名为springcloud-config的新仓库,仓库里有如下初始化配置文件。
将其git clone
到本地。本地修改配置文件,更新到github仓库,使用如下命令提交。
也可以在github仓库直接修改。
#config-dev.yml config: info: "main branch,springcloud-config/config-dev.yml version=1" ####################################### #config-prod.yml config: info: "main branch,springcloud-config/config-prod.yml version=1" ####################################### #config-test.yml config: info: "main branch,springcloud-config/config-test.yml version=1"
2.2 建模块
新建配置中心模块。
2.3 写pom
<dependencies> <!--config server--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> <!--eureka client(通过微服务名实现动态路由)--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</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-actuator</artifactId> </dependency> <!--热部署--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies>
2.4 写yml
application.yml
server: port: 3344 spring: application: name: cloud-config-center #注册进Eureka服务器的微服务名 cloud: config: server: git: uri: https://github.com/qq995931576/springcloud-config.git #git的仓库地址 search-paths: #搜索目录 - springcloud-config label: main #读取的分支 eureka: client: service-url: defaultZone: http://localhost:7001/eureka #服务注册到的eureka地址
注意替换githu配置仓库springcloud-config
的uri地址。
2.5 主启动
@EnableConfigServer @SpringBootApplication public class ConfigMain3344 { public static void main(String[] args) { SpringApplication.run(ConfigMain3344.class, args); } }
2.6 修改host
修改windows下的host文件,增加ip到域名的映射。
修改:C:\Windows\System32\drivers\etc\hosts ,增加如下内容
# Config 127.0.0.1 config-3344.com
2.7 测试
测试通过Config
微服务是否可以访问到GitHub上的配置文件。
启动7001Eureka,启动微服务3344,
访问:http://config-3344.com:3344/main/config-dev.yml。
注:如果没有配置域名映射可以替换为ip,即访问:http://127.0.0.1:3344/main/config-dev.yml。
效果如下:
至此,配置架构图的下半部分完成打通。
实际上,测试时配置的url书写方式有多种,第一种(也是最清晰的)。
再多介绍几种,第二种,省略lable。
这种情况会默认读取master分支。因为我们在application.yml中配置了默认lable。
第三种,将lable写到最后面。
这种方式得到的是json字符串
3.Config客户端配置
3.1 建模块
3.2 写pom
<dependencies> <!--config client--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency> <!--eureka client(通过微服务名实现动态路由)--> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--热部署--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <scope>runtime</scope> <optional>true</optional> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies>
3.3 写yml
这里有使用bootstrap.yml.
server: port: 3355 spring: application: name: config-client cloud: config: #config客户端配置 label: main #分支名称 name: config #配置文件名称 这三个综合:master分支上的config-dev.yml的配置文件 profile: dev #读取后缀名称 被读取到http://config-3344.com:3344/main/config/dev uri: http://localhost:3344 #配置中心地址 记得加上【http://】 eureka: client: service-url: defaultZone: http://localhost:7001/eureka #服务注册到的eureka地址 #defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka,http://eureka7003.com:7003/eureka
3.4 主启动
@EnableEurekaClient @SpringBootApplication public class ConfigClientMain3355 { public static void main(String[] args) { SpringApplication.run(ConfigClientMain3355.class, args); } }
3.5 业务类
客户端做了一件事,将配置信息的url转换为了rest风格的api。
@RestController public class ConfigClientController { //来读取github上面的配置文件config.info的信息 @Value("${config.info}") //spring的@Value注解 private String configInfo; @GetMapping("/configInfo") public String getConfigInfo(){ return configInfo; } }
3.6 测试
测试,启动7001,3344,3355
访问:http://localhost:3355/configInfo
将bootstrap.yml中的profile更改
spring: application: name: config-client cloud: config: #config客户端配置 label: main #分支名称 name: config #配置文件名称 这三个综合:master分支上的config-dev.yml的配置文件 profile: test #读取后缀名称 被读取到http://config-3344.com:3344/main/config/dev uri: http://localhost:3344 #配置中心地址 记得加上【http://】
再访问内容就刷新了。
测完记得改回去哦。
4.手动动态刷新
问题:
如果github仓库中的config-dev.yml文件发生变更
#config-dev.yml config: info: "main branch,springcloud-config/config-dev.yml version=2"
访问:http://config-3344.com:3344/main/config-dev.yml,内容刷新
访问http://localhost:3355/configInfo,内容不会刷新,除非客户端重启。
现在解决下。
往config客户端3355在pom中添加,该依赖可以用来进行监控。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency>
修改bootstrap.yml,添加监控端点。
#暴露监控端点 management: endpoints: web: exposure: include: "*"
在contorllre添加注解。
重启3355,再测试,问题没解决,配置还是没有生效。
因为还差一步,上面只是暴露了端口给外界进行更新,并且监控外界的请求。还没有发更新请求啊。因此需要运维工程师发个post请求过来。
来吧,curl -X POST “http://localhost:3355/actuator/refresh”
再测试,欧克了。这样就避免了客户端的重启。
不过上面的方式有点麻烦啊,运维工程师改完配置,还需要发请求。后面文章介绍更好的方式。