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

我们在项目开发中经常会用到配置信息,例如数据库连接的帐号、密码等,而为了方便维护,我们通常将这些信息放到配置文件中。在需要用到这些配置信息时,可以通过代码获取。下面我们看看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
    
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,826评论 6 506
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,968评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,234评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,562评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,611评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,482评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,271评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,166评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,608评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,814评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,926评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,644评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,249评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,866评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,991评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,063评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,871评论 2 354

推荐阅读更多精彩内容