spring cloud(八)统一配置config

一、config简述

spring cloud config是spring cloud团队创建的一个全新项目,用来为分布式系统提供集中的配置管理。spring cloud config的出现便于服务的维护,更新。他是将服务的配置文件放在svn或者git仓库中进行读取的。从网上看到的一幅图非常形象:

本文是以git为示例进行讲解

二、创建一个config server

1.编写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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wangcongming.shop</groupId>
    <artifactId>config-server</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.12.RELEASE</version>
        <relativePath/>
    </parent>

    <properties>
        <!--设置字符编码及java版本-->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
    </dependencies>

    <!--依赖管理,用于管理spring-cloud的依赖,其中Camden.SR3是版本号-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Edgware.SR3</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>

2.编写启动类

package com.wangcongming.shop;

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;

@SpringBootApplication
@EnableConfigServer
public class ConfigServerApplication {

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

在启动类上添加注解@EnableConfigServer用于标记服务为config server

3.编写配置文件

server:
    port: 8804 #服务端口
spring:
    application:
        name: config-server #服务名称
    cloud:
        config:
            label: master #配置文件所在的分支
            password:   #git仓库的密码
            server:
                git:
                    search-paths: '{application}' #配置文件所在的目录
                    uri: https://gitee.com/wangcongming/config.git #服务的git仓库地址
            username: [email protected] #git仓库的用户名


eureka:
    client:
        service-url:
            defaultZone: http://localhost:8802/eureka/ #服务注册中心

为了提高config server的高可用,可以部署多台机器,将服务注册到eureka上,形成服务集群。

三、config client 编写

1.添加依赖

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

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

2.编辑配置文件

server:
    port: 8801
spring:
    application:
        name: user-system # 和git里的文件名对应
    cloud:
        config:
            label: master # 远程仓库的分支
            profile: dev # dev 开发环境配置文件 |  test 测试环境  |  pro 正式环境
            uri: http://localhost:8804/ # 指明配置服务中心的网址

可以看到配置了label 和profile,所以config有两种使用方式,一种是将不同环境的配置文件放在不同的分支,另外一种就是都放在一个分支下,通过profile来进行不同的指定。

四、加密解密

在配置文件中可能会有数据库密码或者redis密码等等一些敏感信息,此时把这些信息放到git上是非常不安全的,为此spring cloud提供了相应的加密模块来进行加密,具体如下:

1.安装环境

到oracle官网下载Java加密扩展(JCE)无限强度管理策略文件,jdk环境本身是支持加密的,只不过默认支持的是定长的,所以需要去官网下载改成不定长的。下载之后,得到一个压缩包,解压之后可以得到三个文件,然后将里面的两个jar包复制到/jre/lib/security目录下即可。

2.修改配置

加密内容以{cipher}开头,这样spring cloud就会自动进行进行解密访问。示例如下:

  • application.yml
spring:
  datasource:
    username: dbuser
    password: '{cipher}FKSAJDFGYOS8F7GLHAKERGFHLSAJ'
  • application.properties
spring.datasource.username: dbuser
spring.datasource.password: {cipher}FKSAJDFGYOS8F7GLHAKERGFHLSAJ

值得注意的是,yml的时候password需要用引号引起来,properties则不能使用。

3./encrypt和/decrypt端点

服务器暴露了/encrypt和/decrypt端点,用于加密(/encrypt)和解密(/decrypt),可以直接通过http请求来获取密码的明文和加密后的密码。示例如下:

$ curl localhost:8888/encrypt -d mysecret
682bc583f4641835fa2db009355293665d2647dade3375c0ee201de2a49f7bda

值得注意的是如果要加密的值具有需要进行URL编码的字符,则应使用--data-urlencode选项curl来确保它们已正确编码。

如果是解密则使用--data-urlencode(而不是-d)或设置显式Content-Type: text/plain,以确保在有特殊字符时正确地对数据进行编码

4.配置秘钥

以上配置之后还不能使用,还要配置对应的秘钥,配置如下:

encrypt:
	key: 12341sffdsfweg32rew

以上就全部配置完成了。

五、安全保护

配置中心是一个很重要的东西,一些配置信息都保存在里面,不希望对外暴露,此时可以添加权限校验。具体操作如下:

 

 

  • config server 改造

1.添加依赖

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

2.修改配置

#给配置中心添加用户名校验,如果不配置用户名密码,则默认有一个user的用户,密码是随机的,
#会在服务启动的时候打印出来
security:
    user:
        name: admin
        password: 123456

 

 

  • config client修改

修改配置文件为如下:

server:
    port: 8801
spring:
    application:
        name: user-system # 和git里的文件名对应
    cloud:
        config:
            label: master # 远程仓库的分支
            profile: dev # dev 开发环境配置文件 |  test 测试环境  |  pro 正式环境
            uri: http://localhost:8804/ # 指明配置服务中心的网址
            username: admin
            password: 123456

可以看出只是添加了用户名和密码。

六、config client重试和快速失败

在实际开发中,可能需要快速确定config server的可用性,可以通过设置来让服务优先判断config server的可用性。添加配置:

spring:
    cloud:
        config:
            fail-fast: true #是否启动快速失败功能,功能开启则优先判断config server是否正常

在config server 不可用的情况下使用上述来确定已经可以了,但是有的时候是因为网络问题无法访问,config server本身是没有问题的,此时,我们希望可以重试,具体操作如下:

  • 添加依赖
<dependency>
	<groupId>org.springframework.retry</groupId>
	<artifactId>spring-retry</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-aop</artifactId>
</dependency>
  • 修改配置
server:
    port: 8801
spring:
    application:
        name: user-system # 和git里的文件名对应
    cloud:
        config:
            label: master # 远程仓库的分支
            profile: dev # dev 开发环境配置文件 |  test 测试环境  |  pro 正式环境
            uri: http://localhost:8804/ # 指明配置服务中心的网址
            username: admin
            password: 123456
            fail-fast: true #是否启动快速失败功能,功能开启则优先判断config server是否正常
            retry: #此下面的参数可以不配置
                multiplier: 500 #单位毫秒,初始重试间隔时间,默认1000毫秒
                initial-interval: 1.1 #下一间隔的乘数,默认1.1
                max-interval: 1000 #最大间隔时间,默认2000毫秒
                max-attempts: 3 #最大重试次数,默认6次

推荐一套spring cloud学习视频 下载地址:https://download.csdn.net/download/linhui258/10525913

猜你喜欢

转载自blog.csdn.net/linhui258/article/details/80916911
今日推荐