spring cloud config配置中心实例全解

zhangjunfun

于 2021-09-10 16:01:00 发布

阅读量400

点赞数

分类专栏：系统架构文章标签： spring git svn spring cloud

本文链接：https://blog.csdn.net/zhangjunfun/article/details/120221609

版权

系统架构专栏收录该内容

3 篇文章 0 订阅

订阅专栏

本文详细介绍了如何搭建Spring Cloud Config Server，包括配置git库、创建Spring Boot项目、添加依赖、设置启动配置及安全性增强。同时，讨论了与Spring Boot项目对接的改造步骤，确保应用能够从配置中心获取配置。强调了版本兼容性、配置文件位置以及安全性方面的最佳实践。

摘要由CSDN通过智能技术生成

一）配置中心server端搭建

1）git配置库准备

spring cloud config组件可以将配置文件在server端以本地文件方式管理，也可托管在git server或SVN进行管理，本例采用git库进行项目配置文件的托管，因此需要提前准备git库。
github由于服务器在境外，访问速度比较慢，不建议使用。可使用国内提供服务的gitee或codechina，也可自建git服务。具体git库的申请开通网上有很多，在此不再赘述。
git库config-center作为所有项目的配置库，创建好后建议按照项目创建对应文件夹对配置文件进行管理，不同的文件夹对应不同项目。此处的文件夹名称需要与项目中spring.cloud.config.name保持一致才可以确保client项目拿到正确的配置。

2）spring cloud config server搭建

A）创建spring cloud config server springboot项目

创建一个空的springboot项目

B）引入依赖包(pom.xml)

引入spring cloud config server依赖

<!-- Config-Server 依赖 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>

定义spring cloud版本控制依赖

<dependencyManagement>
        <dependencies>
            <!-- SpringCloud 版本控制依赖 -->
            <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>

版本属性定义如下：

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

注意此处定义的版本与springboot版本最好保持兼容，不兼容会导致出现各种问题。

如果需要引入注册中心则需要引入Eureka-client依赖，本实例不打算使用注册中心，故不需要引入。

完整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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.cibn</groupId>
    <artifactId>config-center</artifactId>
    <version>1.0.20210909-PROD</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.6.RELEASE</version>  <!-- springboot版本 -->
    </parent>

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

    <dependencies>
        
        <!-- Config-Server 依赖 -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>

        <!--加密鉴权组件-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-security</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <!-- SpringCloud 版本控制依赖 -->
            <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>

此处已加入spring boot security依赖，为提高配置中心安全性，从配置中心拿配置必须通过鉴权，否则配置文件为裸奔状态。前期为了测试和验证服务可用性，可先去掉security依赖，确保可以直接通过浏览器方式访问到配置文件。

C）创建启动配置(bootstrap.yml)

sys:
  version: 1.0.0
server:
  port: 8888
spring:
  application:
    name: config-center
  cloud:
    config:
      server:
        git:
          uri: https://gitee.com/youraccount/config-center.git
          search-paths: '{application}'
          username: test
          password: test
  security:
    basic:
      enabled: true
    user:
      name: configuser
      password: configuserpasswd

注意：此处的search-paths指定为占位符{application}，作用是将配置文件按照项目分文件夹来进行管理，{application}对应config client的spring.cloud.config.name配置。server会自动按照client提交的应用名称搜索对应名称的文件夹下的配置文件，然后按照mapping规则进行匹配，不会搜索其他文件夹。

D）创建启动类

创建spring boot启动类ConfigCenterApplication，注意添加@EnableConfigServer注解。

package com.test.configcenter;


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

@SpringBootApplication
@EnableConfigServer
public class ConfigCenterApplication {
    public static void main(String[] args){
        SpringApplication.run(ConfigCenterApplication.class, args);
    }
}

配置中心server端搭建完成，可以尝试启动，如果没有报错，基本大功告成了。如果去掉了security依赖，并且没有指定search-paths时，可以尝试访问http://localhost:8888/xxxx.properties获取托管在git库根目录的配置文件。以便测试服务的可用性。当然测试完之后，考虑到安全性，我们还是需要开启security。

E）配置中心安全性

配置中心管理我们各个应用的配置文件，内容涉及服务器地址、数据库信息、加密秘钥甚至用户名密码等敏感信息，因此安全性是我们必须考虑的问题。主要从以下几方面提高配置中心的安全性：

git库私有，只有管理员或授权用户可以访问git库内容；
配置中心开启鉴权
开启配置中心的敏感信息加密功能

开启配置中心的敏感信息加密功能需要确保jre8的jce支持unlimited，原生安装的JVM8是不支持的，需要下载压缩包更新。
下载地址：http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
更新方法：把下载的zip包下的jar包copy到你的java_home/jre/lib/security/目录下覆盖同名文件即可，为了确保安全，如果有同名文件先备份再覆盖。

F）采坑记录

版本兼容问题：springboot与spring cloud config不兼容会出现各种问题，本例使用的springboot版本为2.0.6.RELEASE，spring cloud版本为Finchley.SR2，具体版本对照关系可参考https://blog.csdn.net/russle/article/details/80865288

配置文件问题：开启security.user的配置信息必须配置在bootstrap.yml配置文件，放到application.yml文件中配置的无效，掉到这个坑里花了一天时间才出来，验证配置是否正常，可通过/encrypt/status进行验证，如果验证OK，则说明配置正确。如果访问/encrypt出现forbidden，则需要添加自定义的配置类，如下，添加WebSecurityConfig配置类，开启Basic鉴权。

package com.test.configcenter.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http.csrf().disable().authorizeRequests()
                .anyRequest().authenticated().and()
                .httpBasic();

    }

}

二）springboot项目对接配置中心改造

1）项目pom.xml增加依赖包

项目pom.xml中需要增加以下依赖包：

    <!-- 版本控制依赖 -->
	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.springframework.cloud</groupId>
				<artifactId>spring-cloud-dependencies</artifactId>
				<version>Finchley.RELEASE</version>
				<type>pom</type>
				<scope>import</scope>
			</dependency>
		</dependencies>
	</dependencyManagement>

Spring Cloud Config 客户端依赖

		<!--Spring Cloud Config 客户端依赖-->
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-config</artifactId>
		</dependency>

2）项目增加bootstrap.yml配置文件并完成配置

将原项目resource目录下的properties文件迁移到配置中心git库中，并在resource目录下增加bootstrap.yml文件，配置如下：

sys:
  version: 1.0.0
spring:
  application:
    name: myAppName
  cloud:
    config:
      name: myAppName
      uri: http://configuser:configuserpasswd@localhost:8888/
      profile: dev
      label: master
      fail-fast: true

3）配置中心添加项目配置文件

可通过git命令将本地配置文件添加到git库中，如下图所示：

zhangjunfun

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
spring cloud config配置中心实例全解

一）配置中心server端搭建1）git配置库准备spring cloud config组件可以将配置文件在server端以本地文件方式管理，也可托管在git server或SVN进行管理，本例采用git库进行项目配置文件的托管，因此需要提前准备git库。github由于服务器在境外，访问速度比较慢，不建议使用。可使用国内提供服务的gitee或codechina，也可自建git服务。具体git库的申请开通网上有很多，在此不再赘述。git库config-center作为所有项目的配置库，创建好后建
复制链接

扫一扫

专栏目录