Spring自动装配及其注解

最新推荐文章于 2024-08-14 05:15:00 发布

天青色的烟雨.

最新推荐文章于 2024-08-14 05:15:00 发布

阅读量974

点赞数 1

分类专栏：【Spring】

【Spring】专栏收录该内容

15 篇文章 2 订阅

订阅专栏

一.属性自动装配

首先，准备三个类，分别是User，Cat，Dog。其中User属性拥有Cat和Dog对象。

package com.hdu.autowire;

public class User {
    private Cat cat;
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    public void setCat(Cat cat) {
        this.cat = cat;
    }
    public Dog getDog() {
        return dog;
    }
    public void setDog(Dog dog) {
        this.dog = dog;
    }
    public String getStr() {
        return str;
    }
    public void setStr(String str) {
        this.str = str;
    }
}

Class User

package com.hdu.autowire;

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

Class Cat

package com.hdu.autowire;

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

Class Dog

xml配置文件

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
          class="com.hdu.autowire.User">
    <property name="cat" ref="cat"></property>
    <property name="dog" ref="dog"></property>
    <property name="str" value="haha"></property>
</bean>

autowire byName (按名称自动装配)

由于在手动配置xml过程中，常常发生字母缺漏和大小写等错误，而无法对其进行检查，使得开发效率降低。采用自动装配将避免这些错误，并且使配置简单化。

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

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

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
      class="com.hdu.autowire.User"
      autowire="byName">
</bean>

如果将 <bean id="cat" class="com.hdu.autowire.Cat"></bean> 改成

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>

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

autowire byType (按类型自动装配)

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

<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
<bean id="user" 
      class="com.hdu.autowire.User"
      autowire="byType">
</bean>

将<bean id="cat" class="com.hdu.autowire.Cat"></bean> 改成

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>

因为是按类型装配，所以并不会报异常，也不影响最后的结果。

甚至将id属性去掉，也不影响结果。

<bean class="com.hdu.autowire.Cat"></bean>

全局autowire

<?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:aop="http://www.springframework.org/schema/aop"
    xmlns:tx="http://www.springframework.org/schema/tx"
    xmlns:p="http://www.springframework.org/schema/p"
    xmlns:util="http://www.springframework.org/schema/util" 
    xmlns:context="http://www.springframework.org/schema/context"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/aop 
        http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx 
        http://www.springframework.org/schema/tx/spring-tx.xsd
        http://www.springframework.org/schema/util 
        http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc.xsd"  default-autowire="byName">
        
    <bean id="cat" class="com.hdu.autowire.Cat"></bean>
    <bean id="dog" class="com.hdu.autowire.Dog"></bean>
    
    <bean id="user" class="com.hdu.autowire.User" autowire="default"/>
    <bean id="user2" class="com.hdu.autowire.User" autowire="default"/>
    <bean id="user3" class="com.hdu.autowire.User" autowire="default"/>

</beans>

注解（+xml）方式：

@Autowired

是按类型自动转配的，不支持id匹配。将User中的set方法去掉，加入@Autowired注解。

package com.hdu.autowire;

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

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;
    }
}

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>   
<bean id="user" class="com.hdu.autowire.User"></bean>

@Autowired(required=false)   

    false，对象可以为null；true，对象必须存对象，不能为null。

@Autowired除了标注在属性上还可以放在其他位置

1.标注在属性上，写在private field（第三种注入形式）（不建议，破坏封装）

2.get、set方法上，一般放在set方法方法上

@Autowired  
public void setUserDAO(@Qualifier("u1") UserDAO userDAO) {  
         this.userDAO = userDAO;  
}

3.构造器，如果使用该注解的类有一个构造器，则 is no longer necessary ，没有必要再单独放置一个@Autowired注解了，Spring框架会自动帮助我们完成注入的功能。但是如果该该有多个注解 several constructors are available，这个时候我们就需要选择一个构造函数，并标注上该注解@Autowired了。
```
public class MovieRecommender {
 private final CustomerPreferenceDao customerPreferenceDao;
 @Autowired
 public MovieRecommender(CustomerPreferenceDao customerPreferenceDao) {
 this.customerPreferenceDao = customerPreferenceDao;
 }
 // ...
}
```
4.参数位置【@Bean+方法参数，参数可以不用@Autowired，默认从容器中获得】

