spring注解.docx

spring注解.docx

《spring注解.docx》由会员分享，可在线阅读，更多相关《spring注解.docx（25页珍藏版）》请在冰豆网上搜索。

spring注解

spring2.5注解驱动

（一）

概述

注释配置相对于XML配置具有很多的优势：

它可以充分利用Java的反射机制获取类结构信息，这些信息可以有效减少配置的工作。

如使用JPA注释配置ORM映射时，我们就不需要指定PO的属性名、类型等信息，如果关系表字段和PO属性名、类型都一致，您甚至无需编写任务属性映射信息——因为这些信息都可以通过Java反射机制获取。

注释和Java代码位于一个文件中，而XML配置采用独立的配置文件，大多数配置信息在程序开发完成后都不会调整，如果配置信息和Java代码放在一起，有助于增强程序的内聚性。

而采用独立的XML配置文件，程序员在编写一个功能时，往往需要在程序文件和配置文件中不停切换，这种思维上的不连贯会降低开发效率。

因此在很多情况下，注释配置比XML配置更受欢迎，注释配置有进一步流行的趋势。

Spring2.5的一大增强就是引入了很多注释类，现在您已经可以使用注释配置完成大部分XML配置的功能。

在这篇文章里，我们将向您讲述使用注释进行Bean定义和依赖注入的内容。

原来我们是怎么做的

在使用注释配置之前，先来回顾一下传统上是如何配置Bean并完成Bean之间依赖关系的建立。

下面是3个类，它们分别是Office、Car和Boss，这3个类需要在Spring容器中配置为Bean：

Office仅有一个属性：

清单1.Office.java

Java代码

1.package com.baobaotao;     

2.public class Office {     

3.    private String officeNo =”001”;     

4.    

5.    //省略 get/setter     

6.    

7.    @Override    

8.    public String toString（） {     

9.        return "officeNo:

" + officeNo;     

10.    }     

11.}    

Car拥有两个属性：

清单2.Car.java

Java代码

1.package com.baobaotao;     

2.    

3.public class Car {     

4.    private String brand;     

5.    private double price;     

6.    

7.    // 省略 get/setter     

8.    

9.    @Override    

10.    public String toString（） {     

11.        return "brand:

" + brand + "," + "price:

" + price;     

12.    }     

13.}   

Boss拥有Office和Car类型的两个属性：

清单3.Boss.java

Java代码

1.package com.baobaotao;     

2.    

3.public class Boss {     

4.    private Car car;     

5.    private Office office;     

6.    

7.    // 省略 get/setter     

8.    

9.    @Override    

10.    public String toString（） {     

11.        return "car:

" + car + "\n" + "office:

" + office;     

12.    }     

13.}    

我们在Spring容器中将Office和Car声明为Bean，并注入到BossBean中：

下面是使用传统XML完成这个工作的配置文件beans.xml：

清单4.beans.xml将以上三个类配置成Bean

Java代码

1.

xml version="1.0" encoding="UTF-8" ?

>    

2.

//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-2.5.xsd">    

6.        

7.            

8.            

9.        

10.        

11.            

12.        

13.        

14.            

15.            

16.        

17.    

当我们运行以下代码时，控制台将正确打出boss的信息：

清单5.测试类：

AnnoIoCTest.java

Java代码

1.import org.springframework.context.ApplicationContext;     

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

3.public class AnnoIoCTest {     

4.    

5.    public static void main（String[] args） {     

6.        String[] locations = {"beans.xml"};     

7.        ApplicationContext ctx =      

8.            new ClassPathXmlApplicationContext（locations）;     

9.        Boss boss = （Boss） ctx.getBean（"boss"）;     

10.        System.out.println（boss）;     

11.    }     

12.}   

这说明Spring容器已经正确完成了Bean创建和装配的工作。

使用@Autowired注释

Spring2.5引入了@Autowired注释，它可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。

来看一下使用@Autowired进行成员变量自动注入的代码：

清单6.使用@Autowired注释的Boss.java

Java代码

1.package com.baobaotao;     

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

3.    

4.public class Boss {     

5.    

6.    @Autowired    

7.    private Car car;     

8.    

9.    @Autowired    

10.    private Office office;     

11.    

12.    …     

13.}   

Spring通过一个BeanPostProcessor对@Autowired进行解析，所以要让@Autowired起作用必须事先在Spring容器中声明AutowiredAnnotationBeanPostProcessorBean。

清单7.让@Autowired注释工作起来

Java代码

1.

xml version="1.0" encoding="UTF-8" ?

>    

2.

//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-2.5.xsd">    

6.    

7.    

-- 该 BeanPostProcessor 将自动起作用，对标注 @Autowired 的 Bean 进行自动注入 -->    

8.    

9.        AutowiredAnnotationBeanPostProcessor"/>    

10.    

11.    

-- 移除 boss Bean 的属性注入配置的信息 -->    

12.        

13.      

14.        

15.            

16.        

17.        

18.            

19.            

20.        

21.   

