springcloudconfig整理篇

itchun

已于 2023-03-06 18:24:12 修改

阅读量622

点赞数 1

文章标签： java spring cloud

于 2022-12-09 18:23:30 首次发布

本文链接：https://blog.youkuaiyun.com/weixin_38491225/article/details/128257026

版权

本文详细介绍Spring Cloud Config的使用方法，包括服务端与客户端的配置流程，支持的存储库类型如Git、SVN等，并提供了搭建教程及配置示例。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

支持的库

git(默认)
svn
数据库
redis
支持混合多库使用

官网

https://docs.spring.io/spring-cloud-config/docs/3.1.4-SNAPSHOT/reference/html

git库使用

服务端

pom.xml引入需要的包

<!--SpringCloud 2020.*以后的版本默认禁用了bootstrap，导致读取配置文件时读取不到该属性。 缺少 bootstrap.yml无法被识别-->
<dependency>
   <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

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

服务端 bootstrap.yml 部分配置

spring:
  cloud:
    config: # 类 AbstractScmAccessor 的 getSearchLocations 方法
      enabled: true #默认开启，false时，客户端不可读取配置服务中心配置
      server:
        git: #默认使用git
          uri: https://gitee.com/iwangchun/config-test.git
          basedir: D:/config2
          default-label: master

主类配置

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;

@EnableConfigServer
@EnableEurekaClient
@SpringBootApplication
public class ConfigService2014 {

    public static void main(String[] args) {
        SpringApplication.run(ConfigService2014.class, args);
    }

}

客户端

pom.xml引入需要的包

<!--SpringCloud 2020.*以后的版本默认禁用了bootstrap，导致读取配置文件时读取不到该属性。 缺少 bootstrap.yml无法被识别-->
<dependency>
   <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-bootstrap</artifactId>
</dependency>

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

<!--自动刷新配置 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

wind搭建rabbitMQ服务端

先安装： https://www.erlang.org/downloads
在安装： https://www.rabbitmq.com/download.html
步骤和遇到问题参考：https://blog.youkuaiyun.com/HK_HH/article/details/119280657

客户端bootstrap.yml 部分配置

spring:
  profiles:
    active: dev
  config:
    use-legacy-processing: true # 【使用 spring.profiles.include的时候需要设置为true】 - 待确认
  cloud:
    config:
      enabled: true
      # 直接使用url的方式
#      uri: http://localhost:2014

      # 使用服务器发现模式，前提需要在bootstrap.yml中添加eureka中指定注册中心地址
      discovery:
        enabled: true #开启config配置中心
        service-id: config-service-2014 #配置中心服务名
      label: master #所在分支
      name: springconfig,myconfig #文件的application名，需要指定多个中间用逗号隔开
      profile: dev #文件profile名
      
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

# 刷新配置    
management:
  endpoints:
    web:
      exposure:
        #        include: refresh
        include: "*"
  endpoint:
    health:
      show-details: ALWAYS

配置类，听说@Value() 注解无法动态刷新，待确认

package com.itchun.config;

import lombok.Getter;
import lombok.Setter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@ConfigurationProperties(prefix = "itchun")
@Component
@Getter
@Setter
public class YmlConfig {
private String name;

    private String age;

    private String sex;

    private String see;

    private String book;

    private String app;
}

接口类

package com.itchun.controller;

import com.itchun.config.YmlConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConfigController {

    @Autowired
    private YmlConfig ymlConfig;

    @RequestMapping("config")
    private Object name() {
        return ymlConfig;
    }
}

请求示例：

示例：
========================================================================================================================
根目录下文件
    - springconfig.yml
    - springconfig-dev.yml
    - springconfig-prod.yml
    - application.yml

配置：
    label: master
    name: springconfig
    profile: dev
结论：
    优先级 application.yml < springconfig.yml < springconfig-dev.yml

配置：
    label: master
    name: springconfig
    profile: prod
结论：
    优先级 application.yml < springconfig.yml < springconfig-prod.yml

配置：
    label: master
    name: springconfig
    profile: xx
结论：
    优先级 application.yml < springconfig.yml

配置：
    label: master
    name: springconfig
    profile:
结论：
    获取不到参数

配置：
    label: master
    name:
    profile:
结论：
    获取不到参数

配置：
    label: master
    name: xx
    profile: xx
结论：
    读取到的是 application.yml 中的配置



示例：
========================================================================================================================
根目录下文件
    - springconfig.yml
    - springconfig-dev.yml
    - springconfig-prod.yml
    - application.yml
    - /app/springconfig-app.yml
    - /app/springconfig-dev.yml

配置：
    label: master
    name: springconfig
    profile: app
结论：
    优先级 application.yml < springconfig.yml < /app/springconfig-app.yml

配置：
    label: master
    name: springconfig
    profile: dev
结论：
    优先级 application.yml < springconfig.yml < /app/springconfig-dev.yml



示例：
========================================================================================================================
根目录下文件
    - application.yml
    - springconfig.yml
    - springconfig-dev.yml
    - springconfig-prod.yml
    - /app/springconfig-app.yml
    - /app/springconfig-dev.yml
    - /web/springconfig-web.yml
    - /web/springconfig-dev.yml
配置：
    服务端：
        search-paths:
    客户端：
        label: master
        name: springconfig
        profile: app
结论：
    优先级 application.yml < springconfig.yml

配置：
    服务端：
        search-paths:
        - app
        - web
    客户端：
        label: master
        name: springconfig
        profile: app
结论：
    优先级 application.yml < springconfig.yml < /app/springconfig-app.yml

配置：
    服务端：
        search-paths:
        - app
        - web
    客户端：
        label: master
        name: springconfig
        profile: web
结论：
    优先级 application.yml < springconfig.yml < /web/springconfig-web.yml

配置：
    服务端：
        search-paths:
        - app
        - web
    客户端：
        label: master
        name: springconfig
        profile: dev
结论：
    优先级 application.yml < springconfig.yml < /web/springconfig-dev.yml

配置：
    服务端：
        search-paths:
        - web
        - app
    客户端：
        label: master
        name: springconfig
        profile: dev
结论：
    优先级 application.yml < springconfig.yml < /app/springconfig-dev.yml