springboot 为什么读取不到 yml 属性

一种可能是你的yml文件没有被ide标注为资源文件，这种的症状就是你的yml文件是个表格状的图标，这时，你只需在你的yml所在的文件夹上（一般是resources文件夹）右键，选择“标记目录为”-》resources root即可，这时你的yml文件就会变成一个绿叶的图标，大功告成！！！

很多时候我们需要将一些常用的配置信息比如阿里云 oss 配置、发送短信的相关信息配置等等放到配置文件中。

下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。

applicationyml 内容如下：

wuhan2020: 2020年初武汉爆发了新型冠状病毒，疫情严重，但是，我相信一切都会过去！武汉加油！中国加油！my-profile:name: Guide哥email: koushuangbwcx@163comlibrary:location: 湖北武汉加油中国加油books:    -name: 天才基本法description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。    -name: 时间的秩序description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。    -name: 了不起的我description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？

1通过 @value 读取比较简单的配置信息

使用 @Value("${property}") 读取比较简单的配置信息：

@Value("${wuhan2020}")String wuhan2020;

需要注意的是 @value这种方式是不被推荐的，Spring 比较建议的是下面几种读取配置信息的方式。

2通过@ConfigurationProperties读取并与 bean 绑定

LibraryProperties 类上加了 @Component 注解，我们可以像使用普通 bean 一样将其注入到类中使用。

importlombokGetter;importlombokSetter;importlombokToString;importorgspringframeworkbootcontextpropertiesConfigurationProperties;importorgspringframeworkcontextannotationConfiguration;importorgspringframeworkstereotypeComponent;importjavautilList;@Component@ConfigurationProperties(prefix ="library")@Setter@Getter@ToStringclassLibraryProperties{privateString location;privateList books;@Setter@Getter@ToStringstaticclassBook{        String name;        String description;    }}

这个时候你就可以像使用普通 bean 一样，将其注入到类中使用：

packagecnjavaguidereadconfigproperties;importorgspringframeworkbeansfactoryInitializingBean;importorgspringframeworkbootSpringApplication;importorgspringframeworkbootautoconfigureSpringBootApplication;/ @authorshuangkou /@SpringBootApplicationpublicclassReadConfigPropertiesApplicationimplementsInitializingBean{privatefinalLibraryProperties library;publicReadConfigPropertiesApplication(LibraryProperties library){thislibrary = library;    }publicstaticvoidmain(String[] args){        SpringApplicationrun(ReadConfigPropertiesApplicationclass,args);    }@OverridepublicvoidafterPropertiesSet(){        Systemoutprintln(librarygetLocation());        Systemoutprintln(librarygetBooks());    }}

控制台输出：

湖北武汉加油中国加油[LibraryPropertiesBook(name=天才基本法, description]

3通过@ConfigurationProperties读取并校验

我们先将applicationyml修改为如下内容，明显看出这不是一个正确的 email 格式：

my-profile:name: Guide哥email: koushuangbwcx@

ProfileProperties 类没有加 @Component 注解。我们在我们要使用ProfileProperties 的地方使用@

EnableConfigurationProperties注册我们的配置 bean：

importlombokGetter;importlombokSetter;importlombokToString;importorgspringframeworkbootcontextpropertiesConfigurationProperties;importorgspringframeworkstereotypeComponent;importorgspringframeworkvalidationannotationValidated;importjavaxvalidationconstraintsEmail;importjavaxvalidationconstraintsNotEmpty;/@authorshuangkou/@Getter@Setter@ToString@ConfigurationProperties("my-profile")@ValidatedpublicclassProfileProperties{@NotEmptyprivateString name;@Email@NotEmptyprivateString email;//配置文件中没有读取到的话就用默认值privateBooleanhandsome =BooleanTRUE;}

具体使用：

packagecnjavaguidereadconfigproperties;importorgspringframeworkbeansfactoryInitializingBean;importorgspringframeworkbeansfactoryannotationValue;importorgspringframeworkbootSpringApplication;importorgspringframeworkbootautoconfigureSpringBootApplication;importorgspringframeworkbootcontextpropertiesEnableConfigurationProperties;/ @authorshuangkou /@SpringBootApplication@EnableConfigurationProperties(ProfilePropertiesclass)publicclassReadConfigPropertiesApplicationimplementsInitializingBean{privatefinalProfileProperties profileProperties;publicReadConfigPropertiesApplication(ProfileProperties profileProperties){thisprofileProperties = profileProperties;    }publicstaticvoidmain(String[] args){        SpringApplicationrun(ReadConfigPropertiesApplicationclass,args);    }@OverridepublicvoidafterPropertiesSet(){        Systemoutprintln(profilePropertiestoString());    }}

因为我们的邮箱格式不正确，所以程序运行的时候就报错，根本运行不起来，保证了数据类型的安全性：

Binding to target orgspringframeworkbootcontextpropertiesbindBindException:Failedtobindpropertiesunder'my-profile'to cnjavaguidereadconfigpropertiesProfileProperties failed:Property:my-profileemailValue:koushuangbwcx@Origin:classpathresource[applicationyml]:5:10Reason:mustbeawell-formedemailaddress

我们把邮箱测试改为正确的之后再运行，控制台就能成功打印出读取到的信息：

ProfileProperties(name=Guide哥, email=koushuangbwcx@163com, handsome=true)

4@PropertySource读取指定 properties 文件

importlombokGetter;importlombokSetter;importorgspringframeworkbeansfactoryannotationValue;importorgspringframeworkcontextannotationPropertySource;importorgspringframeworkstereotypeComponent;@Component@PropertySource("classpath:websiteproperties")@Getter@SetterclassWebSite{@Value("${url}")privateString url;}

使用：

@Autowiredprivate WebSite webSite;Systemoutprintln(webSitegetUrl());//>