Spring @Bean
最后修改于 2023 年 10 月 18 日
在本文中，我们展示了如何使用 @Bean 注解在 Java 配置类中声明 bean。
Spring 是一个流行的 Java 应用程序框架，用于创建企业级应用程序。
Spring @Bean
@Bean 注解表示被注解的方法会生成一个由 Spring 容器管理的 bean。它直接对应于 <bean/> XML 标签。@Bean 支持 <bean/> 提供的大部分属性，例如：init-method、destroy-method、autowiring、lazy-init、dependency-check、depends-on、scope。
Spring @Bean 示例
该应用程序使用 @Bean 注解生成一个 Spring 管理的 bean。它还为该 bean 提供了一些别名。
pom.xml
src
├───main
│ ├───java
│ │ └───com
│ │ └───zetcode
│ │ │ Application.java
│ │ ├───bean
│ │ │ HelloMessage.java
│ │ └───config
│ │ AppConfig.java
│ └───resources
│ logback.xml
│ messages.properties
└───test
└───java
这是项目结构。
<?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>beanannotation</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 应用程序。
<?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 日志库的配置文件。
motd="Hello there!"
messages.properties 包含一个每日消息属性，我们的 HelloMessage bean 使用了它。这使得应用程序更加灵活，并避免将消息硬编码到 Java 代码中。
package com.zetcode.bean;
public class HelloMessage {
private String message;
public HelloMessage(String message) {
this.message = message;
}
public String getMessage() {
return message;
}
}
HelloMessage bean 是通过一个带有 @Bean 注解的方法创建的。
package com.zetcode.config;
import com.zetcode.bean.HelloMessage;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
@Configuration
@PropertySource(value="messages.properties")
public class AppConfig {
@Value("${motd}")
private String message;
@Bean(name={"myMessage", "motd"})
public HelloMessage helloMessageProducer() {
var helloMessage = new HelloMessage(message);
return helloMessage;
}
}
我们在 AppConfig 中定义了一个 HelloMessage 生产者。
@Configuration
@PropertySource(value="messages.properties")
public class AppConfig {
使用 @Configuration，我们声明 AppConfig 是一个配置类。@PropertySource 注解允许我们轻松地使用 messages.properties 文件中的属性，配合 @Value 使用。
@Value("${motd}")
private String message;
我们将 motd 属性注入到 message 属性中。
@Bean(name={"myMessage", "motd"})
public HelloMessage helloMessageProducer() {
var helloMessage = new HelloMessage(message);
return helloMessage;
}
helloMessageProducer 生成一个新的 HelloMessage bean。它从外部属性获取其消息。@Bean 注解使 HelloMessage bean 由 Spring 生成和管理。此外，我们为该 bean 提供了两个别名。
package com.zetcode;
import com.zetcode.bean.HelloMessage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.ComponentScan;
@ComponentScan(basePackages = "com.zetcode")
public class Application {
private static final Logger logger = LoggerFactory.getLogger(Application.class);
public static void main(String[] args) {
var ctx = new AnnotationConfigApplicationContext(Application.class);
var msgBean1 = ctx.getBean(HelloMessage.class);
logger.info("{}", msgBean1.getMessage());
var msgBean2 = (HelloMessage) ctx.getBean("myMessage");
logger.info("{}", msgBean2.getMessage());
var msgBean3 = (HelloMessage) ctx.getBean("motd");
logger.info("{}", msgBean3.getMessage());
ctx.close();
}
}
应用程序用 @ComponentScan 注解。basePackages 选项告诉 Spring 在 com/zetcode 包及其子包中查找组件。
var ctx = new AnnotationConfigApplicationContext(Application.class);
AnnotationConfigApplicationContext 是一个 Spring 独立应用程序上下文。它接受被注解的 Application 作为输入；因此，扫描是启用的。
var msgBean1 = ctx.getBean(HelloMessage.class);
logger.info("{}", msgBean1.getMessage());
我们通过类型获取 bean。
var msgBean2 = (HelloMessage) ctx.getBean("myMessage");
logger.info("{}", msgBean2.getMessage());
var msgBean3 = (HelloMessage) ctx.getBean("motd");
logger.info("{}", msgBean3.getMessage());
这里我们通过别名获取相同的 bean。
$ mvn -q exec:java 14:39:29.324 INFO com.zetcode.Application - "Hello there!" 14:39:29.324 INFO com.zetcode.Application - "Hello there!" 14:39:29.324 INFO com.zetcode.Application - "Hello there!"
我们运行应用程序。
在本文中，我们使用 @Bean 注解来生成一个托管的 Spring bean。
作者
列出 所有 Spring 教程。