Spring @Autowired 注解

@Autowired 注解提供了对自动装配的位置和方式进行更细粒度的控制。 @Autowired 注解可用于在 setter 方法上自动装配 bean,就像 @Required 注解、构造函数、具有任意名称和/或多个参数的属性或方法一样。


@Autowired 在 Setter 方法上

您可以在 setter 方法上使用 @Autowired 注解来摆脱 XML 配置文件中的 <property> 元素。 当 Spring 发现与 setter 方法一起使用的 @Autowired 注解时,它会尝试对方法执行 byType 自动装配。

示例

让我们准备好工作的 Eclipse IDE,然后按照以下步骤创建 Spring 应用程序 −

步骤 说明
1 创建一个名为 SpringExample 的项目,并在创建的项目中的 src 文件夹下创建一个包 com.tutorialspoint
2 使用 Add External JARs 选项添加所需的 Spring 库,如 Spring Hello World 示例 一章中所述。
3 com.tutorialspoint 包下创建 Java 类 Text Editor、SpellCheckerMainApp
4 src 文件夹下创建 Beans 配置文件 Beans.xml
5 最后一步是创建所有 Java 文件和 Bean 配置文件的内容,然后运行应用程序,如下所述。

这是 TextEditor.java 文件的内容 −

package com.tutorialspoint;

import org.springframework.beans.factory.annotation.Autowired;

public class TextEditor {
   private SpellChecker spellChecker;

   @Autowired
   public void setSpellChecker( SpellChecker spellChecker ){
      this.spellChecker = spellChecker;
   }
   public SpellChecker getSpellChecker( ) {
      return spellChecker;
   }
   public void spellCheck() {
      spellChecker.checkSpelling();
   }
}

以下是另外一个依赖类文件SpellChecker.java的内容:

package com.tutorialspoint;

public class SpellChecker {
   public SpellChecker(){
      System.out.println("Inside SpellChecker constructor." );
   }
   public void checkSpelling(){
      System.out.println("Inside checkSpelling." );
   }
}

以下是 MainApp.java 文件的内容 −

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
   public static void main(String[] args) {
      ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");

      TextEditor te = (TextEditor) context.getBean("textEditor");

      te.spellCheck();
   }
}

以下是配置文件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:annotation-config/>

   <!-- Definition for textEditor bean without constructor-arg  -->
   <bean id = "textEditor" class = "com.tutorialspoint.TextEditor">
   </bean>

   <!-- Definition for spellChecker bean -->
   <bean id = "spellChecker" class = "com.tutorialspoint.SpellChecker">
   </bean>

</beans>

创建完源和 bean 配置文件后,让我们运行应用程序。 如果您的应用程序一切正常,这将打印以下消息 −

Inside SpellChecker constructor.
Inside checkSpelling.

@Autowired 属性

您可以在属性上使用 @Autowired 注解来摆脱 setter 方法。 当您使用 a1 传递自动装配属性的值时,Spring 将自动为这些属性分配传递的值或引用。 因此,在属性上使用 @Autowired 您的 TextEditor.java 文件将如下所示 −

package com.tutorialspoint;

import org.springframework.beans.factory.annotation.Autowired;

public class TextEditor {
   @Autowired
   private SpellChecker spellChecker;

   public TextEditor() {
      System.out.println("Inside TextEditor constructor." );
   }
   public SpellChecker getSpellChecker( ){
      return spellChecker;
   }
   public void spellCheck(){
      spellChecker.checkSpelling();
   }
}

以下是配置文件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:annotation-config/>

   <!-- Definition for textEditor bean -->
   <bean id = "textEditor" class = "com.tutorialspoint.TextEditor">
   </bean>

   <!-- Definition for spellChecker bean -->
   <bean id = "spellChecker" class = "com.tutorialspoint.SpellChecker">
   </bean>

</beans>

一旦您完成了源和 bean 配置文件中的上述两项更改,让我们运行应用程序。 如果您的应用程序一切正常,这将打印以下消息 −

Inside TextEditor constructor.
Inside SpellChecker constructor.
Inside checkSpelling.

@Autowired 在构造函数上

您也可以将 @Autowired 应用于构造函数。 构造函数 @Autowired 注解指示在创建 bean 时应该自动装配构造函数,即使在 XML 文件中配置 bean 时没有使用 <constructor-arg> 元素。 让我们检查以下示例。

这是 TextEditor.java 文件的内容 −

package com.tutorialspoint;

import org.springframework.beans.factory.annotation.Autowired;

public class TextEditor {
   private SpellChecker spellChecker;

   @Autowired
   public TextEditor(SpellChecker spellChecker){
      System.out.println("Inside TextEditor constructor." );
      this.spellChecker = spellChecker;
   }
   public void spellCheck(){
      spellChecker.checkSpelling();
   }
}

以下是配置文件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:annotation-config/>

   <!-- Definition for textEditor bean without constructor-arg  -->
   <bean id = "textEditor" class = "com.tutorialspoint.TextEditor">
   </bean>

   <!-- Definition for spellChecker bean -->
   <bean id = "spellChecker" class = "com.tutorialspoint.SpellChecker">
   </bean>

</beans>

一旦您完成了源和 bean 配置文件中的上述两个更改,让我们运行应用程序。 如果您的应用程序一切正常,这将打印以下消息:

Inside SpellChecker constructor.
Inside TextEditor constructor.
Inside checkSpelling.

@Autowired with (required = false) 选项

默认情况下,@Autowired 注解暗示依赖项是必需的,类似于 @Required 注解,但是,您可以通过使用带有 @Autowired 的 (required=false) 选项来关闭默认行为。

即使您没有为 age 属性传递任何值,以下示例也将起作用,但它仍然需要 name 属性。 您可以自己尝试此示例,因为这类似于 @Required 注解示例,只是仅更改了 Student.java 文件。

package com.tutorialspoint;

import org.springframework.beans.factory.annotation.Autowired;

public class Student {
   private Integer age;
   private String name;

   @Autowired(required=false)
   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      return age;
   }
   
   @Autowired
   public void setName(String name) {
      this.name = name;
   }
   public String getName() {
      return name;
   }
}

❮ Spring 基于注解的配置