Spring @Autowired 注解

返回 Spring 基于注释的配置


@Autowired 注解对应该在何处以及如何完成自动装配提供了更细粒度的控制。 @Autowired 注释可用于在 setter 方法上自动装配 bean,就像 @Required 注释、构造函数、具有任意名称和/或多个参数的属性或方法一样。

在 Setter 方法上使用@Autowired

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

示例

在 com.jiyik 包下创建 Java 类 TextEditor、SpellChecker 和 MainApp。

下面是 TextEditor.java 文件的内容

TextEditor.java

package com.jiyik;

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 的内容:

SpellChecker.java

package com.jiyik;

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

下面是MainApp.java文件代码

MainApp.java

package com.jiyik;

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

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/>

   <bean id = "textEditor" class = "com.jiyik.TextEditor">
   </bean>

   <bean id = "spellChecker" class = "com.jiyik.SpellChecker">
   </bean>

</beans>

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

Inside SpellChecker constructor.
Inside checkSpelling.

在Properties 上使用 @Autowired

我们可以在 properties 上使用 @Autowired 注释来替代 setter 方法。 当使用 <property> 传递自动装配属性的值时,Spring 将自动为这些属性分配传递的值或引用。 因此,在 properties 上使用 @Autowired ,我们的 TextEditor.java 文件将如下所示

TextEditor.java

package com.jiyik;

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

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/>

   <bean id = "textEditor" class = "com.jiyik.TextEditor">
   </bean>

   <bean id = "spellChecker" class = "com.jiyik.SpellChecker">
   </bean>

</beans>

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

Inside TextEditor constructor.
Inside SpellChecker constructor.
Inside checkSpelling.

在构造函数上使用 @Autowired

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

TextEditor.java

package com.jiyik;

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

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/>

   <bean id = "textEditor" class = "com.jiyik.TextEditor">
   </bean>

   <bean id = "spellChecker" class = "com.jiyik.SpellChecker">
   </bean>

</beans>

@Autowired (required = false) 选项

默认情况下,@Autowired 注解意味着依赖项是必需的,类似于 @Required 注释,但是,我们可以通过使用 @Autowired 的 (required=false) 选项来关闭默认行为。

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

Student.java

package com.jiyik;

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 基于注释的配置

查看笔记

扫码一下
查看教程更方便