Springboot自动刷新yml配置文件内容，结合springcloud config,springbout bus消息中心

最新推荐文章于 2024-07-27 07:00:00 发布

Joe192

最新推荐文章于 2024-07-27 07:00:00 发布

阅读量2.6k

点赞数 1

分类专栏： springboot 文章标签： springcloud config

joe192168

本文链接：https://blog.csdn.net/Joe192/article/details/103875782

版权

springboot 专栏收录该内容

6 篇文章 0 订阅

订阅专栏

说明：配置文件是我们再熟悉不过的了，尤其是 Spring Boot 项目，除了引入相应的 maven 包之外，剩下的工作就是完善配置文件了，例如 mysql、redis 、security 相关的配置。除了项目运行的基础配置之外，还有一些配置是与我们业务有关系的，比如说七牛存储、短信相关、邮件相关，或者一些业务上的开关。

对于一些简单的项目来说，我们一般都是直接把相关配置放在单独的配置文件中，以 properties 或者 yml 的格式出现，更省事儿的方式是直接放到 application.properties 或 application.yml 中。但是这样的方式有个明显的问题，那就是，当修改了配置之后，必须重启服务，否则配置无法生效。

目前有一些用的比较多的开源的配置中心，比如携程的 Apollo、蚂蚁金服的 disconf 等，对比 Spring Cloud Config，这些配置中心功能更加强大。有兴趣的可以拿来试一试。

整体项目目录：

在搭建项目之前，先能一个配置文件中心，不在说明，到时候结合git实现此功能

https://github.com/Joe192168/TestConfig

第一步，搭建服务端

pom如：

<?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</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.joe</groupId>
    <artifactId>springcloud-configserver</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springcloud-configserver</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
    </dependencies>

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

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

application.yml文件：

server:
  port: 8888

bootstrap.yml文件

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          uri: https://github.com/Joe192168/TestConfig.git
          default-label: master
          search-paths: testInfo

注意：服务端这块使用application.yml和bootstrap.yml两个文件，在项目启动时候，bootstrap的优先级高于application

启动类：

第二步：客户端搭建

pom文件

<?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</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.joe</groupId>
    <artifactId>springcloud-configclient</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springcloud-configclient</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- spring cloud config 客户端包 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-config</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.8</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.15</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.21</version>
        </dependency>

        <dependency>
            <groupId>com.oracle</groupId>
            <artifactId>ojdbc</artifactId>
            <version>11.1.0.7.0</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
            <version>2.2.0.RELEASE</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

application.yml文件：

server:
  port: 80
management:
  endpoint:
    shutdown:
      enabled: false
  endpoints:
    web:
      exposure:
        include: "*"

data:
  env: NaN
  user:
    username: NaN
    password: NaN

spring:
  datasource:
    username: root
    password: root
    url: jdbc:mysql://localhost:3306/mysql?useUnicode=true&characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai&allowMultiQueries=true
    driver: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    # 下面为连接池的补充设置，应用到上面所有数据源中
    # 初始化大小，最小，最大
    # druid 配置: https://github.com/alibaba/druid/wiki/
    initialSize: 1
    minIdle: 1
    maxActive: 20
    # 配置获取连接等待超时的时间
    maxWait: 60000
    # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
    timeBetweenEvictionRunsMillis: 60000
    removeAbandoned: true
    removeAbandonedTimeout: 1800
    # 配置一个连接在池中最小生存的时间，单位是毫秒
    minEvictableIdleTimeMillis: 300000
    validationQuery: select 1
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    # 打开PSCache，并且指定每个连接上PSCache的大小
    poolPreparedStatements: true
    maxPoolPreparedStatementPerConnectionSize: 50
    # 配置监控统计拦截的filters，stat用于监控界面，'wall'用于防火墙防御sql注入, slf4j用于druid记录sql日志
    filters: stat,slf4j,wall
    # 通过connectProperties属性来打开mergeSql功能；慢SQL记录
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000
    # 合并多个DruidDataSource的监控数据
    useGlobalDataSourceStat: false

bootstrap.yml文件：

spring:
  profiles:
    active: dev
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

---
spring:
  profiles: prod
  application:
    #和git里的文件名（application）对应
    name: config-client
  cloud:
    config:
      uri: http://localhost:8888
      label: master
      profile: prod
    bus:
      trace:
        enabled: true
      enabled: true

---
spring:
  profiles: dev
  application:
    #和git里的文件名（application）对应
    name: config-client
  cloud:
    config:
      uri: http://localhost:8888
      label: master
      profile: dev
    bus:
      trace:
        enabled: true
      enabled: true

注意：这块还需要搭建rabbitmq环境，这块就不演示了，自己搭建即可。

启动类：

其中在获取值的时候使用了两种方式，有兴趣的可以进行测试：

GitAutoRefreshConfig.java配置：

@Component
@Data
@ConfigurationProperties(prefix = "data")
public class GitAutoRefreshConfig {

    public static class UserInfo {
        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;
        }

        @Override
        public String toString() {
            return "UserInfo{" +
                    "username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    '}';
        }
    }

    private String env;

    private UserInfo user;
}

GitConfig.java配置：

@Data
@Component
public class GitConfig {

    @Value("${data.env}")
    private String env;

    @Value("${data.user.username}")
    private String username;

    @Value("${data.user.password}")
    private String password;

}

@ConfigurationProperties(prefix = "data")和@Value("${data.env}")，第一种是可以实现刷新操作，获取最新数据。第二种没有深入研究，有兴趣的可以研究。

配置git如：

注意：这块可以使用natapp免费的内网穿透工具实现此功能，这块必须git通过公网可以访问到你的客户端/actuator/refresh，或者在本机hosts文件里面配置一个www.aaa.com 127.0.0.1也是可以的。

这里注意一点，刷新单个客户端使用/actuator/refresh，如果想要多个客户端起作用，使用其中一个访问就可以同时刷新其它客户端配置为最新actuator/bus-refresh。

第三方、测试：

使用postman工具，/actuator/refresh这个路径是post请求方式，只要刷新其中一个客户端的url就可以通过bus广播机制刷新其它客户端。如图：

我这块启动了两个客户端，所以控制台就会出现监听的日志：

o.s.cloud.bus.event.RefreshListener      : Received remote refresh request. Keys refreshed [config.client.version, data.env]

结果：

客户端1：

客户端2：

总结：主要使用了springboot，springcloud config，springcloud bus，为啥要使用bus了，主要因为如果公司里面客户端多的话，不可能一个一个的手动刷新吧，效率很低，通过使用bus广播机制可以轻松解决此问题。下一篇，在此基础上整合到springcloud注册中心，实现正真的微服务工程。

源码：https://github.com/Joe192168/SpringCloud-Learn

Joe192

关注

1
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
Springboot自动刷新yml配置文件内容，结合springcloud config,springbout bus消息中心

说明：配置文件是我们再熟悉不过的了，尤其是 Spring Boot 项目，除了引入相应的 maven 包之外，剩下的工作就是完善配置文件了，例如 mysql、redis 、security 相关的配置。除了项目运行的基础配置之外，还有一些配置是与我们业务有关系的，比如说七牛存储、短信相关、邮件相关，或者一些业务上的开关。对于一些简单的项目来说，我们一般都是直接把相关配置放在单独的配置文件中，以...
复制链接

扫一扫

专栏目录