Spring Boot2 系列教程(四)理解配置文件 application.properties ！

港控/mmm° 2024-04-18 17:11 0阅读 0赞

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

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

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

## 位置问题 ##

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

1.  当前项目根目录下的 config 目录下
2.  当前项目的根目录下
3.  resources 目录下的 config 目录下
4.  resources 目录下

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

![640?wx\_fmt=png][640_wx_fmt_png]

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

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

![640?wx\_fmt=png][640_wx_fmt_png 1]

此时启动项目，就会发现，项目以 `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 中指定配置文件的文件名：

![640?wx\_fmt=png][640_wx_fmt_png 2]

指定完配置文件名之后，再次启动项目，此时系统会自动去默认的四个位置下面分别查找名为 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 对象中：

@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

此时，项目启动并不会自动的加载该配置文件，如果是在 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 配置简介][Spring Boot _ yaml] 。

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

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

![640?wx\_fmt=gif][640_wx_fmt_gif]

![640?wx\_fmt=gif][640_wx_fmt_gif 1]

1、 [一键部署 Spring Boot 到远程 Docker 容器，就是这么秀！][Spring Boot _ Docker]

2、 [完结撒花！129 集 21 个小时，松哥自制的 Spring Boot2 系列视频教程杀青啦！][129 _ 21 _ Spring Boot2]

3、 [40 篇原创干货，带你进入 Spring Boot 殿堂！][40 _ Spring Boot]

4、 [Spring Boot 中的同一个 Bug，竟然把我坑了两次！][Spring Boot _ Bug]

5、 [Spring Boot 支持 Https 有那么难吗？][Spring Boot _ Https]

6、 [一个野生程序员的自我修养][Link 1]

7、 [干货 | 鸟瞰 MySQL，唬住面试官！][_ _ MySQL]

8、 [Spring Boot 修改静态资源一定要重启项目才会生效吗？未必！][Spring Boot]

9、 [Spring Boot 跨域，JSONP 太 low，试试 CORS 怎么样？][Spring Boot _JSONP _ low_ CORS]

![640?wx\_fmt=png][640_wx_fmt_png 3]

喜欢就点个"在看"呗^\_^

[Spring Boot _ yaml]: https://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247485055&idx=1&sn=54ebd48d58eee3b36c107a73bdc9f13f&scene=21#wechat_redirect
[640_wx_fmt_png]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_png/GvtDGKK4uYnic1lz1DzknAlbfR2G9HGHibjBXgVLJmrllaJP1aw1Nt0VKPYF8bdZbMJtMn7KXOhg3XBxLjw8xdibA/640?wx_fmt=png
[640_wx_fmt_png 1]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_png/GvtDGKK4uYnic1lz1DzknAlbfR2G9HGHibwwL51krTic9rT61hr7UgIHyVCyiaV5BySh9xCQOBeQOb9YzDdxTPBKjg/640?wx_fmt=png
[640_wx_fmt_png 2]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_png/GvtDGKK4uYnic1lz1DzknAlbfR2G9HGHib36nhOX94HmibwBSkSjialL1mvg8q6A2noibBm3qZ1do8FnKvdJJMRtNrQ/640?wx_fmt=png
[640_wx_fmt_gif]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_gif/7QRTvkK2qC5Q3Q2JPcAgQibyJut3L80CAvxE9FKNHZ3MlZdLMhD7oYO7k0siaiciblpNuFV6xoenXkrQe3pTRnweVw/640?wx_fmt=gif
[640_wx_fmt_gif 1]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_gif/7QRTvkK2qC6aqek98EtTHUKcyP8jibR2dMpmVDlnHv7DyMlWaib0sO2Qib2XtVPL8wictxAoKMch1iancskn5BpaYcg/640?wx_fmt=gif
[Spring Boot _ Docker]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486342&idx=1&sn=b8adcef8237f3d222816c985ff58b654&chksm=e9c359e6deb4d0f05b28de50e03a59bcc42a0213cac827828d98aa9834979852657f4dd1b613&scene=21#wechat_redirect
[129 _ 21 _ Spring Boot2]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486306&idx=1&sn=a702902990f4cb7fa84c1c23fcba6e92&chksm=e9c35902deb4d0141c7bc42f378542e49b54f2283e2cfe6225542495f3dd65d13c0f1f07fc92&scene=21#wechat_redirect
[40 _ Spring Boot]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486246&idx=1&sn=7aa23f40fa044775e98fccffaa8d43d1&chksm=e9c35946deb4d05063a14258429cc7c21b232018a195d7b4281e2a3cea6500fd9f19ab401780&scene=21#wechat_redirect
[Spring Boot _ Bug]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486166&idx=1&sn=ca0528531239410aa4b4a113f10ebc3b&chksm=e9c358b6deb4d1a09f6a0572e829e1fd78f06e7385d08017c0e864ffa32c500f281a6bd9ef04&scene=21#wechat_redirect
[Spring Boot _ Https]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486160&idx=1&sn=2dd53840370ab6a69aa1e910fbce01d1&chksm=e9c358b0deb4d1a6a6d9b2d47b58da3a4a7483147ef84ba059a47d10d7efbc61bcdeff1e503a&scene=21#wechat_redirect
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486150&idx=1&sn=0ffc7a2191058f8aa558c3cf9b062a74&chksm=e9c358a6deb4d1b0a4b16cfeeddd9ae70f483c6494eee55addba648eec757fee371dccb295c8&scene=21#wechat_redirect
[_ _ MySQL]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486126&idx=1&sn=cdfbfc882bdf78ce45147abec317530c&chksm=e9c358cedeb4d1d8390f8481108ca480e0e2e912f7ceceee492733c179a40fc59296f920381a&scene=21#wechat_redirect
[Spring Boot]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486119&idx=1&sn=c2cbf2e7f737fba902f6ebb25dabaefe&chksm=e9c358c7deb4d1d1305abd486554f77af7b35dae40b4f7fb93c109a373f250c57183e5899529&scene=21#wechat_redirect
[Spring Boot _JSONP _ low_ CORS]: http://mp.weixin.qq.com/s?__biz=MzI1NDY0MTkzNQ==&mid=2247486095&idx=1&sn=f446acdf5b26549ccead854b8e0a873f&chksm=e9c358efdeb4d1f9d7b306c25b731fa6baa064bd5dc3051bb386621e0bf74fc969b694588227&scene=21#wechat_redirect
[640_wx_fmt_png 3]: https://ss.csdn.net/p?https://mmbiz.qpic.cn/mmbiz_png/GvtDGKK4uYmzAibpvlHvHcPpkzvsppdwNtN0Q1IDXhcPdFKFiclV6fmHf7kPmG0YPJM0xMTyjkd67GiamNBHGed3A/640?wx_fmt=png