ZetCode

Spring 原型作用域 bean

最后修改于 2023 年 10 月 18 日

Spring 原型作用域 bean 教程演示了如何在 Spring 应用程序中使用原型作用域 bean。

Spring 是一个流行的 Java 应用程序框架,用于创建企业级应用程序。

Spring 原型 bean

原型 bean 每次请求该 bean 时都会被创建。

其他 bean 的作用域有:单例、请求、会话、全局会话和应用程序。

Spring 原型 bean 示例

该应用程序创建了两个原型作用域的 bean,并检查它们是否相同。该应用程序是一个经典的 Spring 5 控制台应用程序。

────src
├───main
│   ├───java
│   │   └───com
│   │       └───zetcode
│   │           │   Application.java
│   │           │
│   │           └───bean
│   │                   Message.java
│   │
│   └───resources
│           logback.xml
│           my-beans.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>prototypescopedbean</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-corespring-context,以及日志 logback-classic 依赖。

exec-maven-plugin 用于从 Maven 命令行执行 Spring 应用程序。

resources/my-beans.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
            http://www.springframework.org/schema/beans/spring-beans.xsd
            http://www.springframework.org/schema/context
            http://www.springframework.org/schema/context/spring-context.xsd">

    <context:component-scan base-package="com.zetcode"/>

</beans>

通过 context:component-scan 标签,我们指示 Spring 在 com.zetcode 包中查找 bean。它将找到我们唯一的 Message bean,该 bean 使用 @Component 注解。

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} [%thread] %blue(%-5level) %magenta(%logger{36}) - %msg %n
            </Pattern>
        </encoder>
    </appender>

    <root>
        <level value="INFO" />
        <appender-ref ref="consoleAppender" />
    </root>
</configuration>

logback.xml 是 Logback 日志库的配置文件。

com/zetcode/bean/Message.java
package com.zetcode.bean;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

@Component
@Scope("prototype")
public class Message {

    private String message;

    public String getMessage() {

        return message;
    }
}

Message 是一个由 Spring 容器管理的 Spring bean。它具有原型作用域。

@Component
@Scope("prototype")
public class Message {

@Scope("prototype") 将 bean 的作用域设置为原型;默认是单例。

com/zetcode/Application.java
package com.zetcode;

import com.zetcode.bean.Message;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.support.GenericXmlApplicationContext;

public class Application {

    private static final Logger logger = LoggerFactory.getLogger(Application.class);

    public static void main(String[] args) {

        var ctx = new GenericXmlApplicationContext("my-beans.xml");

        var beanA = ctx.getBean(Message.class);
        var beanB = ctx.getBean(Message.class);

        if (beanA.equals(beanB)) {

            logger.info("The beans are identical");
        } else {

            logger.info("The beans are not identical");
        }

	ctx.close();
    }
}

这是主应用程序类。

var ctx = new GenericXmlApplicationContext("my-beans.xml");

我们使用 GenericXmlApplicationContextmy-beans.xml 文件创建 Spring 应用程序上下文。

var bean1 = ctx.getBean(Message.class);
var bean2 = ctx.getBean(Message.class);

app.run(bean1, bean2);

我们从应用程序上下文中获取两个 bean,并将它们传递给 run 方法进行比较。

logger.info(a.getMessage());

我们从 bean 中读取消息。

if (a.equals(b)) {

    logger.info("The beans are the same");
} else {

    logger.info("The beans are not the same");
}

我们测试这两个 bean 是否相同。

$ mvn -q exec:java
21:26:03.089 [com.zetcode.Application.main()] INFO  com.zetcode.Application - The beans are not identical

我们运行应用程序。将 Message bean 的作用域更改为单例并比较结果。

在本文中,我们使用了原型 Spring bean。

作者

我的名字是 Jan Bodnar,我是一名充满热情的程序员,拥有丰富的编程经验。自 2007 年以来,我一直撰写编程文章。迄今为止,我已撰写了 1,400 多篇文章和 8 本电子书。我在编程教学方面拥有十多年的经验。

列出 所有 Spring 教程