1.5.1 application.properties 配置文件
使用 Spring Initializr 方式构建 Spring Boot 项目时,会在 resource 目录下自动生成一个空的 application.properties 文件,Spring Boot 项目启动时会自动加载 application.properties 文件。
我们可以在 application.properties 文件中定义 Spring Boot 项目的相关属性,当然,这些相关属性可以是系统属性、环境变量、命令参数等信息,也可以是自定义配置文件名称和位置
server.port=8081
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.config.additional-location=
spring.config.location=
spring.config.name=application
1234567891011
接下来,通过一个案例对 Spring Boot 项目中 application.properties 配置文件的具体使用进行讲解
演示:
预先准备了两个实体类文件,后续会演示将 application.properties 配置文件中的自定义配置属性注入到 Person 实体类的对应属性中
(1)先在项目的 com.lagou 包下创建一个 pojo 包,并在该包下创建两个实体类 Pet 和 Person
public class Pet {
private String type;
private String name;
// 省略属性 getXX()和 setXX()方法
// 省略 toString()方法
}
1234567891011121314151617181920
@Component // 用于将 Person 类作为 Bean 注入到 Spring 容器中
@ConfigurationProperties(prefix =
“person”) // 将配置文件中以 person 开头的属性注入到该类中
public class Person {
private int id; //id
private String name; // 名称
private List hobby; // 爱好
private String[] family; // 家庭成员
private Map map;
private Pet pet; // 宠物
// 省略属性 getXX()和 setXX()方法
// 省略 toString()方法
}
1234567891011121314151617181920212223242526272829303132
@ConfigurationProperties(prefix =
“person”)注解的作用是将配置文件中以 person 开头的属性值通过 setXX()方法注入到实体类对应属性中
@Component 注解的作用是将当前注入属性值的 Person 类对象作为 Bean 组件放到 Spring 容器中,只有这样才能被 @ConfigurationProperties 注解进行赋值
(2)打开项目的 resources 目录下的 application.properties 配置文件,在该配置文件中编写需要对 Person 类设置的配置属性
编写 application.properties 配置文件时,由于要配置的 Person 对象属性是我们自定义的,Spring Boot 无法自动识别,所以不会有任何书写提示。在实际开发中,为了出现代码提示的效果来方便配置,在使用 @ConfigurationProperties 注解进行配置文件属性值注入时,可以在 pom.xml 文件中添加一个 Spring Boot 提供的配置处理器依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
12345678910
在 pom.xml 中添加上述配置依赖后,还需要重新运行项目启动类或者使用“Ctrl+F9”快捷键(即 Build Project)重构当前 Spring Boot 项目方可生效
(3)查看 application.properties 配置文件是否正确,同时查看属性配置效果,打开通过 IDEA 工具创建的项目测试类,在该测试类中引入 Person 实体类 Bean,并进行输出测试
@RunWith(SpringRunner.class) // 测试启动器,并加载 Spring Boot 测试注解
@SpringBootTest // 标记为 Spring Boot 单元测试类,并加载项目的 ApplicationContext 上下文环境
class SpringbootDemoApplicationTests {
// 配置测试
@Autowired
private Person person;
@Test
void
configurationTest() {
System.out.println(person);
}
}
12345678910111213141516171819202122232425262728
打印结果:
[外链图片转存失败, 源站可能有防盗链机制, 建议将图片保存下来直接上传 (img-ltCnakU9-1591329266893)(./images/image-20191225152040345.png)]
可以看出,测试方法 configurationTest()运行成功,同时正确打印出了 Person 实体类对象。至此,说明 application.properties 配置文件属性配置正确,并通过相关注解自动完成了属性注入
1.5.2
application.yaml 配置文件
YAML 文件格式是 Spring
Boot 支持的一种 JSON 超集文件格式,相较于传统的 Properties 配置文件,YAML 文件以数据为核心,是一种更为直观且容易被电脑识别的数据序列化格式。application.yaml 配置文件的工作原理和 application.properties 是一样的,只不过 yaml 格式配置文件看起来更简洁一些。
YAML 文件的扩展名可以使用.yml 或者.yaml。
application.yml 文件使用“key:(空格)value”格式配置属性,使用缩进控制层级关系。
这里,针对不同数据类型的属性值,介绍一下 YAML
(1)value 值为普通数据类型(例如数字、字符串、布尔等)
当 YAML 配置文件中配置的属性值为普通数据类型时,可以直接配置对应的属性值,同时对于字符串类型的属性值,不需要额外添加引号,示例代码如下
server:
port: 8081
path: /hello
12345678
上述代码用于配置 server 的 port 和 path 属性,port 和 path 属于一个级别
(2)value 值为数组和单列集合
当 YAML 配置文件中配置的属性值为数组或单列集合类型时,主要有两种书写方式:缩进式写法和行内式写法。
其中,缩进式写法还有两种表示形式,示例代码如下
person:
hobby:
-
play
-
read
-
sleep
1234567891011121314
或者使用如下示例形式
person:
hobby:
play,
read,
sleep
1234567891011121314
上述代码中,在 YAML 配置文件中通过两种缩进式写法对 person 对象的单列集合(或数组)类型的爱好 hobby 赋值为 play、read 和 sleep。其中一种形式为“-(空格)属性值”,另一种形式为多个属性值之前加英文逗号分隔(注意,最后一个属性值后不要加逗号)。
person:
hobby: [play,read,sleep]
12345
通过上述示例对比发现,YAML 配置文件的行内式写法更加简明、方便。另外,包含属性值的中括号“[]”还可以进一步省略,在进行属性赋值时,程序会自动匹配和校对
(3)value 值为 Map 集合和对象
当 YAML 配置文件中配置的属性值为 Map 集合或对象类型时,YAML 配置文件格式同样可以分为两种书写方式:缩进式写法和行内式写法。
其中,缩进式写法的示例代码如下
person:
map:
k1: v1
k2: v2
1234567891011
对应的行内式写法示例代码如下
person:
map: {k1: v1,k2: v2}
12345
在 YAML 配置文件中,配置的属性值为 Map 集合或对象类型时,缩进式写法的形式按照 YAML 文件格式编写即可,而行内式写法的属性值要用大括号“{}”包含。
接下来,在 Properties 配置文件演示案例基础上,通过配置 application.yaml 配置文件对 Person 对象进行赋值,具体使用如下
(1)在项目的 resources 目录下,新建一个 application.yaml 配置文件,在该配置文件中编写为 Person 类设置的配置属性
对实体类对象 Person 进行属性配置
person:
id:
1
name: lucy
hobby: [吃饭,睡觉,打豆豆]
family: [father,mother]
map: {k1: v1,k2: v2}
pet: {type: dog,name: 旺财}
12345678910111213141516171819202122
(2)再次执行测试
[外链图片转存失败, 源站可能有防盗链机制, 建议将图片保存下来直接上传(img-ZDMYeVnO-1591329266897)(./images/image-20191225154330740.png)]
可以看出,测试方法 configurationTest()同样运行成功,并正确打印出了 Person 实体类对象。
需要说明的是,本次使用 application.yaml 配置文件进行测试时需要提前将 application.properties 配置文件中编写的配置注释,这是因为 application.properties 配置文件会覆盖 application.yaml 配置文件
学习让人快乐,学习更让人觉得无知!学了 1 个多月的《Java 工程师高薪训练营》,才发现自己对每个技术点的认知都很肤浅,根本深不下去,立个 Flag:每天坚持学习一小时,一周回答网上 3 个技术问题,把自己知道都分享出来。