springcloud使用consul作为配置中心
作者:廖文文
Spring Cloud 中文手册: https://springcloud.cc/spring-cloud-consul.html
也就是说在我们使用consul config时最好在consul 建立相应的目录结构 适用于某一个服务的目录结构以及适用于所有的服务的目录结构
本列consul web UI :springboot为我们提供了三种环境dev:默认开发环境 test:测试环境 prod:生产环境
PS:
1.每次当我们修改consul上面的配置信息的时候,会向我们的代码发送一个/refresh请求刷新我们的工程,通过使我们的取值动态的刷新,不需要重启项目, 但是当我们使用@Value进行取值的时候,虽然可会取到值也会刷新项目但是不会更改我们的取值,还是取到项目启动时候配置在consul上面的值,实时刷新。
2.当我们在全局的application的文件中配置跟某一个服务列如:server-sms中配置相同的属性时, server-sms这个项目启动的时候默认是先去找自己目录下面的配置,再去找全局的配置,如果自己目录下
实战:
pom.xml文件配置:
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-consul-config</artifactId> </dependency>
bootstarp.xml配置:(如果配置在application里面,他不会生效,bootstrap.yml先比applciation.properties加载)
spring: cloud: consul: host: 100.1.00.0 #host: 00.0.100.200 port: 8500 enabled: true config: enabled: true #默认是true -- format: YAML # 表示consul上面文件的格式 有四种 YAML PROPERTIES KEY-VALUE FILES data-key: configuration #表示consul上面的KEY值(或者说文件的名字) 默认是data
FORMAT举例说明两种(本列中使用的是server-sms项目的YAML):
PROPERTIES:
YAML:
取值方式:
1.通过EnabledConfigurationProperties注解取值(启动项目后修改consul上的属性值,项目中的属性值立即发生变化):
对应的bean:
//name要与consul上面的name写的一样,consul上面可以写多级目录 例如: userInfo: name: LiaoWenWen //对应的写ConfigurationProperties(prefix="userInfo ") 如果项目使用中配置化东西比较多 建议采用这种形式 @ConfigurationProperties() public class UserInfo { private String name;//要与consul上面一致 public String getName() { return name; } public void setName(String name) { this.name = name; }
controller代码取值:
@Autowired private UserInfo userInfo; @ApiOperation(value="获取consulInfo", notes="获取consulInfo") public String getConsulInfo() { return userInfo.getName(); }
项目启动类:
@SpringBootApplication @EnableDiscoveryClient @EnableConfigurationProperties({UserInfo.class}) public class Application { public static void main(String[] args){ SpringApplication.run(Application.class,args);}
2.通过Value注解取值(项目启动后修改consul上的值,项目中的值不发生变化,只有再次启动项目获取的值才是修改后的值,发送/refresh请求无效)
@Value private String name; @ApiOperation(value="获取consulInfo", notes="获取consulInfo") public String getConsulInfo(){ return name; }
3.static 取值
@Component @Configuration public class ConsulKV { public static String smsUrl; public static String username; public static String password; @Value("${ssbp.smsUrl}") public void setSmsUrl(String smsUrl) { ConsulKV.smsUrl = smsUrl; } @Value("${ccb.job.login.username}") public void setUsername(String username) { ConsulKV.username = username; } @Value("${ccb.job.login.password}") public void setPassword(String password) { ConsulKV.password = password; }
示例代码地址: https://github.com/LiaoWenn/spring-cloud-consul-config
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。