一文读懂 Spring Boot 配置文件 application.properties !

2年前 (2022) 程序员胖胖胖虎阿
222 0 0

点击上方 牧码小子 ,选择 置顶或者星标原创技术干货每日送达!

在 Spring Boot 中,配置文件有两种不同的格式,一个是 properties ,另一个是 yaml 。

虽然 properties 文件比较常见,但是相对于 properties 而言,yaml 更加简洁明了,而且使用的场景也更多,很多开源项目都是使用 yaml 进行配置(例如 Hexo)。除了简洁,yaml 还有另外一个特点,就是 yaml 中的数据是有序的,properties 中的数据是无序的,在一些需要路径匹配的配置中,顺序就显得尤为重要(例如我们在 Spring Cloud Zuul 中的配置),此时我们一般采用 yaml。关于 yaml ,松哥之前写过一篇文章:Spring Boot 中的 yaml 配置简介

本文主要来看看 properties 的问题。

位置问题

首先,当我们创建一个 Spring Boot 工程时,默认 resources 目录下就有一个 application.properties 文件,可以在 application.properties 文件中进行项目配置,但是这个文件并非唯一的配置文件,在 Spring Boot 中,一共有 4 个地方可以存放 application.properties 文件。

当前项目根目录下的 config 目录下当前项目的根目录下resources 目录下的 config 目录下resources 目录下

按如上顺序,四个配置文件的优先级依次降低。如下:

一文读懂 Spring Boot 配置文件 application.properties !

这四个位置是默认位置,即 Spring Boot 启动,默认会从这四个位置按顺序去查找相关属性并加载。但是,这也不是绝对的,我们也可以在项目启动时自定义配置文件位置。

例如,现在在 resources 目录下创建一个 javaboy 目录,目录中存放一个 application.properties 文件,那么正常情况下,当我们启动 Spring Boot 项目时,这个配置文件是不会被自动加载的。我们可以通过 spring.config.location 属性来手动的指定配置文件位置,指定完成后,系统就会自动去指定目录下查找 application.properties 文件。

一文读懂 Spring Boot 配置文件 application.properties !

此时启动项目,就会发现,项目以 classpath:/javaboy/application.propertie 配置文件启动。

这是在开发工具中配置了启动位置,如果项目已经打包成 jar ,在启动命令中加入位置参数即可:

java -jar properties-0.0.1-SNAPSHOT.jar --spring.config.location=classpath:/javaboy/

文件名问题

对于 application.properties 而言,它不一定非要叫 application ,但是项目默认是去加载名为 application 的配置文件,如果我们的配置文件不叫 application ,也是可以的,但是,需要明确指定配置文件的文件名。

方式和指定路径一致,只不过此时的 key 是 spring.config.name 。

首先我们在 resources 目录下创建一个 app.properties 文件,然后在 IDEA 中指定配置文件的文件名:

一文读懂 Spring Boot 配置文件 application.properties !

指定完配置文件名之后,再次启动项目,此时系统会自动去默认的四个位置下面分别查找名为 app.properties 的配置文件。当然,允许自定义文件名的配置文件不放在四个默认位置,而是放在自定义目录下,此时就需要明确指定 spring.config.location 。

配置文件位置和文件名称可以同时自定义。

普通的属性注入

由于 Spring Boot 源自 Spring ,所以 Spring 中存在的属性注入,在 Spring Boot 中一样也存在。由于 Spring Boot 中,默认会自动加载 application.properties 文件,所以简单的属性注入可以直接在这个配置文件中写。

例如,现在定义一个 Book 类:

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 对象中:

@Componentpublic 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

此时,项目启动并不会自动的加载该配置文件,如果是在 XML 配置中,可以通过如下方式引用该 properties 文件:

<context:property-placeholder location="classpath:book.properties"/>

如果是在 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}

这里,主要是引入 @ConfigurationProperties(prefix = "book") 注解,并且配置了属性的前缀,此时会自动将 Spring 容器中对应的数据注入到对象对应的属性中,就不用通过 @Value 注解挨个注入了,减少工作量并且避免出错。

总结

application.properties 是 Spring Boot 中配置的一个重要载体,很多组件的属性都可以在这里定制。它的用法和 yaml 比较类似,关于 yaml 配置,大家可以参考 Spring Boot 中的 yaml 配置简介 。

本文案例我已上传到 GitHub:https://github.com/lenve/javaboy-code-samples

好了,有问题欢迎留言讨论。

一文读懂 Spring Boot 配置文件 application.properties !

●这一次,我连 web.xml 都不要了,纯 Java 搭建 SSM 环境

●没有一条路是容易的,特别是转行计算机这条路

●Spring Boot + Vue 前后端分离开发,权限管理的一点思路

●Spring Boot + Vue 前后端分离开发,前端网络请求封装与配置

●徒手撸一个 Spring Boot 中的 Starter ,解密自动化配置黑魔法!

●整理了八个开源的 Spring Boot 学习资源

●Java 开发中到底该不该用 Lombok?

●提高性能,MySQL  读写分离环境搭建(二)

●提高性能,MySQL  读写分离环境搭建(一)

一文读懂 Spring Boot 配置文件 application.properties !

一文读懂 Spring Boot 配置文件 application.properties !
你点的每个赞,我都认真当成了喜欢

本文分享自微信公众号 - 江南一点雨(a_javaboy)。
如有侵权,请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”,欢迎正在阅读的你也加入,一起分享。

相关文章

暂无评论

暂无评论...