这样，当Spring容器启动时，AutowiredAnnotationBeanPostProcessor将扫描Spring容器中所有Bean，当发现Bean中拥有@Autowired注释时就找到和其匹配（默认按类型匹配）的Bean，并注入到对应的地方中去。

按照上面的配置，Spring将直接采用Java反射机制对Boss中的car和office这两个私有成员变量进行自动注入。

所以对成员变量使用@Autowired后，您大可将它们的setter方法（setCar（）和setOffice（））从Boss中删除。

当然，您也可以通过@Autowired对方法或构造函数进行标注，来看下面的代码

清单8.将@Autowired注释标注在Setter方法上

Java代码

1.package com.baobaotao;     

2.    

3.public class Boss {     

4.    private Car car;     

5.    private Office office;     

6.    

7.     @Autowired    

8.    public void setCar（Car car） {     

9.        this.car = car;     

10.    }     

11.      

12.    @Autowired    

13.    public void setOffice（Office office） {     

14.        this.office = office;     

15.    }     

16.    …     

17.}    

这时，@Autowired将查找被标注的方法的入参类型的Bean，并调用方法自动注入这些Bean。

而下面的使用方法则对构造函数进行标注：

清单9.将@Autowired注释标注在构造函数上

Java代码

1.package com.baobaotao;     

2.    

3.public class Boss {     

4.    private Car car;     

5.    private Office office;     

6.      

7.    @Autowired    

8.    public Boss（Car car ,Office office）{     

9.        this.car = car;     

10.        this.office = office ;     

11.    }     

12.      

13.    …     

14.}    

由于Boss（）构造函数有两个入参，分别是car和office，@Autowired将分别寻找和它们类型匹配的Bean，将它们作为Boss（Carcar,Officeoffice）的入参来创建BossBean。

当候选Bean数目不为1时的应对方法

在默认情况下使用@Autowired注释进行自动注入时，Spring容器中匹配的候选Bean数目必须有且仅有一个。

当找不到一个匹配的Bean时，Spring容器将抛出BeanCreationException异常，并指出必须至少拥有一个匹配的Bean。

我们可以来做一个实验：

清单10.候选Bean数目为0时

Java代码

1.

xml version="1.0" encoding="UTF-8" ?

>    

2.

//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-2.5.xsd ">    

6.      

7.    

8.        AutowiredAnnotationBeanPostProcessor"/>      

9.    

10.        

11.    

12.    

-- 将 office Bean 注释掉 -->    

13.    

--     

14.        

15.    -->    

16.    

17.        

18.            

19.            

20.        

21.   

由于officeBean被注释掉了，所以Spring容器中将没有类型为Office的Bean了，而Boss的office属性标注了@Autowired，当启动Spring容器时，异常就产生了。

当不能确定Spring容器中一定拥有某个类的Bean时，可以在需要自动注入该类Bean的地方可以使用@Autowired（required=false），这等于告诉Spring：

在找不到匹配Bean时也不报错。

来看一下具体的例子：

清单11.使用@Autowired（required=false）

Java代码

1.package com.baobaotao;     

2.    

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

4.import org.springframework.beans.factory.annotation.Required;     

5.    

6.public class Boss {     

7.    

8.    private Car car;     

9.    private Office office;     

10.    

11.    @Autowired    

12.    public void setCar（Car car） {     

13.        this.car = car;     

14.    }     

15.    @Autowired（required = false）     

16.    public void setOffice（Office office） {     

17.        this.office = office;     

18.    }     

19.    …     

20.}  

当然，一般情况下，使用@Autowired的地方都是需要注入Bean的，使用了自动注入而又允许不注入的情况一般仅会在开发期或测试期碰到（如为了快速启动Spring容器，仅引入一些模块的Spring配置文件），所以@Autowired（required=false）会很少用到。

和找不到一个类型匹配Bean相反的一个错误是：

如果Spring容器中拥有多个候选Bean，Spring容器在启动时也会抛出BeanCreationException异常。

来看下面的例子：

清单12.在beans.xml中配置两个Office类型的Bean

Java代码

1.    

2.        

3.    

4.    

5.        

6.    

我们在Spring容器中配置了两个类型为Office类型的Bean，当对Boss的office成员变量进行自动注入时，Spring容器将无法确定到底要用哪一个Bean，因此异常发生了。

Spring允许我们通过@Qualifier注释指定注入Bean的名称，这样歧义就消除了，可以通过下面的方法解决异常：

清单13.使用@Qualifier注释指定注入Bean的名称

Java代码

1.@Autowired    

2.public void setOffice（@Qualifier（"office"）Office office） {     

3.    this.office = office;     

4.}    

@Qualifier（"office"）中的office是Bean的名称，所以@Autowired和@Qualifier结合使用时，自动注入的策略就从byType转变成byName了。

@Autowired可以对成员变量、方法以及构造函数进行注释，而@Qualifier的标注对象是成员变量、方法入参、构造函数入参。

正是由于注释对象的不同，所以Spring不将@Autowired和@Qualifier统一成一个注释类。

下面是对成员变量和构造函数入参进行注释的代码：

对成员变量进行注释：

清单14.对成员变量使用@Qualifier注释