【Spring Boot学习总结】3.Spring读取外部配置文件

程序员文章站 2022-05-02 12:13:36

...

上一篇我们总结了如何使用Java来进行之前XML才能完成的配置工作。但是在之前使用XML配置的时候，需要读取一些properties资源配置文件，那么当我们升级成使用Java来进行配置操作的时候，如何快读的读取properties资源配置文件中的信息呢？下面我们就来介绍一下如何使用Java读取外部的配置文件。

一、相关注解
与配置文件读取相关的注解有两个，一个是@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中的<bean>
    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中的<bean>
    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();
    }
}

测试结果：
【Spring Boot学习总结】3.Spring读取外部配置文件
可以看到，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 Boot实战与原理分析》视频课程
(https://pan.baidu.com/s/1o9M2bGI 密码：jxg8)

转载请注明出处：https://blog.csdn.net/acmman/article/details/81381687