全局配置文件

32次阅读

共计 2520 个字符,预计需要花费 7 分钟才能阅读完成。

1.5 全局配置文件

全局配置文件能够对一些默认配置值进行修改。Spring Boot 使用一个 application.properties 或者 application.yaml 的文件作为全局配置文件,该文件存放在 src/main/resource 目录或者类路径的 /config,一般会选择 resource 目录。接下来,将针对这两种全局配置文件进行讲解:

1.5.1 application.properties 配置文件

使用 Spring Initializr 方式构建 Spring Boot 项目时,会在 resource 目录下自动生成一个空的 application.properties 文件,Spring Boot 项目启动时会自动加载 application.properties 文件。

我们可以在 application.properties 文件中定义 Spring Boot 项目的相关属性,当然,这些相关属性可以是系统属性、环境变量、命令参数等信息,也可以是自定义配置文件名称和位置

properties

server.port=8081

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.config.additional-location=

spring.config.location=

spring.config.name=application

接下来,通过一个案例对 Spring Boot 项目中 application.properties 配置文件的具体使用进行讲解

演示:

预先准备了两个实体类文件,后续会演示将 application.properties 配置文件中的自定义配置属性注入到 Person 实体类的对应属性中

(1)先在项目的 com.lagou 包下创建一个 pojo 包,并在该包下创建两个实体类 Pet 和 Person

java

public class Pet {

private String type;

private String name;

// 省略属性 getXX() 和 setXX() 方法

// 省略 toString() 方法

}

java

@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() 方法

}

@ConfigurationProperties(prefix = “person”) 注解的作用是将配置文件中以 person 开头的属性值通过 setXX() 方法注入到实体类对应属性中

@Component 注解的作用是将当前注入属性值的 Person 类对象作为 Bean 组件放到 Spring 容器中,只有这样才能被 @ConfigurationProperties 注解进行赋值

(2)打开项目的 resources 目录下的 application.properties 配置文件,在该配置文件中编写需要对 Person 类设置的配置属性

<img src=”./images/image-20191225151413976.png” alt=”image-20191225151413976″ style=”zoom:67%;” />

​ 编写 application.properties 配置文件时,由于要配置的 Person 对象属性是我们自定义的,Spring Boot 无法自动识别,所以不会有任何书写提示。在实际开发中,为了出现代码提示的效果来方便配置,在使用 @ConfigurationProperties 注解进行配置文件属性值注入时,可以在 pom.xml 文件中添加一个 Spring Boot 提供的配置处理器依赖:

xml

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-configuration-processor</artifactId>

<optional>true</optional>

</dependency>

​ 在 pom.xml 中添加上述配置依赖后,还需要重新运行项目启动类或者使用“Ctrl+F9”快捷键(即 Build Project)重构当前 Spring Boot 项目方可生效

(3)查看 application.properties 配置文件是否正确,同时查看属性配置效果,打开通过 IDEA 工具创建的项目测试类,在该测试类中引入 Person 实体类 Bean,并进行输出测试

java

@RunWith(SpringRunner.class) // 测试启动器,并加载 Spring Boot 测试注解

@SpringBootTest // 标记为 Spring Boot 单元测试类,并加载项目的 ApplicationContext 上下文环境

class SpringbootDemoApplicationTests {

// 配置测试

@Autowired

private Person person;

@Test

void configurationTest() {

System.out.println(person);

}

}

打印结果:

[image-20191225152040345](./images/image-20191225152040345.png)

可以看出,测试方法 configurationTest() 运行成功,同时正确打印出了 Person 实体类对象。至此,说明 application.properties 配置文件属性配置正确,并通过相关注解自动完成了属性注入

这些内容,是从拉勾教育的《Java 工程师高薪训练营》里学到的,课程内容非常全面,还有拉勾的内推大厂服务,推荐你也看看。

正文完
 0