前言
在开发应用程序过程中，经常需要使用外部的属性文件来配置应用程序的行为。Spring框架提供了@PropertySource注解，它可以方便地加载外部的属性文件，并将其中定义的属性值注入到Spring配置中。使用@PropertySource注解，我们可以灵活地管理和维护应用程序的配置信息，提高可维护性和灵活性。
本文将介绍@PropertySource注解的使用方法，以及如何将外部的属性文件加载到Spring配置中。我们将通过一个简单的示例来演示整个过程，并说明一些注意事项。
接下来，我们将详细介绍如何使用@PropertySource注解来加载外部属性文件。让我们开始吧！
一、开始学习
1、新建项目，结构如下
2、添加 spring 依赖
XML
<!-- spring 的核心依赖 -->
<dependencies>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.3.23</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.4.5</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.33</version>
</dependency>
</dependencies>3、 在 resources 下新建一个 db:properties 文件
java
url = jdbc:mysql://localhost:3306/psm
driver = com.mysql.cj.jdbc.Driver
name = root
password = 1234564、在 config 包下新建一个 AppConfig 配置类
java
/**
* @Date 2023-10-10
* @Author qiu
*/
@Configuration
@PropertySource("classpath:db.properties")
@Slf4j
public class AppConfig {
/**
* 使用 @Value 注解结合 spel 表达式进行值注入，也就是将 properties
* 文件中的属性值注入到当前的字段中
*/
@Value("${driver}")
private String driver;
@Value("${url}")
private String url;
@Value("${name}")
private String userName;
@Value("${password}")
private String password;
@Bean
public Connection connection() {
log.info(driver);
log.info(url);
log.info(userName);
log.info(password);
try {
return DriverManager.getConnection(url, userName, password);
} catch (SQLException e) {
throw new RuntimeException("Get connection error", e);
}
}
}注意： 将 properties 文件的属性注入到配置类的字段中，由于 properties 文件是放在 resources 目录下， 因此编译之后会保存在 classpath 目录下，因此需要从 classpath 路径中查找资源文件
这段代码是一个配置类
AppConfig，用于将properties文件中的属性值注入到字段中，并创建一个数据库连接。注解
@PropertySource("classpath:db.properties")指定了db.properties文件位于classpath路径下，用于读取属性值。通过
@Value注解结合 SpEL 表达式，可以将properties文件中的属性值注入到对应的字段中。例如，@Value("${driver}")表示将db.properties中的driver属性值注入到driver字段中。在
connection()方法中，通过DriverManager.getConnection()方法创建数据库连接，使用从properties文件中注入的属性值。最后，使用日志打印了
driver、url、userName和password字段的值。在配置类中使用到了两个注解：
@PropertySource注解用于指定属性文件的位置，并将其加载到 Spring 的环境中。它可以被用于类级别和方法级别。@Value注解用于将属性值注入到类的字段或方法参数中。它可以用来获取属性文件中定义的属性值，也可以使用 SpEL 表达式进行动态赋值。
5、测试
java
@Slf4j
public class Main {
public static void main(String[] args) {
ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
Connection bean = context.getBean(Connection.class);
Connection bean2 = context.getBean(Connection.class);
log.info("con1:" + bean);
log.info("con2:" + bean2);
}
}运行结果
二、使用 @PropertySource 和 @Value 注解的好处
使用@PropertySource和@Value注解的主要好处在于可以统一管理应用程序中的属性值，并将其注入到类的字段或方法参数中，从而提高了应用程序的可配置性和可维护性。具体来说，有以下几点好处：
方便地读取属性文件中的属性值。
@PropertySource注解可以将外部属性文件中的属性值加载到 Spring 应用程序上下文中，而@Value注解则可以方便地读取属性文件中的属性值，并将其注入到类的字段或方法参数中。这样，就不需要手动去读取属性文件，也不需要硬编码属性值，从而降低了代码的耦合度。实现多环境配置。 在不同的环境中，可能需要设置不同的属性值，例如数据库连接地址等。通过在不同的环境中配置不同的属性文件，可以灵活地管理属性值，提高了应用程序的可配置性和可维护性。
提高代码的复用性。 配置类中的
@Bean注解方法可以通过@Value注解获取属性值，并实现对组件的注入，从而使得组件可以被复用。方便地进行测试。 由于通过属性注入的方式，相关的对象可以解耦合，因此便于进行单元测试。
总之，使用 @PropertySource 和 @Value 注解可以方便地统一管理应用程序中的属性值，并将其注入到类的字段或方法参数中，从而提高了应用程序的可配置性和可维护性。