Consul3-使用consul作为配置中心

           在前面的文章中学习了consul在windows下的安装配置，然后consul作为spring boot的服务发现和注册中心，详细的参考：

https://blog.csdn.net/j903829182/article/details/80960802

https://blog.csdn.net/j903829182/article/details/80960917

            在这里将学习consul作为springboot的配置中心，有spring cloud config的功能。这里还是以前面consul文章里面的代码为基础进行学习，不在进行重复的代码。

       consul作为配置中心，需要引入配置的jar包，pom.xml的内如修改如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. 	<modelVersion>4.0.0</modelVersion>
  5.  
  6. 	<groupId>com.jack</groupId>
  7. 	<artifactId>consul_study1</artifactId>
  8. 	<version>0.0.1-SNAPSHOT</version>
  9. 	<packaging>jar</packaging>
  10.  
  11. 	<name>consul_study1</name>
  12. 	<description>Demo project for Spring Boot</description>
  13.  
  14. 	<!--<parent>
  15. 		<groupId>org.springframework.boot</groupId>
  16. 		<artifactId>spring-boot-starter-parent</artifactId>
  17. 		<version>2.0.3.RELEASE</version>
  18. 		<relativePath/> <!– lookup parent from repository –>
  19. 	</parent>-->
  20.  
  21. 	<parent>
  22. 		<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-parent -->
  23. 			<groupId>org.springframework.cloud</groupId>
  24. 			<artifactId>spring-cloud-starter-parent</artifactId>
  25. 			<version>Finchley.RELEASE</version>
  26. 		<relativePath/>
  27. 	</parent>
  28. 	<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-config -->
  29.  
  30.  
  31. 	<properties>
  32. 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  33. 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  34. 		<java.version>1.8</java.version>
  35. 	</properties>
  36.  
  37. 	<dependencies>
  38. 		<dependency>
  39. 			<groupId>org.springframework.boot</groupId>
  40. 			<artifactId>spring-boot-starter-web</artifactId>
  41. 		</dependency>
  42.  
  43. 		<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-consul-discovery -->
  44. 		<dependency>
  45. 			<groupId>org.springframework.cloud</groupId>
  46. 			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
  47. 			<!--<version>2.0.0.RELEASE</version>-->
  48. 		</dependency>
  49.  
  50. 		<!--feign依赖 配置-->
  51. 		<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-feign -->
  52. 		<dependency>
  53. 			<groupId>org.springframework.cloud</groupId>
  54. 			<artifactId>spring-cloud-starter-feign</artifactId>
  55. 			<version>1.4.5.RELEASE</version>
  56. 		</dependency>
  57.  
  58.  
  59. 		<dependency>
  60. 			<groupId>com.jack</groupId>
  61. 			<artifactId>consul-api</artifactId>
  62. 			<version>1.0.0</version>
  63. 		</dependency>
  64.  
  65. 		<!--consul中健康检查需要用到actuator，不添加会check failing-->
  66. 		<!--<dependency>
  67. 			<groupId>org.springframework.boot</groupId>
  68. 			<artifactId>spring-boot-starter-actuator</artifactId>
  69. 		</dependency>-->
  70.  
  71. 		<dependency>
  72. 			<groupId>org.springframework.cloud</groupId>
  73. 			<artifactId>spring-cloud-starter-consul-config</artifactId>
  74. 		</dependency>
  75.  
  76.  
  77. 		<dependency>
  78. 			<groupId>org.springframework.boot</groupId>
  79. 			<artifactId>spring-boot-starter-test</artifactId>
  80. 			<scope>test</scope>
  81. 		</dependency>
  82.  
  83.  
  84. 	</dependencies>
  85.  
  86. 	<build>
  87. 		<plugins>
  88. 			<plugin>
  89. 				<groupId>org.springframework.boot</groupId>
  90. 				<artifactId>spring-boot-maven-plugin</artifactId>
  91. 			</plugin>
  92. 		</plugins>
  93. 	</build>
  94.  
  95.  
  96. </project>


  上面主要是引入了：

  1. <!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-starter-consul-discovery -->
  2. 		<dependency>
  3. 			<groupId>org.springframework.cloud</groupId>
  4. 			<artifactId>spring-cloud-starter-consul-discovery</artifactId>
  5. 			<!--<version>2.0.0.RELEASE</version>-->
  6. 		</dependency>



1，修改配置文件  

 1）添加  bootstrap.yml配置文件

  1. spring:
  2.   cloud:
  3.     consul:
  4.       host: localhost
  5.       #host: 00.0.100.200
  6.       port: 8500
  7.       #enabled将此值设置为“false”禁用Consul配置
  8.       config:
  9.         enabled: true   #默认是true --
  10.         format: YAML    # 表示consul上面文件的格式 有四种 YAML PROPERTIES KEY-VALUE FILES
  11.         #data-key: configuration    #表示consul上面的KEY值(或者说文件的名字) 默认是data
  12.         data-key: data    #表示consul上面的KEY值(或者说文件的名字) 默认是data
  13.         #prefix设置配置值的基本文件夹
  14.         #defaultContext设置所有应用程序使用的文件夹名称
  15.         #profileSeparator设置用于使用配置文件在属性源中分隔配置文件名称的分隔符的值

2）添加application-dev.yml配置文件，配置如下：

  1. spring:
  2.   cloud:
  3.     consul:
  4.       host: localhost
  5.       port: 8500
  6.       discovery:
  7.         #healthCheckPath: ${management.contextPath}/health
  8.         healthCheckPath: /health
  9.         healthCheckInterval: 15s
  10.         instance-id: consul1
  11.         enabled: true
  12.       enabled: true
  13.   application:
  14.     name: consul1
  15. server:
  16.   port: 8081

