Spring @PropertySource 注释教程
最后修改于 2023 年 10 月 18 日
Spring @PropertySource 注释教程演示了如何使用 @PropertySource 注释将属性包含到 Environment 中，并使用 @Value 注入属性。
Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。
Spring @PropertySource
@PropertySource 是一个方便的注释，用于将 PropertySource 包含到 Spring 的 Environment 中，并允许通过 @Value 将属性注入到类属性中。（PropertySource 是一个代表来自特定源的属性对集合的对象。）
@PropertySource 与 @Configuration 一起使用。
Spring @PropertySource 示例
该应用程序使用 Spring 的 @PropertySource 将 application.properties 文件中的属性包含到 Environment 中，并将它们注入到类属性中。
pom.xml
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ └───config
│ │ AppConfig.java
│ └───resources
│ application.properties
│ logback.xml
└───test
└───java
这是项目结构。
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zetcode</groupId>
<artifactId>propertysource</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<spring-version>5.3.23</spring-version>
</properties>
<dependencies>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.4.0</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring-version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>${spring-version}</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>3.1.0</version>
<configuration>
<mainClass>com.zetcode.Application</mainClass>
</configuration>
</plugin>
</plugins>
</build>
</project>
在 pom.xml 文件中，我们有基本的 Spring 依赖 spring-core、spring-context 和日志 logback-classic 依赖。
exec-maven-plugin 用于从 Maven 命令行执行 Spring 应用程序。
resources/logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<logger name="org.springframework" level="ERROR"/>
<logger name="com.zetcode" level="INFO"/>
<appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<Pattern>%d{HH:mm:ss.SSS} %blue(%-5level) %magenta(%logger{36}) - %msg %n
</Pattern>
</encoder>
</appender>
<root>
<level value="INFO" />
<appender-ref ref="consoleAppender" />
</root>
</configuration>
logback.xml 是 Logback 日志库的配置文件。
resources/application.properties
app.name=My application app.version=1.1
我们在 application.properties 文件中有两个属性。
com/zetcode/config/AppConfig.java
package com.zetcode.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
@Configuration
@PropertySource(value = "application.properties", ignoreResourceNotFound = true)
public class AppConfig {
}
AppConfig 是应用程序配置类。@PropertySource 将 application.properties 中的属性注入到 Spring 的 Environment 中。
com/zetcode/Application.java
package com.zetcode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.core.env.Environment;
@ComponentScan(basePackages = "com.zetcode")
public class Application {
private static final Logger logger = LoggerFactory.getLogger(Application.class);
@Autowired
private Environment env;
@Value("${app.name}")
private String appName;
@Value("${app.version}")
private String appVersion;
public static void main(String[] args) {
var ctx = new AnnotationConfigApplicationContext(Application.class);
var app = ctx.getBean(Application.class);
app.run();
ctx.close();
}
private void run() {
logger.info("From Environment");
logger.info("Application name: {}", env.getProperty("app.name"));
logger.info("Application version: {}", env.getProperty("app.version"));
logger.info("Using @Value injection");
logger.info("Application name: {}", appName);
logger.info("Application version: {}", appVersion);
}
}
在 Application 中，我们通过两种方法获取属性。
@Autowired private Environment env;
我们注入 Environment。我们可以使用它的 getProperty 方法检索属性。
@Value("${app.name}")
private String appName;
@Value("${app.version}")
private String appVersion;
我们使用 @Value 注释将属性注入到属性中。
logger.info("From Environment");
logger.info("Application name: {}", env.getProperty("app.name"));
logger.info("Application version: {}", env.getProperty("app.version"));
检索属性的第一种方法是从 Environment 使用 getProperty 方法。
logger.info("Using @Value injection");
logger.info("Application name: {}", appName);
logger.info("Application version: {}", appVersion);
第二种方法是使用注入的属性。
$ mvn -q exec:java 15:00:20.653 INFO com.zetcode.Application - From Environment 15:00:20.668 INFO com.zetcode.Application - Application name: My application 15:00:20.668 INFO com.zetcode.Application - Application version: 1.1 15:00:20.668 INFO com.zetcode.Application - Using @Value injection 15:00:20.668 INFO com.zetcode.Application - Application name: My application 15:00:20.668 INFO com.zetcode.Application - Application version: 1.1
我们运行应用程序。
在本文中，我们展示了如何使用 @PropertySource 注释在 Spring 应用程序中方便地处理属性。
作者
列出 所有 Spring 教程。