SpringBoot框架(5):Spring读取外部配置文件

Java通过XML完成配置工作。但是在之前使用XML配置的时候，需要读取一些properties资源配置文件，那么当我们升级成使用Java来进行配置操作的时候，如何快读的读取properties资源配置文件中的信息呢。

一、相关注解

与配置文件读取相关的注解有两个，一个是@PropertySource，一个是@Value。其中@PropertySource注解可以加载指定路径的资源配置文件，这个注解是标识在@Configuration配置类上的。而@Value是获取前面读取的资源配置文件中的参数对应的值，可以用在JavaBean的字段和方法上。

1.使用方式：

(1)@PropertySource(value= {"classpath:xxxxx","classpath:yyyyy"})
其中“xxxxx”、“yyyyy”代表资源配置文件所在的classpath目录，多个资源文件以逗号分隔。
常用参数：
ignoreResourceNotFound=true/false（是否忽略未找到的资源文件）
encoding="UTF-8"（编码方式）

实例：

@PropertySource(value= {"classpath:config/jdbc-bainuo-dev.properties"},ignoreResourceNotFound=false,encoding="UTF-8")

(2)@Value("${xx.yy}")

其中“xx.yy”代表资源配置文件key为“xx.yy”的配置，注解映射的结果是key为“xx.yy”的value值。
实例：

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

2.实例测试

之前我们在测试Java配置方式的时候，编写了一个@Configuration配置类：

package cn.com.spring.config;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import cn.com.spring.config.dao.UserDao;
 
@Configuration//通过该注解来表明该类是一个Spring的配置，相当于一个XML文件
@ComponentScan(basePackages = "cn.com.spring.config")//配置扫描语句
public class SpringConfig {
    @Bean//该注解来表明是一个Bean对象，相当于XML中的
    public UserDao getUserDao(){
        return new UserDao();
    }
}

我们在src/main/resource下放置一个jdbc.properties文件，其中的信息如下：

jdbc.driverClassName = com.mysql.jdbc.Driver
jdbc.url = jdbc:mysql://localhost:3306/test_sys_db
jdbc.username = root
jdbc.password = 1234

我们下面模拟配置一个数据库连接池（这里由于没有真正的连接数据库，代码仅模拟了数据库连接），读取jdbc.properties文件中的数据库信息，并配置到DataSource数据库连接池对象中：

package cn.com.spring.config;
 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
 
import cn.com.spring.config.dao.UserDao;
 
@Configuration//通过该注解来表明该类是一个Spring的配置，相当于一个XML文件
@ComponentScan(basePackages = "cn.com.spring.config")//配置扫描语句
@PropertySource(value={"classpath:jdbc.properties"},ignoreResourceNotFound=true)
public class SpringConfig {
    
    @Value("${jdbc.driverClassName}")
    private String driverClassName;
    
    @Value("${jdbc.url}")
    private String url;
    
    @Value("${jdbc.username}")
    private String username;
    
    @Value("${jdbc.password}")
    private String password;
    
    @Bean//该注解来表明是一个Bean对象，相当于XML中的
    public UserDao getUserDao(){
        return new UserDao();
    }
    
    @Bean //数据库连接池对象，模拟DBCP连接池
    public BasicDataSource basicDataSource(){
        BasicDataSource basicDataSource = new BasicDataSource();
        basicDataSource.setDriverClassName(driverClassName);
        basicDataSource.setUrl(url);
        basicDataSource.setUsername(username);
        basicDataSource.setPassword(password);
        basicDataSource.setInitialSize(5);
        basicDataSource.setMaxActive(50);
        basicDataSource.setMaxIdle(10);
        basicDataSource.setMinIdle(3);
        basicDataSource.setRemoveAbandoned(true);
        basicDataSource.setRemoveAbandonedTimeout(200);
        basicDataSource.setLogAbandoned(true);
        basicDataSource.setMaxWait(100);
        return basicDataSource;
    }
}

其中的BasicDataSource是我模拟DBCP数据库连接池类编写的假类，用于测试模拟：

package cn.com.spring.config;
 