3）修改application.yml配置文件

  1. spring:
  2.   profiles:
  3.     active: dev

   以上就是一些配置文件的信息了，都是在resource目录下。


2，java代码

1）添加一个配置类

  1. package com.jack.consul_study1.config;
  2.  
  3. import org.springframework.boot.context.properties.ConfigurationProperties;
  4.  
  5. /**
  6.  * create by jack 2018/7/15
  7.  */
  8. @ConfigurationProperties(prefix = "student")
  9. public class StudentConfig {
  10.     private String name;
  11.     private  int age;
  12.     private String sex;
  13.  
  14.     public String getName() {
  15.         return name;
  16.     }
  17.  
  18.     public void setName(String name) {
  19.         this.name = name;
  20.     }
  21.  
  22.     public int getAge() {
  23.         return age;
  24.     }
  25.  
  26.     public void setAge(int age) {
  27.         this.age = age;
  28.     }
  29.  
  30.     public String getSex() {
  31.         return sex;
  32.     }
  33.  
  34.     public void setSex(String sex) {
  35.         this.sex = sex;
  36.     }
  37.  
  38.     @Override
  39.     public String toString() {
  40.         return "StudentConfig{" +
  41.                 "name='" + name + '\'' +
  42.                 ", age=" + age +
  43.                 ", sex='" + sex + '\'' +
  44.                 '}';
  45.     }
  46. }

2）修改测试的控制器，添加测试代码

  1. package com.jack.consul_study1.controller;
  2.  
  3. import com.jack.consul_study1.api.Chinese;
  4. import com.jack.consul_study1.config.StudentConfig;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.beans.factory.annotation.Value;
  7. import org.springframework.web.bind.annotation.RequestMapping;
  8. import org.springframework.web.bind.annotation.RestController;
  9.  
  10. /**
  11.  * create by jack 2018/7/8
  12.  */
  13. @RestController
  14. @RequestMapping("/test")
  15. public class TestController {
  16.     @Autowired
  17.     private Chinese chinese;
  18.  
  19.     @Value("${myName}")
  20.     private String myName;
  21.  
  22.     @Autowired
  23.     private StudentConfig studentConfig;
  24.  
  25.     @RequestMapping("/hello")
  26.     public String testHello(String name){
  27.         System.out.println("my name is : "+myName);
  28.         return chinese.sayHello(name);
  29.     }
  30.  
  31.     @RequestMapping("/myname")
  32.     public String testHello(){
  33.         System.out.println("my name is : "+myName);
  34.         return myName;
  35.     }
  36.  
  37.     @RequestMapping("/config")
  38.     public String testConfig(){
  39.         System.out.println(studentConfig.toString());
  40.         return studentConfig.toString();
  41.     }
  42.  
  43.  
  44.  
  45. }

3）主类添加注解@EnableConfigurationProperties

  1. package com.jack.consul_study1;
  2.  
  3. import com.jack.consul_study1.config.StudentConfig;
  4. import org.springframework.boot.SpringApplication;
  5. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. import org.springframework.boot.context.properties.EnableConfigurationProperties;
  7. import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
  8. import org.springframework.cloud.openfeign.EnableFeignClients;
  9.  
  10.  
  11. @SpringBootApplication
  12. @EnableDiscoveryClient
  13. @EnableFeignClients
  14. @EnableConfigurationProperties({StudentConfig.class})
  15. public class ConsulStudy1Application {
  16.  
  17. 	public static void main(String[] args) {
  18. 		SpringApplication.run(ConsulStudy1Application.class, args);
  19. 	}
  20. }

   注意：属性配置类的class需要添加到springboot的属性配置注解里面，eg：

@EnableConfigurationProperties({StudentConfig.class})
      不添加的话，不能通过@Autowired注解，注入属性配置类，那么就需要在属性配置类上使用spring的bean注解，标记时一个bean

     到这里，代码已经完成了，启动consul服务器，下面在consul里面进行配置了


3，consul配置

      consul作为配置中心的参考文档：https://springcloud.cc/spring-cloud-dalston.html#spring-cloud-consul-config

 1）创建配置，如下图

      

         输入key和value

key为：config/consul1,dev/data

value：

myName: jack
student: 
  name: jack
  age: 18
  sex: 男


注意value用的是yml格式的配置，冒号后面有一个空格


4，运行程序测试

1）测试通过@Value注入

  1. @Value("${myName}")
  2.     private String myName;
  测试url：http://localhost:8081/test/myname

结果如下：






2）测试通过@ConfigurationProperties进行属性配置

测试url：http://localhost:8081/test/config





    总结：

       到这里consul的简单使用就完成了，consul有两个功能，一个是consul作为注册中心，另一个是consul作为配置中心。在本文中consul作为配置中心，有一个点需要注意，通过@Value注入的属性，修改consul的配置后，属性不能立即生效，需要服务重启。而通过@ConfigurationProperties注入的属性，修改consul的配置后，属性会立即生效，所以建议如果需要动态生效的配置，最好使使用@ConfigurationProperties进行属性的注入。

     

     源代码地址：源码url

欢迎加群：331227121，一起学习交流


 

原文地址：https://blog.csdn.net/j903829182/article/details/81050507
posted @ 2019-08-08 09:27  星朝  阅读(3437)  评论(0)  编辑  收藏  举报