springBoot 通过@ConfigurationProperties读取配置文件的内容

springBoot 的出现使我省去了使用spring时的繁琐的xml配置。相当多的xml。并且tomcat 内置了。直接打成jar就可执行了。不必再去部署tomcat。

springBoot 时如何实现从配置文件中读取内容的呢?

@ConfigurationProperties与@Value

@ConfigurationProperties 与 @Value 两个注解的作用都是从配置文件中获取配置项。本次只讨论@ConfigurationProperties

@ConfigurationProperties 使用
源码.png

进入 @ConfigurationProperties注解源码发现:
@Target({ ElementType.TYPE, ElementType.METHOD })
该注解的使用位置: 1. 类、接口(包括注释类型)或枚举 2. 方法

@ConfigurationProperties 注解的使用位置: 类、接口(包括注释类型)或枚举 示例代码如下:

项目结构.png

@ConfigurationProperties 使用位置:类、接口(包括注释类型)或枚举

@Data // 此处使用了 lombok 来简化代码。
@Component // 添加Person 到 spring 容器中
@ConfigurationProperties(prefix = "person") // perfix 对应配置文件前缀
public class Person {
    private String name;
    private String fullName;
    private Integer age;
    private List<String> list;
    private Map<String,String> map;
    private Dog dog;
}
@Data
public class Dog {
    private String name;
    private Integer age;
}
<!--pom.xml 添加依赖-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
# 配置文件内容
person:
  name: xiaoming
  full-name: 小明
  age : 11
  list: a,b,c,d
  map: {key1: value1,key2: value2}
  dog:
    name: tom
    age: 3
// 获取配置文件内容 
@Autowired
 private Person person;

 @GetMapping("/getPerson")
 public Person getPerson(){
     return person;
 }
结果.png

至此@ConfigurationProperties 使用位置为: 类、接口(包括注释类型)或枚举 就已经可以从配置文件中获取内容。

@ConfigurationProperties 使用位置:方法
这种方式需要配合@Bean 和@Configuration 使用。
示例代码如下:

// 普通类,除去lombok 注解之外无其他注解
@Data
public class Person {
    private String name;
    private String fullName;
    private Integer age;
    private List<String> list;
    private Map<String,String> map;
    private Dog dog;
}

@Data
public class Dog {
    private String name;
    private Integer age;
}
@Configuration //定义此类为配置类
@RestController 
public class HelloController {
    @GetMapping("/getPerson")
    public Person getPerson(){
        return person();
    }
    
    // @Bean 相当于使用spring xml 配置时,在xml中定义一个Bean组件,该@Bean定义的方法必须在@Configuration注解的类才能生效
    @Bean  
    @ConfigurationProperties(prefix = "person")
    public Person person(){
        return new Person();
    }
}
结果.png

至此@ConfigurationProperties 使用位置为:方法 就已经可以从配置文件中获取内容。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,045评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,114评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,120评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,902评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,828评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,132评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,590评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,258评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,408评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,335评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,385评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,068评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,660评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,747评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,967评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,406评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,970评论 2 341

推荐阅读更多精彩内容