【Spring Boot系列2】还在为配置文件注解头疼？一文带你全部搞定！
讲解SpringBoot的配置文件前，我们先学习配置文件读取的相关注解，一文带你全部搞定!
前言
本来想讲解SpringBoot的配置文件，但是里面一堆注解让我很是蒙圈，感觉用起来都差不多，比如@PropertySource、@ImportResource、@Value、@ConfigurationProperties等，加上之前掌握的@Configuration和@Bean。
一个配置文件，搞这么多注解，感觉头有点大，这篇文章主要是对这些注解进行扫盲，希望扫盲完后，我以后就不再怕它们了。
基于XML方式读取配置
为了方便示例讲解，我们在包resources下创建一个配置文件jdbc.properties：
jdbc.shop.url=jdbc:mysql://localhost:3104/xm_jointly?characterEncoding=utf8
jdbc.shop.username=louzai
jdbc.shop.password=123456
之前在文章《【MyBatis系列2】MyBatis与Spring整合》中，我们也有这个一个配置，但是我们使用XML的方式读取，然后还需要在XML中配置文件扫描路径：
<!-- 用于加载配置文件 -->
<bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="location">
<value>classpath:jdbc.properties</value>
</property>
</bean>
然后才能读取里面的配置：
<!-- 定义数据源 -->
<bean id="dataSource" class="org.springframework.jdbc.datasource.DriverManagerDataSource">
<property name="url" value="${jdbc.shop.url}"></property>
<property name="username" value="${jdbc.shop.username}"></property>
<property name="password" value="${jdbc.shop.password}"></property>
</bean>
那么有没有更优雅的实现方式呢，可以继续往下面看。
@ImportResource
XML中“用于加载配置文件”这块不变，直接看示例：
@ImportResource("classpath:applicationContext.xml")
public class ImportResourceTest {
@Value("${jdbc.shop.url}")
private String url;
@Value("${jdbc.shop.username}")
private String userName;
@Value("${jdbc.shop.password}")
private String passWord;
public static void main(String args[]) {
ApplicationContext context = new AnnotationConfigApplicationContext(PropertySourceTest.class);
PropertySourceTest connection = context.getBean(PropertySourceTest.class);
System.out.println(connection.toString());
}
}
// 输出：
// PropertySourceTest(url=jdbc:mysql://localhost:3104/xm_jointly?characterEncoding=utf8, userName=louzai, passWord=123456)
通过@ImportResource读取配置文件，然后通过@Value赋值给成员变量，@Value的用法，可以继续往后面看。
这种方式感觉还是不太优雅，因为还是依赖XML配置，有没有完全脱离XML的方式呢，@PropertySource就登场了。
@PropertySource & @Value
@PropertySource
此注解@PropertySource 为Spring 中的 Environment提供方便和声明机制，通常与Configuration一起搭配使用，直接看示例：
@ComponentScan({"com.java.annotation.spring.bean.fileconfig"})
@Component
@PropertySource("classpath:jdbc.properties")
public class EnvironmentTest {
@Resource
Environment environment;
private String url;
private String userName;
private String passWord;
public void getData() {
url = environment.getProperty("jdbc.shop.url");
userName = environment.getProperty("jdbc.shop.username");
passWord = environment.getProperty("jdbc.shop.password");
System.out.println("url:" + url);
System.out.println("userName:" + userName);
System.out.println("passWord:" + passWord);
}
public static void main(String args[]) {
ApplicationContext context = new AnnotationConfigApplicationContext(EnvironmentTest.class);
EnvironmentTest connection = context.getBean(EnvironmentTest.class);
connection.getData();
}
}
// 输出：
// url:jdbc:mysql://localhost:3104/xm_jointly?characterEncoding=utf8
// userName:louzai
// passWord:123456
@ComponentScan用于扫描EnvironmentTest的bean，具体可参考文章《【Spring基础系列3】Spring常用的注解》。
@PropertySource用于引入外部属性配置，然后配合Environment可以读取配置的内容，这个示例一看就懂，So Easy!
@Value
用Environment读取配置，感觉好麻烦，有没有更简单的方式呢，直接看示例：
@ComponentScan({"com.java.annotation.spring.bean.fileconfig"})
@Component
@PropertySource("classpath:jdbc.properties")
@ToString
public class PropertySourceTest {
@Value("${jdbc.shop.url}")
private String url;
@Value("${jdbc.shop.username}")
private String userName;
@Value("${jdbc.shop.password}")
private String passWord;
public static void main(String args[]) {
ApplicationContext context = new AnnotationConfigApplicationContext(PropertySourceTest.class);
PropertySourceTest connection = context.getBean(PropertySourceTest.class);
System.out.println(connection.toString());
}
}
// 输出:
// DBConnection(url=jdbc:mysql://localhost:3104/xm_jointly?characterEncoding=utf8, userName=louzai, passWord=123456)
直接通过@Value进行标注，这个也是项目中常用的姿势，强烈推荐这种。
@Value还可以直接为字段赋值，获取系统属性，这里就不展开了，网上资料很多。
这种读取配置的方式，感觉已经非常优雅了，但是每个配置数据都需要通过@Value赋值，还是有点麻烦，有没有更优雅的方式呢？@ConfigurationProperties登场了。
@ConfigurationProperties
这个是用在SpringBoot中yml配置文件的读取，我们先看通过@Value逐个读取配置的方式。
我们新建一个application.yml配置：
shop:
url: jdbc:mysql://localhost:3104/xm_jointly?characterEncoding=utf8
username: louzai
password: 123456
通过@Value方式
@Service
@RequestMapping
public class HelloWorld {
@Value("${shop.url}")
private String url;
@Value("${shop.username}")
private String userName;
@Value("${shop.password}")
private String passWord;
@ResponseBody
@RequestMapping("/hello")
public String test() {
return "url:" + url + ", userName:" + userName + ", passWord:" + passWord;
}
}
这个和前面的示例很像，只是因为SpringBoot会自动读取application.yml配置，所以不用再指定配置文件扫描路径，启动SpringBoot程序后，输入“http://localhost:8080/hello”，输出如下：
通过@ConfigurationProperties方式
@Service
@RequestMapping
@Setter
@ConfigurationProperties(prefix = "shop")
public class HelloWorld2 {
private String url;
private String username;
private String password;
@ResponseBody
@RequestMapping("/hello2")
public String test() {
return "url:" + url + ", username:" + username + ", password:" + password;
}
}
启动服务后，浏览器输入“http://localhost:8080/hello2”，输出如下：
@Configuration & @Bean
这个常用于配置文件管理类，用于替换XML中的Bean注入，这个必须掌握，具体可参考文章《【Spring基础系列3】Spring常用的注解》
我们一般会结合上面的配置读取方式，然后生成对应的配置类：
@Configuration
@PropertySource("classpath:es.properties")
public class EsConfig {
@Value("${es.hostname}")
private String hostname;
@Value("${es.port}")
private String port;
@Bean
public RestHighLevelClient client() {
return new RestHighLevelClient(RestClient.builder(new Node(new HttpHost(hostname, Integer.parseInt(port)))));
}
}
这样我们就可以得到一个配置类EsConfig，配置类中的RestHighLevelClient已经通过@Bean完成Spring的注入，这个也是项目中常用的实现姿势。
总结
昨天刚陪老婆看了修仙的动画，感觉这篇文章就像修仙一样，修仙等级：炼气→筑基→金丹→元婴→化神→渡劫（合道）→地仙→天仙→金仙→太乙金仙→大罗金仙→准圣→混元大罗金仙（圣人）→天道→大道
炼气：通过XML方式读取配置；
这个在小米中台的代码中，大部分还是这种方式读取配置。
筑基：通过@ImportResource读取XML，但是读取数据值的部分移到了对象中，即将对象的成员变量用@Value赋值。
如果还是依赖XML读取数据，比如旧的系统代码，那这个还是需要使用，只是获取数据配置的值，可以更优雅一些。
金丹：干掉XML，直接通过@PropertySource读取数据配置文件，无需XML中转，但是配置文件数据用Environment获取。
感觉这个已经很少使用了。
元婴：干掉Environment，直接用@Value代替，这个还是结合@PropertySource使用。
如果想干掉XML，就直接用这个代替吧，这个是Spring框架使用配置文件的终极版本。
化神：已经干掉XML，也不用@Value一一替换，直接通过@ConfigurationProperties，自动将配置的数据和类的成员变量名关联。
这个只基于SpringBoot，所以也是我目前遇到的SpringBoot框架使用配置文件的终极版本。
渡劫：结合@Configuration和@Bean，利用配置类，通过自动读取数据配置，然后通过这些数据配置项生成对应的对象，完全摆脱对XML配置的依赖。
这个可以用于Spirng和Spring Boot，也是项目中常见的配置类生成姿势。
后记
写这篇文章前，我一直对Java里面各种读取配置的姿势搞的蒙圈，现在梳理完后，再回想之前看过的一些项目代码，瞬间感觉任通六脉被打通，原来项目中各种读取配置文件的方式，因为代码历史版本的原因，都停留在各个不同的“修仙”阶段。
这也是为什么Java的学习成本比较高，光一个配置文件的读取都搞这么多版本，还是怀念以前写Go的日子，简单纯粹，没办法，目前也只能在Java这条路上被卷吧。
欢迎大家多多点赞，更多文章，请关注微信公众号“楼仔进阶之路”，点关注，不迷路~~