Skip to content

Spring-自动装配

一、自动装配说明

  • 自动装配是使用 spring 满足 bean 依赖的一种方法
  • spring 会在应用上下文中为某个 bean 寻找其依赖的 bean。

Spring 中 bean 有三种装配机制,分别是:

  1. 在 xml 中显式配置;
  2. 在 java 中显式配置;
  3. 隐式的 bean 发现机制和自动装配。

这里我们主要讲第三种:自动化的装配 bean。

Spring 的自动装配需要从两个角度来实现,或者说是两个操作:

  1. 组件扫描(component scanning):spring 会自动发现应用上下文中所创建的 bean;
  2. 自动装配(autowiring):spring 自动满足 bean 之间的依赖,也就是我们说的 IoC/DI;

组件扫描和自动装配组合发挥巨大威力,使得显示的配置降低到最少。

注意:

  • 自动装配基于 反射 设计创建对象并 暴力反射 对应属性为私有属性初始化数据,因此无需提供 setter 方法
  • 自动装配建议使用无参构造方法创建对象(默认),如果不提供对应构造方法,请提供唯一的构造方法

推荐不使用自动装配 xml 配置,而使用注解。

二、测试环境搭建

1、新建一个项目

2、新建两个实体类,Cat Dog 都有一个叫的方法

java
public class Cat {
   public void shout() {
       System.out.println("miao~");
  }
}
public class Dog {
   public void shout() {
       System.out.println("wang~");
  }
}

3、新建一个用户类 User

java
public class User {
   private Cat cat;
   private Dog dog;
   private String str;
}

4、编写Spring 配置文件

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"
      xsi:schemaLocation="http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans.xsd">

   <bean id="dog" class="com.kuang.pojo.Dog"/>
   <bean id="cat" class="com.kuang.pojo.Cat"/>

   <bean id="user" class="com.kuang.pojo.User">
       <property name="cat" ref="cat"/>
       <property name="dog" ref="dog"/>
       <property name="str" value="qinjiang"/>
   </bean>
</beans>

5、测试

java
public class MyTest {
   @Test
   public void testMethodAutowire() {
       ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
       User user = (User) context.getBean("user");
       user.getCat().shout();
       user.getDog().shout();
  }
}

结果正常输出,环境OK

三、byName

autowire byName (按名称自动装配)

由于在手动配置 xml 过程中,常常发生字母缺漏和大小写等错误,而无法对其进行检查,使得开发效率降低。

采用自动装配将避免这些错误,并且使配置简单化。

测试:

1、修改 bean 配置,增加一个属性 autowire="byName"

xml
<bean id="user" class="com.kuang.pojo.User" autowire="byName">
   <property name="str" value="qinjiang"/>
</bean>

2、再次测试,结果依旧成功输出!

3、我们将 cat 的 bean id 修改为 catXXX

4、再次测试, 执行时,报空指针错误 java.lang.NullPointerException。因为按 byName 规则找不对应 set 方法,真正的 setCat 就没执行,对象就没有初始化,所以调用时就会报空指针错误。

小结:

当一个 bean 节点带有 autowire byName的属性时。

  1. 将查找其类中所有的 set 方法名,例如 setCat,获得将 set 去掉并且首字母小写的字符串,即 cat。
  2. 去 spring 容器中寻找是否有此字符串名称 id 的对象。
  3. 如果有,就取出注入,如果没有,就报空指针异常。

四、byType

autowire byType (按类型自动装配)

使用 autowire byType 首先需要保证:同一类型的对象,在 spring 容器中唯一。如果不唯一,会报不唯一的异常。

NoUniqueBeanDefinitionException

测试:

1、将 user 的 bean 配置修改一下 : autowire="byType"

2、测试,正常输出

3、再注册一个 cat 的 bean 对象!

xml
<bean id="dog" class="com.kuang.pojo.Dog"/>
<bean id="cat" class="com.kuang.pojo.Cat"/>
<bean id="cat2" class="com.kuang.pojo.Cat"/>

<bean id="user" class="com.kuang.pojo.User" autowire="byType">
   <property name="str" value="qinjiang"/>
</bean>

4、测试,报错:NoUniqueBeanDefinitionException

5、删掉 cat2,将 cat 的 bean 名称改掉!测试!因为是按类型装配,所以并不会报异常,也不影响最后的结果。甚至将 id 属性去掉,也不影响结果。

这就是按照类型自动装配!

五、使用注解进行依赖注入

jdk1.5 开始支持注解,spring2.5 开始全面支持注解。

准备工作:利用注解的方式注入属性。

1、在 spring 配置文件中引入 context 文件头

xml
xmlns:context="http://www.springframework.org/schema/context"

http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd

2、开启属性注解支持!

xml
<context:annotation-config/>

