Spring Boot中采用了大量的自动化配置,但是对开发者而言,在实际项目中不可避免会有一些需要自己手动配置,承载这些自定义配置的文件就是resources目录下的application.properties文件(也可以使用YAML配置来替代application.properties配置)。
本节将对application.properties的使用做进一步的介绍。
Spring Boot项目中的application.properties配置文件一共可以出现在如下4个位置:
• 项目根目录下的config文件夹中。
• 项目根目录下。
• classpath下的config文件夹中。
• classpath下。
如果这4个位置中都有application.properties文件,那么加载的优先级从1到4依次降低,
• 项目根目录下的config文件夹中。(第1)
• 项目根目录下。(第2)
• classpath下的config文件夹中。(第3)
• classpath下。(第4)
Spring Boot将按照这个优先级查找配置信息,并加载到Spring Environment中。
如果开发者在开发中未使用application.properties,而是使用了application.yml作为配置文件,那么配置文件的优先级与上面一致。
类型安全配置属性
前面,读者已经了解到无论是Properties配置还是YAML配置,最终都会被加载到Spring Environment中。Spring提供了@Value注解以及EnvironmentAware接口来将Spring Environment中的数据注入到属性上,Spring Boot对此进一步提出了类型安全配置属性(Type-safe Configuration Properties),这样即使在数据量非常庞大的情况下,也可以更加方便地将配置文件中的数据注入Bean中。考虑在application.properties中添加如下一段配置:
使用idea工具新建springboot项目,截图如下
application.properties
server.port=8099
book.name=BookName
book.author=BookAuthor
book.price=33
将这一段配置数据注入如下Bean中:
Book.java
package com.shrimpking.pojo;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "book")
public class Book
{
private String name;
private String author;
private Float price;
public Book()
{
}
public Book(String name, String author, Float price)
{
this.name = name;
this.author = author;
this.price = price;
}
public String getName()
{
return name;
}
public void setName(String name)
{
this.name = name;
}
public String getAuthor()
{
return author;
}
public void setAuthor(String author)
{
this.author = author;
}
public Float getPrice()
{
return price;
}
public void setPrice(Float price)
{
this.price = price;
}
@Override
public String toString()
{
return "Book{" + "name='" + name + '\'' + ", author='" + author + '\'' + ", price=" + price + '}';
}
}
代码解释:
• @ConfigurationProperties中的prefix属性描述了要加载的配置文件的前缀。
• 如果配置文件是一个YAML文件,那么可以将数据注入一个集合中。
• Spring Boot采用了一种宽松的规则来进行属性绑定,如果Bean中的属性名为authorName,那么配置文件中的属性可以是book.author_name、book.author-name、book.authorName或者book.AUTHORNAME。
最后创建BookController进行简单测试:
BookController.java
package com.shrimpking.controller;
import com.shrimpking.pojo.Book;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class BookController
{
@Autowired
private Book book;
@GetMapping("/book")
public String book()
{
return book.toString();
}
}
运行截图