Autowired属于spring的, 不能脱离spring

@Primary

在spring 中使用注解，常使用@Autowired，默认是根据类型Type来自动注入的。但有些特殊情况，对同一个接口，可能会有几种不同的实现类，而默认只会采取其中一种的情况下 @Primary 的作用就出来了。下面是个简单的使用例子。

接口：

public interface Singer {
    String sing(String lyrics);
}

第一个实现类：

@Component // 加注解，让spring识别
public class MetalSinger implements Singer{

    @Override
    public String sing(String lyrics) {
        return "I am singing with DIO voice: "+lyrics;
    }
}

第二个实现类：

@Component
public class OperaSinger implements Singer {
    @Override
    public String sing(String lyrics) {
        return "I am singing in Bocelli voice: "+lyrics;
    }
}

注入上面的接口实现类:

@Component
public class SingerService {
    private static final Logger logger = LoggerFactory.getLogger(SingerService.class);

    @Autowired
    private Singer singer;

    public String sing(){
        return singer.sing("song lyrics");
    }
}

你会发现一个错误的结果或异常:

org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type [main.service.Singer] is defined: expected single matching bean but found 2: metalSinger,operaSinger

提示很明确了，spring 根据类型无法选择到底注入哪一个。这个时候@Primay 可以闪亮登场了。

@Primary
@Component
public class OperaSinger implements Singer{

    @Override
    public String sing(String lyrics) {
        return "I am singing in Bocelli voice: "+lyrics;
    }
}

用@Primary 告诉spring 在犹豫的时候优先选择哪一个具体的实现。还有另外一种方法：利用qualifier names，应该会更好。

@Qualifier

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

package com.hdu.autowire;

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

public class User {
    @Autowired
    @Qualifier(value="carXXX")
    private Cat cat;
    @Autowired
    @Qualifier(value="dogXXX")
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    }
    
    public Dog getDog() {
        return dog;
    }
    
    public String getStr() {
        return str;
    }
}

@Resource（JSR-250提供）

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

package com.hdu.autowire;
import javax.annotation.Resource;

public class User {
    @Resource
    private Cat cat;
    @Resource(name="dogXXX")
    private Dog dog;
    private String str;
    
    public Cat getCat() {
        return cat;
    } 
    public Dog getDog() {
        return dog;
    }    
    public String getStr() {
        return str;
    }
}

配置文件1：

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="cat" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>    
<bean id="user" class="com.hdu.autowire.User"></bean>

先进行byName查找，成功。

配置文件2：

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>    
<bean id="user" class="com.hdu.autowire.User"></bean>

先进行byName查找，失败；再进行byType查找，成功。

配置文件3：

<bean id="catXXX" class="com.hdu.autowire.Cat"></bean>
<bean id="catYYY" class="com.hdu.autowire.Cat"></bean>
<bean id="dogXXX" class="com.hdu.autowire.Dog"></bean>    
<bean id="user" class="com.hdu.autowire.User"></bean>

先进行byName查找，失败；再进行byType查找，有两个匹配，失败，报错。

@Autowired与@Resource异同：

@Autowired与@Resource都可以用来装配bean。都可以写在字段上，或写在setter方法上。
@Autowired默认按类型装配（属于spring规范），默认情况下必须要求依赖对象必须存在，如果要允许null 值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用。
@Resource（属于J2EE复返），默认按照名称进行装配，名称可以通过name属性进行指定。如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

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

@Inject（JSR-330提供）

为了统一各种依赖注入框架的编程模型，JCP最近发布了java依赖注入规范，JCP将其称为JSR-330，@Inject注解是JSR-330的核心部件。该注解几乎可以完全替代Spring的@Autowired注解，可以精确指定注入bean的名称，可以配合@Primary注解使用来指定。所以除了使用Spring特定的@Autowired注解，我们可以选择@Inject。

和@Autowired一个，@Inject可以用来自动装配属性、方法和构造器；与@Autowired不同的是，@Inject没有required属性。因此@Inject注解注入的依赖关系必须存在，否则报异常。