1、@Autowired

@Autowired 是按类型自动转配的,不支持 id 匹配。

需要导入 spring-aop 的包!

测试:

1、将 User 类中的 set 方法去掉,使用 @Autowired 注解

java
public class User {
   @Autowired
   private Cat cat;
   @Autowired
   private Dog dog;
   private String str;

   public Cat getCat() {
       return cat;
  }
   public Dog getDog() {
       return dog;
  }
   public String getStr() {
       return str;
  }
}

2、此时配置文件内容

xml
<context:annotation-config/>

<bean id="dog" class="com.kuang.pojo.Dog"/>
<bean id="cat" class="com.kuang.pojo.Cat"/>
<bean id="user" class="com.kuang.pojo.User"/>

3、测试,成功输出结果!

@Autowired(required=false)

required 参数说明:

  • false,对象可以为null

  • true,对象必须存在,不能为 null

java
//如果允许对象为null,设置required = false,默认为true
@Autowired(required = false)
private Cat cat;

2、@Qualifier

  • @Autowired 是根据类型自动装配的,加上 @Qualifier 则可以根据 byName 的方式自动装配
  • @Qualifier 不能单独使用。

测试实验步骤:

1、配置文件修改内容,保证类型存在对象。且名字不为类的默认名字!

xml
<bean id="dog1" class="com.kuang.pojo.Dog"/>
<bean id="dog2" class="com.kuang.pojo.Dog"/>
<bean id="cat1" class="com.kuang.pojo.Cat"/>
<bean id="cat2" class="com.kuang.pojo.Cat"/>

2、没有加 Qualifier 测试,直接报错

3、在属性上添加 Qualifier 注解

java
@Autowired
@Qualifier(value = "cat2")
private Cat cat;

@Autowired
@Qualifier("dog2")
private Dog dog;

测试,成功输出!

3、@Resource

  • @Resource 如有指定的 name 属性,先按该属性进行 byName 方式查找装配;
  • 其次再进行默认的 byName 方式进行装配;
  • 如果以上都不成功,则按 byType 的方式自动装配。
  • 都不成功,则报异常。

实体类:

java
public class User {
   //如果允许对象为null,设置required = false,默认为true
   @Resource(name = "cat2")
   private Cat cat;
   @Resource
   private Dog dog;
   private String str;
}

beans.xml

xml
<bean id="dog" class="com.kuang.pojo.Dog"/>
<bean id="cat1" class="com.kuang.pojo.Cat"/>
<bean id="cat2" class="com.kuang.pojo.Cat"/>

<bean id="user" class="com.kuang.pojo.User"/>

测试:结果OK

配置文件2:beans.xml , 删掉cat2

xml
<bean id="dog" class="com.kuang.pojo.Dog"/>
<bean id="cat1" class="com.kuang.pojo.Cat"/>

实体类上只保留注解

java
@Resource
private Cat cat;
@Resource
private Dog dog;

结果:OK

结论:先进行 byName 查找,失败后再进行 byType 查找,成功。

4、@Value

  • @Value实现简单类型注入
java
@Repository("bookDao")
public class BookDaoImpl implements BookDao {
    //@Value:注入简单类型(无需提供set方法)
    @Value("${name}")
    private String name;
    public void save() {
        System.out.println("book dao save ..." + name);
    }
}

以上 @Value 注解中使用 ${name} 从属性文件中读取 name 值,那么就需要在配置类或者配置文件中加载属性文件:

java
@Configuration
@ComponentScan("com.itheima")
//@PropertySource加载properties配置文件
@PropertySource({"classpath:jdbc.properties"}) //{}可以省略不写
public class SpringConfig {
}

注意:@PropertySource() 中加载多文件请使用数组格式配置,不允许使用通配符

六、小结

@Autowired 与 @Resource 异同:

1、@Autowired 与 @Resource 都可以用来装配 bean。都可以写在字段上,或写在 setter 方法上。

2、@Autowired 默认按类型装配(属于 spring 规范),默认情况下必须要求依赖对象必须存在,如果要允许 null 值,可以设置它的required 属性为 false,如:@Autowired(required=false) ,如果我们想使用名称装配可以结合 @Qualifier 注解进行使用

3、@Resource(属于 J2EE 复返),默认按照名称进行装配,名称可以通过 name 属性进行指定。如果没有指定 name 属性,当注解写在字段上时,默认取字段名进行按照名称查找,如果注解写在 setter 方法上默认取属性名进行装配。当找不到与名称匹配的 bean 时才按照类型进行装配。但是需要注意的是,如果 name 属性一旦指定,就只会按照名称进行装配。

它们的作用相同都是用注解方式注入对象,但执行顺序不同。@Autowired 先 byType,@Resource 先 byName。