使用cipher加密配置文件

在工作中往往很多时候密码是不能作为明文在配置文件中存储的,这个时候需要加密密码,可以使用{cipher}加密
总的来说只有几个步骤

1.添加依赖

这里需要注意引入的是spring-cloud-starter-config而不是spring-cloud-config-server至于为什么后面介绍

2.在bootstrap中添加加密秘钥

此处举例秘钥为123456,当然也可以设置更复杂的密码
后面springcloudconfig设置为false,具体为什么笔者也没有搞清楚,后面有介绍如果不这么设置的话会有什么情况发生

3.将配置文件中的密码设为密文

用{cipher}表示加密后的密文,后面是具体密文字符串

3.1密文如何获取

暂时没找到更好的方法,采用的是另起一个server-config调用接口获得密文

新建一个maven工程
可以使用 spring初始化工具快速创建一个工程,注意添加依赖即可

编写main
将建好的工程用idea打开,编写main

package com.example.demo;import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;@SpringBootApplication
@EnableConfigServer
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}}

添加bootstrap
注意此处的密钥需要和之前工程中的密钥一致,且需要配置一下git的地址,如果没有的话就配一下本地,具体为什么后面介绍

encrypt:key: 123456spring:profiles:active: nativecloud:config:server:native:search-locations: C:\Users\Downloads\demo (1)\demo

使用postman调用接口
获取加密后的密文,将此处得到的密文加上{cipher}配置到配置文件中

同样也有配套的解密接口

4.踩过的坑

4.1添加依赖

spring-cloud-starter-config和spring-cloud-config-server依赖都可

引别的依赖和不配置config都不影响工程的启动

但是不能配config-locations不然会出之前一样的问题

当然不管是spring-cloud-starter-config还是spring-cloud-config-server都是需要引入一个的,这是能识别{cipher}并进行解密的前提

4.2密文获取

bootstrap必须配置地址

如果不配

***************************
APPLICATION FAILED TO START
***************************Description:Invalid config server configuration.Action:If you are using the git profile, you need to set a Git URI in your configuration.  If you are using a native profile and have spring.cloud.config.server.bootstrap=true, you need to use a composite configuration.Disconnected from the target VM, address: '127.0.0.1:52855', transport: 'socket'

如果配成false

***************************
APPLICATION FAILED TO START
***************************Description:Invalid config server configuration.Action:If you are using the git profile, you need to set a Git URI in your configuration.  If you are using a native profile and have spring.cloud.config.server.bootstrap=true, you need to use a composite configuration.Disconnected from the target VM, address: '127.0.0.1:52997', transport: 'socket'

4.3可能出现的错误

一开始想在原工程中写个main起一下config-server,但是直接写之后起不来,报这样的错

搜了一下之后,排除了数据库的自动配置

报这样的错

搜了一下,这样改之后依然报相同的错

于是改成了这样,配置了本地的地址

报这样的错应该是因为排除了DataSourceautoconfiguration所以没有引入相应的java

解决不了,于是新建了一个工程起config-server

4.4 后续

需将之前写的main删除,

否则之前出现的问题依旧出现,不是修改mainclass就可以的

需将之前配置的config注释

否则可能读取config报错

重新mvn clean install之后报这个错

所以要注释掉之前的配置

参考文档
使用对称加密来加密Spring Cloud Config配置文件

配置中心（Config-Server）

SpringCloud ConfigServer的详细配置

The following classes could not be excluded because they are not auto-configuration classes错误的处理方式

springcloud本地启动指定profile后错误If you are using the git profile, you need to set a Git URI in your configuration.

无git库配置configserver