注意事项

  • 启动类上需要设置@EnableScheduling注解 配置才能自动刷新
  • 启动类上需要设置@EnableConfigurationProperties({StudentConfig.class})
  • model类上设置@ConfigurationProperties(prefix = “student”) //前缀:对应consul 配置中心的 student 前缀
  • 通过@Value注入的属性,修改consul的配置后,属性不能立即生效,需要服务重启。而通过@ConfigurationProperties注入的属性,修改consul的配置后,属性会立即生效,所以建议如果需要动态生效的配置,最好使用@ConfigurationProperties进行属性的注入。
  • consul可以作为配置中心和注册中心
    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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0<&#47;modelVersion>
    <parent>
    <groupId>org.springframework.boot<&#47;groupId>
    <artifactId>spring-boot-starter-parent<&#47;artifactId>
    <version>2.2.4.RELEASE<&#47;version>
    <relativePath/> <!-- lookup parent from repository -->
    <&#47;parent>
    <groupId>com.guochen<&#47;groupId>
    <artifactId>consuldemo<&#47;artifactId>
    <version>0.0.1-SNAPSHOT<&#47;version>
    <name>consuldemo<&#47;name>
    <description>Demo project for Spring Boot<&#47;description>

    <properties>
    <java.version>1.8<&#47;java.version>
    <spring-cloud.version>Hoxton.SR1<&#47;spring-cloud.version>
    <&#47;properties>

    <dependencies>
    <dependency>
    <groupId>org.springframework.boot<&#47;groupId>
    <artifactId>spring-boot-starter-web<&#47;artifactId>
    <&#47;dependency>
    <dependency>
    <groupId>org.springframework.cloud<&#47;groupId>
    <artifactId>spring-cloud-starter-consul-config<&#47;artifactId>
    <&#47;dependency>
    <dependency>
    <groupId>org.springframework.cloud<&#47;groupId>
    <artifactId>spring-cloud-starter-consul-discovery<&#47;artifactId>
    <&#47;dependency>
    <dependency>
    <groupId>org.springframework.cloud<&#47;groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix<&#47;artifactId>
    <&#47;dependency>
    <dependency>
    <groupId>org.springframework.boot<&#47;groupId>
    <artifactId>spring-boot-starter-actuator<&#47;artifactId>
    <&#47;dependency>
    <&#47;dependencies>

    <dependencyManagement>
    <dependencies>
    <dependency>
    <groupId>org.springframework.cloud<&#47;groupId>
    <artifactId>spring-cloud-dependencies<&#47;artifactId>
    <version>${spring-cloud.version}<&#47;version>
    <type>pom<&#47;type>
    <scope>import<&#47;scope>
    <&#47;dependency>
    <&#47;dependencies>
    <&#47;dependencyManagement>

    <build>
    <plugins>
    <plugin>
    <groupId>org.springframework.boot<&#47;groupId>
    <artifactId>spring-boot-maven-plugin<&#47;artifactId>
    <&#47;plugin>
    <&#47;plugins>
    <&#47;build>

    <&#47;project>

    bootstrap.yml
    spring:
    cloud:
    consul:
    host: localhost
    port: 8500
    #enabled将此值设置为“false”禁用Consul配置
    config:
    enabled: true #默认是true --
    format: YAML # 表示consul上面文件的格式 有四种 YAML PROPERTIES KEY-VALUE FILES
    data-key: data #表示consul上面的KEY值(或者说文件的名字) 默认是data
    # watch选项为配置监视功能,主要监视配置的改变
    watch:
    enabled: true
    delay: 10000
    wait-time: 30
    application.yml
    spring:
    application:
    name: consul-service
    profiles:
    active: dev
    cloud:
    consul:
    # 服务发现配置
    discovery:
    # 启用服务发现
    enabled: true
    # 启用服务注册
    register: true
    # 服务停止时取消注册
    deregister: true
    # 表示注册时使用IP而不是hostname
    prefer-ip-address: true
    # 执行监控检查的频率
    health-check-interval: 30s
    # 设置健康检查失败多长时间后,取消注册
    health-check-critical-timeout: 30s
    # 健康检查的路径
    health-check-path: /actuator/info
    # 服务注册标识,格式为:应用名称+服务器IP+端口
    instance-id: ${spring.application.name}:${spring.cloud.client.ip-address}:${server.port}

启动类

@SpringBootApplication
@EnableDiscoveryClient
@EnableScheduling //启用后,会定时拉取配置
@EnableConfigurationProperties({StudentConfig.class})
public class ApplicationStart {
public static void main(String[] args) {
SpringApplication.run(ApplicationStart.class, args);
}
}

model类

package io.guochen.consuldemo.model;
import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "student") //前缀:对应consul 配置中心的 student 前缀
public class StudentConfig {
private String name;
private int age;
private String sex;


public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

public int getAge() {
return age;
}

public void setAge(int age) {
this.age = age;
}

public String getSex() {
return sex;
}

public void setSex(String sex) {
this.sex = sex;
}
}

测试类

package io.guochen.consuldemo.controller;

import io.guochen.consuldemo.model.StudentConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class TestController {
@Autowired
private StudentConfig studentConfig;

@Value("${test.name}")
private String testname;
@RequestMapping("/test")
public StudentConfig testDescription() {
return studentConfig;
}
}

添加consul配置
注意:

  • 默认情况下,consul配置默认存储在/config文件夹中
  • myconsul为spring.application.name值,dev为spring.profiles.active值,data为data-key值
  • value用的是yml格式的配置,冒号后面有一个空格。
    a

a

程序启动后可以看到consul里已经注册成功
a

且配置可以正常读取
a