signed

QiShunwang

“诚信为本、客户至上”

SpringBoot读取配置文件的N种方法

2020/12/28 9:58:36   来源:

我们在项目开发中经常会用到配置信息,例如数据库连接的帐号、密码等,而为了方便维护,我们通常将这些信息放到配置文件中。在需要用到这些配置信息时,可以通过代码获取。下面我们看看Spring中有哪些获取配置信息的方法。

  1. PropertiesLoaderUtils读取

    通过ClassPathResource加载配置文件资源,结合PropertiesLoaderUtils类读取,源码如下:

    ClassPathResource resource = new ClassPathResource("application.properties"); 	
    try { 		
    	Properties properties = PropertiesLoaderUtils.loadProperties(resource); 			String account = properties.getProperty("jdbc.account"); 			    
    } catch (IOException e) { 		
    	…… 	
    }
    
  2. @Value注解读取指定属性

    配置信息

    jdbc:
      account: zhangsan
      pwd: 123456
    

    读取方法

    @Component
    public class JdbcService {
        @Value("${jdbc.account}")
        private String account;
        @Value("${jdbc.pwd}")
        private String pwd;
    
        public void connectDb() {
            System.out.println("Database has connected, jdbc account is "
                + account + ", password is " + pwd);
        }
    }
    

    @Value 注解通过 ${key}获取配置文件中和 key 对应的 value 值,并将value值赋给对应的变量,之后就像使用正常变量一样就可以获取到配置信息。

  3. @ConfigurationProperties读取一组配置信息

    @ConfigurationProperties注解用于读取指定前缀的一组配置信息并与bean绑定,具体的配置属性会绑定到bean的成员属性中,即前缀名+成员属性名等于配置文件中的key。之后可以像使用其他bean一样使用该bean并读取配置信息。

    配置信息

    user:
      name: zhangsan
      sex: 男
      homeUrl: www.xxx.com
    

    绑定bean

    @Component
    @Data
    @ConfigurationProperties(prefix = "user")
    public class User {
        private String name;
        private String sex;
        private String homeUrl;
    }
    

    使用bean

    @Service
    public class UserService {
        @Autowired
        User user;
    
        public void getUserInfo() {
            System.out.println(user.toString());
        }
    }
    

    @Value适用与少量配置信息的场景,在一些较复杂的场景下(业务繁琐、配置项多),需要考虑把相关一组配置信息封装成一个或多个配置信息类,这时就可以使用@ConfigurationProperties。

  4. @PropertySource读取指定配置文件

    当我们项目比较大配置信息比较多的时,如果所有的配置信息都放在一个配置文件中,就会显得比较臃肿且不易理解和维护。此时,我们可以按照需求将该配置文件拆分为多个,并使用@PropertySource注解配合@Value或@ConfigurationProperties读取指定配置文件中的配置信息。假设我们存储数据连接信息的配置文件为jdbc.properties,内容如下:

    jdbc:
      account: zhangsan
      pwd: 123456
    
    @Component
    @Data
    @PropertySource(value = {"classpath:jdbc.properties"})
    @ConfigurationProperties(prefix = "jdbc")
    public class JdbcCfg {
        private String account;
        private String pwd;
    
        public void connectDb() {
            System.out.println("Database has connected, jdbc account is "
                + account + ", password is " + pwd);
        }
    }
    

    也可以和@Value配合使用。

    @Component
    @PropertySource(value = {"classpath:jdbc.properties"})
    public class JdbcCfg {
    	@Value("${jdbc.account}")
        private String account;
        @Value("${jdbc.pwd}")
        private String pwd;
        
        public void connectDb() {
        	System.out.println("Database has connected, jdbc account is "
            	+ account + ", password is " + pwd);
    }
    
  5. 指定项目的配置文件

    在实际开发中,我们一般最少会有两个环境——开发环境和线上环境,可能还会存在测试环境,这些环境往往会使用不同的配置信息,比如端口、数据库链接地址等。如果我们把项目部署到线上环境后,在把配置信息一项一项的改成线上环境对应的会比较麻烦。比较科学的解决方法是,线上环境对应一套配置信息,开发环境对应一套,当我们在开发环境时指定读取开发的配置,在线上时指定读取线上的配置。

    假设开发环境对应的配置文件为application-d.yml,线上环境对应的配置文件为application-d.yml。然后在application.yml文件中配置要使用的哪个配置文件即可,如在线上环境可按如下指定。

    spring:
      profiles:
        active:
        - p
    
  6. 读取复杂配置信息

    看下如下配置文件

    #http协议下消息传输
    msgtransfer.tranprocol.http.orderid = order1
    msgtransfer.tranprocol.http.count = 100
    
    #fix协议下消息传输
    msgtransfer.tranprocol.fix.orderid = order2
    msgtransfer.tranprocol.fix.count = 200
    

    上面的配置文件是为了支持不同协议的消息传输,该配置的key中也存在变量,这样的配置信息如何读取呢?

    @Component
    @Data
    @ConfigurationProperties(prefix = "msgtransfer")
    public class MsgTransferCfg {
        private Map<String, MsgInfo> tranprocol;
        
        public static class MsgInfo {
            private String orderid;
            private int count;
        }   
    }
    

    关键点在private Map<String, MsgInfo> tranprocol;httpfix会自动映射为tranprocol的key,orderidcount会映射到MsgInfo的成员属性上。

    如果在配置文件的key中使用变量的,需要在相应的bean中定义map,配置文件和map的对应规则如下:

    前缀.map名称.key.pro = value
    

在这里插入图片描述