application.properties多环境配置文件、jar包外部配置文件、配置项加密、程序中配置使用

一、简介

spring boot项目application.properties文件存放及使用介绍

 

二、方法一多环境配置文件

我们一般都会有多个应用环境，开发环境、测试环境、生产环境，各个环境的配置会略有不同，我可以根据这个创建多份配置文件，由主配置文件来控制读取那个子配置

创建spring boot项目后可以同时创建多个.properties文件，只要符合它要求的格式即可

格式：application-{profile}.properties；{profile}是变量用于自定义配置文件名称

分别创建三个应用环境的配置和一个主配置

1、application.properties　　主配置（以下是配置内容，这里的dev就是其他配置文件的标识名dev、test、prod）

# 具体使用那个配置文件的标识名称（格式：application-{profile}.properties；{profile}是变量用于自定义配置文件名称）
spring.profiles.active=dev

2、application-dev.properties　　开发环境（以下是配置内容）

spring.application.name=tyh-demo-prop
# 开发环境端口
server.port=10001

3、application-test.properties　　测试环境（以下是配置内容）

spring.application.name=tyh-demo-prop
# 测试环境端口
server.port=10002

4、application-prod.properties　　生产环境（以下是配置内容）

spring.application.name=tyh-demo-prop
# 生产环境端口
server.port=10003

更改主配置中的spring.profiles.active=dev这个参数就可以切换不同子配置文件了

由于此方法.properties文件依然在jar中，我们修改时并不方便，而且太多信息暴露在开发中容易泄露，所以结合方法二进行使用

 

三、方法二jar包外部配置文件

我们在开发完成发布生产环境时往往都会修改一下配置文件的相关内容，而默认.properties配置文件会被封装到jar包中修改起来不方便，所以spring boot给了几个读取配置文件的位置，我们可以通过这个方式去从jar包外部修改配置文件

一般我们会将.properties放在resources文件夹内

spring boot会按以下顺序去寻找配置文件

1、“当前目录”的/config文件夹下

2、“当前目录”下

3、classpath的/config文件夹下

4、classpath下

 以下是图例解释 ：

当找到配置文件后将不会再继续寻找，也就说该文件优先级以下的配置文件将不会被读取，找到即停止

“当前目录”指的是我们打成可执行jar包后，一般会用bat文件来启动，这个当前目录指的就是bat文件的目录

我们常规存放的位置就是优先级最低的位置，所以我们只需要再单独拷贝一份配置文件，放在bat的“当前目录”即可

 

四、配置项加密

我们的application.properties文件中会有很多敏感信息，如：数据库连接、缓存服务器连接等等，这些用户名密码都应该是外部不可见的，所以最好将其加密后存储

我们使用jasypt来进行加解密，首先先建立项目，我搭建了spring boot项目

1、添加pom.xml信息

<!-- 配置文件项加密 -->
<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>2.1.0</version>
</dependency>

2、在application.properties文件中增加配置项，需要jasypt来解密的密文需要用“ENC(......)”括起来

spring.application.name=tyh-demo-prop
server.port=10001
# 配置文件项加解密密码，此处注释，而放在代码中（放在代码中使加密密钥和密文分开）
#jasypt.encryptor.password=112233
# 模拟数据库连接帐号密码
spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)
spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)

3、程序启动类，默认jasypt的密钥是放在配置文件中但这样会导致密文和密钥都在配置文件中，所以我把密钥放在程序中

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        //设置配置文件项加密密钥（放在这里使加密密钥和密文分开）
        System.setProperty("jasypt.encryptor.password", "112233");
        SpringApplication.run(App.class, args);
    }
}

4、使用注解的方式来注入配置文件中的配置项

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class SysConfig {

    @Value("${spring.datasource.username}")
    private String dbUsername;

    @Value("${spring.datasource.password}")
    private String dbPassword;
//自己生成get set方法
}

5、编写controller及action来调用一下

import com.tyh.demo.prop.config.SysConfig;
import org.jasypt.encryption.StringEncryptor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/test")
public class TestController {

    @Autowired
    StringEncryptor encryptor;

    @ResponseBody
    @RequestMapping("/index")
    public String index() {
        return encryptor.encrypt("taiyonghai");
    }

    @Autowired
    SysConfig sysConfig;

    @ResponseBody
    @RequestMapping("/getConfig")
    public SysConfig getConfig() {
        //spring boot自动注入就会将密文解密
        return sysConfig;
    }
}

由于其使用的是PBEWithMD5AndDES加密方式，所以每次加密出来的结果都不一样，所以很适合对数据进行加密

 运行后，可以看到自动解密的配置项

 

五、配置项注入静态static与非静态属性

我们有很多编码需求需要使用.properties文件中自定义的配置项，传统使用Properties对象来操作，类似如下代码，

这种方式太过灵活我们不想使用的配置项可能也会被提取出来，而且当我们不想使用jar包内的配置文件，而是利用优先级使用外部的，这种直接读取的方式就很不方便，所以推荐使用@Value的方式来使用

public class SysConfigUtil {
    private static Properties props;
    static {
        try {
            // TODO：读取用户配置
            Resource resource = new ClassPathResource("/application.properties");
            props = PropertiesLoaderUtils.loadProperties(resource);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    public static String getProperty(String key) {
        return props == null ? null : props.getProperty(key);
    }
｝

还是刚才的项目，使用@Value来注入想让程序使用的配置项，而不想让程序使用的就不注入，这样来使配置项可控

1、我们在.properties文件中增加两个自定义配置项

spring.application.name=tyh-demo-prop
server.port=10001
# 配置文件项加解密密码，此处注释，而放在代码中（放在代码中使加密密钥和密文分开）
#jasypt.encryptor.password=112233
# 模拟数据库连接帐号密码
spring.datasource.username=ENC(nm3F96GtUIwZUHzsP0Mp1A==)
spring.datasource.password=ENC(lmn7lAlePy1hZu505WO0xQ==)
# 模拟其他自定义配置项
#tyh.url.web.admin=http://www.admin.com
tyh.url.web.agent=http://www.agent.com

2、@Value注入可以给静态属性也可以给非静态属性，具体根据使用场景自行决定，如果配置项可能不存在也可以设置默认值，避免程序无法启动

@Component
public class SysConfig {

    @Value("${spring.datasource.username}")
    private String dbUsername;

    @Value("${spring.datasource.password}")
    private String dbPassword;

    /*
    非静态属性注入（注入属性）
     */
    //@Value的参数代表配置项的key，如果没有启动会报错，加上“:”为其设置默认值即可解决冒号后面的就是默认值内容，也可以直接:冒号后面空白就是空
    @Value("${tyh.url.web.admin:www.abc.com}")
    private String urlAdmin;

    //###自己创建get/set方法###

    /*
    静态属性注入（注入set()方法）
     */
    //使用@Component把当前类当作组件启动时注入该静态属性值，静态属性注入set()方法
    public static String urlAgent;
    @Value("${tyh.url.web.agent:}")
    private void setUrlAgent(String urlAgent) {
        SysConfig.urlAgent = urlAgent;
    }
}

3、使用时非静态属性使用Autowired注入，静态属性直接取值

    //非静态属性注入取值（必须使用Autowired注入）
    @Autowired
    SysConfig sysConfig;

    public void test() {
        //静态属性注入取值（直接获取）
        String str = SysConfig.urlAgent;
    }

 推荐使用@Value来注入配置项进行使用，便与后续接入Apollo等配置管理中心进行配置统一管理