原文: http://zetcode.com/spring/beanreference/

Spring bean 引用教程展示了如何在 Spring 应用的 XML 配置文件中引用 bean。

Spring 是用于创建企业应用的流行 Java 应用框架。

Spring ref属性

ref属性是<ref>标签的快捷方式,用于引用其他注入的 bean。

Spring bean 引用示例

该应用包含两个 bean:infoMessagemesageRenderermesageRenderer通过ref属性引用infoMessage

  1. src
  2. ├───main
  3. ├───java
  4. └───com
  5. └───zetcode
  6. Application.java
  7. ├───bean
  8. IMessage.java
  9. InfoMessage.java
  10. └───service
  11. MessageRenderer.java
  12. └───resources
  13. logback.xml
  14. my-beans.xml
  15. └───test
  16. └───java

这是项目结构。

pom.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5. http://maven.apache.org/xsd/maven-4.0.0.xsd">
  6. <modelVersion>4.0.0</modelVersion>
  7. <groupId>com.zetcode</groupId>
  8. <artifactId>beanreference</artifactId>
  9. <version>1.0-SNAPSHOT</version>
  10. <properties>
  11. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  12. <maven.compiler.source>11</maven.compiler.source>
  13. <maven.compiler.target>11</maven.compiler.target>
  14. <spring-version>5.1.3.RELEASE</spring-version>
  15. </properties>
  16. <dependencies>
  17. <dependency>
  18. <groupId>ch.qos.logback</groupId>
  19. <artifactId>logback-classic</artifactId>
  20. <version>1.2.3</version>
  21. </dependency>
  22. <dependency>
  23. <groupId>org.springframework</groupId>
  24. <artifactId>spring-context</artifactId>
  25. <version>${spring-version}</version>
  26. </dependency>
  27. <dependency>
  28. <groupId>org.springframework</groupId>
  29. <artifactId>spring-core</artifactId>
  30. <version>${spring-version}</version>
  31. </dependency>
  32. </dependencies>
  33. <build>
  34. <plugins>
  35. <plugin>
  36. <groupId>org.codehaus.mojo</groupId>
  37. <artifactId>exec-maven-plugin</artifactId>
  38. <version>1.6.0</version>
  39. <configuration>
  40. <mainClass>com.zetcode.Application</mainClass>
  41. </configuration>
  42. </plugin>
  43. </plugins>
  44. </build>
  45. </project>

pom.xml文件中,我们具有基本的 Spring 依赖项spring-corespring-context和日志记录logback-classic依赖项。

exec-maven-plugin用于在命令行上从 Maven 执行 Spring 应用。

resources/logback.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration>
  3. <logger name="org.springframework" level="ERROR"/>
  4. <logger name="com.zetcode" level="INFO"/>
  5. <appender name="consoleAppender" class="ch.qos.logback.core.ConsoleAppender">
  6. <encoder>
  7. <Pattern>%d{HH:mm:ss.SSS} [%thread] %blue(%-5level) %magenta(%logger{36}) - %msg %n
  8. </Pattern>
  9. </encoder>
  10. </appender>
  11. <root>
  12. <level value="INFO" />
  13. <appender-ref ref="consoleAppender" />
  14. </root>
  15. </configuration>

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

resources/my-beans.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://www.springframework.org/schema/beans
  5. http://www.springframework.org/schema/beans/spring-beans.xsd">
  6. <bean id="infoMessage" class="com.zetcode.bean.InfoMessage"/>
  7. <bean name="messageRenderer" class="com.zetcode.service.MessageRenderer">
  8. <constructor-arg name="message" ref="infoMessage"/>
  9. </bean>
  10. </beans>

my-beans.xml文件声明了两个 bean:infomessageRendererinfoMessage通过ref属性引用infoMessage。 Spring 通过构造器注入将infoMessage bean 注入message属性。

com/zetcode/bean/IMessage.java

  1. package com.zetcode.bean;
  2. public interface IMessage {
  3. String getMessage();
  4. }

IMessage接口具有一个方法声明。

com/zetcode/bean/InfoMessage.java

  1. package com.zetcode.bean;
  2. public class InfoMessage implements IMessage {
  3. public String getMessage() {
  4. return "This is information message";
  5. }
  6. }

InfoMessage bean 返回一条信息消息。

com/zetcode/service/MessageRenderer.java

  1. package com.zetcode.service;
  2. import com.zetcode.Application;
  3. import com.zetcode.bean.IMessage;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. public class MessageRenderer {
  7. private static final Logger logger = LoggerFactory.getLogger(Application.class);
  8. private IMessage message;
  9. public MessageRenderer(IMessage message) {
  10. this.message = message;
  11. }
  12. public void renderMessage() {
  13. logger.info("{}", message.getMessage());
  14. }
  15. }

MessageRenderer呈现一条消息。 它期望注入一个 bean。 Spring 通过构造器注入将infoMessage bean 注入MessageRenderer

com/zetcode/Application.java

  1. package com.zetcode;
  2. import com.zetcode.service.MessageRenderer;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.context.support.GenericXmlApplicationContext;
  6. public class Application {
  7. private static final Logger logger = LoggerFactory.getLogger(Application.class);
  8. public static void main(String[] args) {
  9. var ctx = new GenericXmlApplicationContext("my-beans.xml");
  10. var renderer = (MessageRenderer) ctx.getBean("messageRenderer");
  11. renderer.renderMessage();
  12. ctx.close();
  13. }
  14. }

这是主要的应用类。 它检索MessageRenderer bean 并调用其renderMessage()方法。

  1. $ mvn -q exec:java
  2. 12:05:23.567 [com.zetcode.Application.main()] INFO com.zetcode.Application - This is information message

我们运行该应用。

在本教程中,我们展示了如何使用 Spring 的 XML ref属性引用其他 bean。

您可能也对这些相关教程感兴趣: Spring @Qualifier注解教程Spring context:property-placeholder教程Spring 单例范围 beanSpring 注入列表 XML 教程Spring BeanDefinitionBuilder教程Spring HikariCP 教程Java 教程