Spring Boot 的配置文件属性注入
简介:
在 Spring Boot 中,配置文件有两种不同的格式,一个是 properties ,另一个是 yaml 。
yaml 更加简洁明, 数据有序;而properties 中的数据是无序
但是,yaml配置目前不支持@PropertySource注解
对于 application.properties 而言,它不一定非要叫 application ,但是项目默认是去加载名为 application 的配置文件,如果我们的配置文件不叫 application ,也是可以的,但是,需要明确指定配置文件的文件名。
普通的属性注入
由于 Spring Boot 源自 Spring ,所以 Spring 中存在的属性注入,在 Spring Boot 中一样也存在。由于 Spring Boot 中,默认会自动加载 application.properties 文件,所以简单的属性注入可以直接在这个配置文件中写
public class Book {
private Long id;
private String name;
private String author;
//省略 getter/setter
}
然后,在 application.properties 文件中定义属性
book.name=三国演义
book.author=罗贯中
book.id=1
按照传统的方式(Spring中的方式),可以直接通过 @Value 注解将这些属性注入到 Book 对象中:
@Component
public class Book {
@Value("${book.id}")
private Long id;
@Value("${book.name}")
private String name;
@Value("${book.author}")
private String author;
//省略getter/setter
}
注意
Book 对象本身也要交给 Spring 容器去管理,如果 Book 没有交给 Spring 容器,那么 Book 中的属性也无法从 Spring 容器中获取到值。
配置完成后,在 Controller 或者单元测试中注入 Book 对象,启动项目,就可以看到属性已经注入到对象中了。
一般来说,我们在 application.properties 文件中主要存放系统配置,这种自定义配置不建议放在该文件中,可以自定义 properties 文件来存在自定义配置。
例如在 resources 目录下,自定义 book.properties 文件,内容如下:
book.name=三国演义
book.author=罗贯中
book.id=1
如果是在 Java 配置中,可以通过 @PropertySource 来引入配置:
@Component
@PropertySource("classpath:book.properties")
public class Book {
@Value("${book.id}")
private Long id;
@Value("${book.name}")
private String name;
@Value("${book.author}")
private String author;
//getter/setter
}
当项目启动时,就会自动加载 book.properties 文件。
这只是 Spring 中属性注入的一个简单用法,和 Spring Boot 没有任何关系。
类型安全的属性注入
Spring Boot 引入了类型安全的属性注入,如果采用 Spring 中的配置方式,当配置的属性非常多的时候,工作量就很大了,而且容易出错。
使用类型安全的属性注入,可以有效的解决这个问题
@Component
@PropertySource("classpath:book.properties")
@ConfigurationProperties(prefix = "book")
public class Book {
private Long id;
private String name;
private String author;
//省略getter/setter
}
这里,使用@PropertySource指定自定义配置文件名称,引入 @ConfigurationProperties(prefix = “book”) 注解,并且配置了属性的前缀,配置文件中后缀与对象属性名称保持一致,此时会自动将 Spring 容器中对应的数据注入到对象对应的属性中,就不用通过 @Value 注解挨个注入了,减少工作量并且避免出错。
推荐阅读
-
spring AOP的两种配置
-
spring Boot环境下dubbo+zookeeper的一个基础讲解与示例
-
Spring Boot 配置元数据指南
-
spring-boot-2.0.3不一样系列之源码篇 - run方法(三)之createApplicationContext,绝对有值得你看的地方
-
spring boot加载资源路径配置和classpath问题解决
-
spring boot使用自定义的线程池执行Async任务
-
Spring Boot Dubbo 构建分布式服务的方法
-
Spring Boot实现STOMP协议的WebSocket的方法步骤
-
详解Spring Boot配置使用Logback进行日志记录的实战
-
spring boot静态变量注入配置文件详解