/**
* 模拟DBCP数据库连接池类
*/
public class BasicDataSource {
    private String driverClassName;
        private String url;
        private String username;
        private String password;
        private Integer initialSize;//池启动时创建的连接数量 
        private Integer maxActive;//同一时间可以从池分配的最多连接数量。设置为0时表示无限制。
        private Integer maxIdle;//池里不会被释放的最多空闲连接数量。设置为0时表示无限制。
        private Integer minIdle;//在不新建连接的条件下，池中保持空闲的最少连接数。
        private boolean removeAbandoned;//设置自动回收超时连接
        private Integer removeAbandonedTimeout;//自动回收超时时间(以秒数为单位)
        private boolean logAbandoned;
    //等待超时以毫秒为单位，在抛出异常之前，池等待连接被回收的最长时间（当没有可用连接时）。设置为-1表示无限等待
        private Integer maxWait;
    
    //get和set方法省略
}

可以看到，我们将DBCP连接池BasicDataSource也标记“@Bean”，表明该类要加载至Spring容器中，同时，我们在Configuration配置类中，使用“@Value”注解为四个与数据库连接相关的成员变量参数设置了读取的“jdbc.properties”中的值，然后在basicDataSource()配置方法中，将这些带值的变量赋值进连接池BasicDataSource的相关参数中。我们编写测试类，看一下BasicDataSource连接对象是否成功加载值Spring容器，以及“jdbc.properties”中的配置参数是否成功注入BasicDataSource中：

package cn.com.spring.config.test;
 
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
import cn.com.spring.config.BasicDataSource;
import cn.com.spring.config.SpringConfig;
 
public class TestMain {
    public static void main(String[] args) {
        //通过Java配置来实例化Spring容器
        
        //初始化Spring上下文对象，即Spring容器
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        
        BasicDataSource basicDataSource = context.getBean(BasicDataSource.class);
        System.out.println("DriverClassName="+basicDataSource.getDriverClassName());
        System.out.println("Url="+basicDataSource.getUrl());
        System.out.println("Username="+basicDataSource.getUsername());
        System.out.println("Password="+basicDataSource.getPassword());
        
        //调用结束，销毁Spring容器
        context.destroy();
    }
}

测试结果

可以看到，BasicDataSource连接对象成功加载至Spring容器，且“jdbc.properties”中的配置参数特成功注入到了BasicDataSource中。

补充：在SpringBoot中，我们甚至不需要在@Configuration类中配置数据库连接池，只需要在Spring Boot的默认配置文件application.properties中配置Spring的相关参数，即可在启动的时候直接注入连接池的相关信息。如使用DBCP连接池或其它类型连接池，直接配置“spring.datasource.type=org.apache.commons.dbcp2.BasicDataSource”参数，连接池相关信息，也是直接配置（spring.datasource.driver-class-name、spring.datasource.url等)，

属性配置文件详解

相信很多人选择Spring Boot主要是考虑到它既能兼顾Spring的强大功能，还能实现快速开发的便捷。我们在Spring Boot使用过程中，最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容，替代它的是在pom.xml中引入模块化的Starter POMs，其中各个模块都有自己的默认配置，所以如果不是特殊应用场景，就只需要在application.properties中完成一些属性配置就能开启各模块的应用。

在之前的各篇文章中都有提及关于application.properties的使用，主要用来配置数据库连接、日志相关配置等。除了这些配置内容之外，本文将具体介绍一些在application.properties配置中的其他特性和使用方法。

自定义属性与加载

我们在使用Spring Boot的时候，通常也需要定义一些自己使用的属性，我们可以如下方式直接定义：

com.didispace.blog.name=程序猿DD
com.didispace.blog.title=Spring Boot教程

然后通过@Value("${属性名}")注解来加载对应的配置属性，具体如下：

@Component
public class BlogProperties {

    @Value("${com.didispace.blog.name}")
    private String name;
    @Value("${com.didispace.blog.title}")
    private String title;

    // 省略getter和setter

}

按照惯例，通过单元测试来验证BlogProperties中的属性是否已经根据配置文件加载了。

