Spring @Configuration 教程
最后修改于 2023 年 10 月 18 日
Spring @Configuration 注解教程展示了如何使用 @Configuration 注解来配置 Spring 应用程序。
Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。
Spring @Configuration
@Configuration 注解用于基于 Spring 注解的配置。@Configuration 是一个标记注解，它表明一个类声明了一个或多个 @Bean 方法，并且可以在运行时被 Spring 容器处理，以生成 Bean 定义和服务请求。
Spring @Configuration 示例
下面的应用程序使用 @Configuration 来配置一个 Spring 应用程序。
pom.xml
src
└───src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ └───config
│ │ AppConfig.java
│ │ H2Configurer.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>configurationex</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.db=H2
这里有一些应用程序属性。
com/zetcode/config/AppConfig.java
package com.zetcode.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
@Configuration
@ComponentScan(basePackages = "com.zetcode")
@PropertySource(value = "application.properties")
public class AppConfig {
@Bean
public H2Configurer databaseConfig() {
return new H2Configurer();
}
}
AppConfig 是应用程序的配置类。它被 @Configuration 注解装饰，这是 @Component 的一个特例。
@Configuration
@ComponentScan(basePackages = "com.zetcode")
@PropertySource(value = "application.properties")
public class AppConfig {
使用 @ComponentScan 启用组件扫描，并使用 @PropertySource 加载资源。
@Bean
public H2Configurer databaseConfig() {
return new H2Configurer();
}
使用 @Bean 注解，我们创建一个 H2Configurer Bean。
com/zetcode/config/H2Configurer.java
package com.zetcode.config;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class H2Configurer {
private static final Logger logger = LoggerFactory.getLogger(H2Configurer.class);
public H2Configurer() {
logger.info("Configuring H2 database");
}
}
H2Configurer 仅打印一条消息。
com/zetcode/Application.java
package com.zetcode;
import com.zetcode.config.AppConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.stereotype.Component;
@Component
public class Application {
private static final Logger logger = LoggerFactory.getLogger(Application.class);
public static void main(String[] args) {
var ctx = new AnnotationConfigApplicationContext(AppConfig.class);
var app = ctx.getBean(Application.class);
app.run();
ctx.close();
}
@Value("${app.name}")
private String applicationName;
@Value("${app.db}")
private String database;
private void run() {
logger.info("Application name: {}", applicationName);
logger.info("Database: {}", database);
}
}
应用程序类打印应用程序属性。属性通过 @Value 注入到属性中。
var ctx = new AnnotationConfigApplicationContext(AppConfig.class);
AppConfig 被加载到应用程序上下文中。
$ mvn -q exec:java 20:07:39.769 INFO com.zetcode.config.H2Configurer - Configuring H2 database 20:07:39.801 INFO com.zetcode.Application - Application name: My application 20:07:39.816 INFO com.zetcode.Application - Database: H2
我们运行应用程序。
在本教程中，我们使用 @Configuration 配置了一个 Spring 应用程序。
作者
列出 所有 Spring 教程。