@RunWith(SpringJUnit4ClassRunner.class)
@SpringApplicationConfiguration(Application.class)
public class ApplicationTests {

    @Autowired
    private BlogProperties blogProperties;


    @Test
    public void getHello() throws Exception {
        Assert.assertEquals(blogProperties.getName(), "程序猿DD");
        Assert.assertEquals(blogProperties.getTitle(), "Spring Boot教程");
    }

}

参数间的引用

在application.properties中的各个参数之间也可以直接引用来使用，就像下面的设置：

com.didispace.blog.name=程序猿DD
com.didispace.blog.title=Spring Boot教程
com.didispace.blog.desc=${com.didispace.blog.name}正在努力写《${com.didispace.blog.title}》

com.didispace.blog.desc参数引用了上文中定义的name和title属性，最后该属性的值就是程序猿DD正在努力写《Spring Boot教程》。

使用随机数

在一些情况下，有些参数我们需要希望它不是一个固定的值，比如密钥、服务端口等。Spring Boot的属性配置文件中可以通过${random}来产生int值、long值或者string字符串，来支持属性的随机值。

com.didispace.blog.value=${random.value}
# 随机int
com.didispace.blog.number=${random.int}
# 随机long
com.didispace.blog.bignumber=${random.long}
# 10以内的随机数
com.didispace.blog.test1=${random.int(10)}
# 10-20的随机数
com.didispace.blog.test2=${random.int[10,20]}

通过命令行设置属性值

相信使用过一段时间Spring Boot的用户，一定知道这条命令：java -jar xxx.jar --server.port=8888，通过使用–server.port属性来设置xxx.jar应用的端口为8888。

在命令行运行时，连续的两个减号--就是对application.properties中的属性值进行赋值的标识。所以，java -jar xxx.jar --server.port=8888命令，等价于我们在application.properties中添加属性server.port=8888，该设置在样例工程中可见，读者可通过删除该值或使用命令行来设置该值来验证。

通过命令行来修改属性值固然提供了不错的便利性，但是通过命令行就能更改应用运行的参数，那岂不是很不安全？是的，所以Spring Boot也贴心的提供了屏蔽命令行访问属性的设置，只需要这句设置就能屏蔽：SpringApplication.setAddCommandLineProperties(false)。

多环境配置

我们在开发Spring Boot应用时，通常同一套程序会被应用和安装到几个不同的环境，比如：开发、测试、生产等。其中每个环境的数据库地址、服务器端口等等配置都会不同，如果在为不同环境打包时都要频繁修改配置文件的话，那必将是个非常繁琐且容易发生错误的事。

对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单。

在Spring Boot中多环境配置文件名需要满足application-{profile}.properties的格式，其中{profile}对应你的环境标识，比如：

• application-dev.properties：开发环境
• application-test.properties：测试环境
• application-prod.properties：生产环境
  至于哪个具体的配置文件会被加载，需要在application.properties文件中通过spring.profiles.active属性来设置，其值对应{profile}值。

如：spring.profiles.active=test就会加载application-test.properties配置文件内容

下面，以不同环境配置不同的服务端口为例，进行样例实验。

• 针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

• 在这三个文件均都设置不同的server.port属性，如：dev环境设置为1111，test环境设置为2222，prod环境设置为3333

• application.properties中设置spring.profiles.active=dev，就是说默认以dev环境设置

测试不同配置的加载

• 执行java -jar xxx.jar，可以观察到服务端口被设置为1111，也就是默认的开发环境（dev）
• 执行java -jar xxx.jar --spring.profiles.active=test，可以观察到服务端口被设置为2222，也就是测试环境的配置（test）
• 执行java -jar xxx.jar --spring.profiles.active=prod，可以观察到服务端口被设置为3333，也就是生产环境的配置（prod）

按照上面的实验，可以如下总结多环境的配置思路：

• application.properties中配置通用内容，并设置- - - spring.profiles.active=dev，以开发环境为默认配置
• application-{profile}.properties中配置各个环境不同的内容
• 通过命令行方式去激活不同环境的配置