详解Spring注解--@Autowired、@Resource和@Service

什么是注解

传统的spring做法是使用.xml文件来对bean进行注入或者是配置aop、事物，这么做有两个缺点：

1、如果所有的内容都配置在.xml文件中，那么.xml文件将会十分庞大；如果按需求分开.xml文件，那么.xml文件又会非常多。总之这将导致配置文件的可读性与可维护性变得很低

2、在开发中在.java文件和.xml文件之间不断切换，是一件麻烦的事，同时这种思维上的不连贯也会降低开发的效率

为了解决这两个问题，spring引入了注解，通过"@xxx"的方式，让注解与java bean紧密结合，既大大减少了配置文件的体积，又增加了java bean的可读性与内聚性。

本篇文章，讲讲最重要的三个spring注解，也就是@autowired、@resource和@service，希望能通过有限的篇幅说清楚这三个注解的用法。

不使用注解

先看一个不使用注解的spring示例，在这个示例的基础上，改成注解版本的，这样也能看出使用与不使用注解之间的区别，先定义一个老虎：

public class tiger
{
 private string tigername = "tigerking";
 
 public string tostring()
 {
  return "tigername:" + tigername;
 }
}

再定义一个猴子：

public class monkey
{
 private string monkeyname = "monkeyking";
 
 public string tostring()
 {
  return "monkeyname:" + monkeyname;
 }
}

定义一个动物园：

public class zoo
{
 private tiger tiger;
 private monkey monkey;

 public void settiger(tiger tiger)
 {
  this.tiger = tiger;
 }

 public void setmonkey(monkey monkey)
 {
  this.monkey = monkey;
 }

 public tiger gettiger()
 {
  return tiger;
 }

 public monkey getmonkey()
 {
  return monkey;
 }
 public string tostring()
 {
  return tiger + "\n" + monkey;
 }
}

spring的配置文件这么写：

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" 
 xmlns="http://www.springframework.org/schema/beans" 
 xmlns:context="http://www.springframework.org/schema/context" 
 xsi:schemalocation="http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
  http://www.springframework.org/schema/context
  http://www.springframework.org/schema/context/spring-context-4.2.xsd"
 default-autowire="bytype">

 <bean id="zoo" class="com.xrq.bean.zoo" >
  <property name="tiger" ref="tiger" />
  <property name="monkey" ref="monkey" />
 </bean>

 <bean id="tiger" class="com.xrq.domain.tiger" />
 <bean id="monkey" class="com.xrq.domain.monkey" />
</beans>

都很熟悉，权当复习一遍了。

@autowired

@autowired顾名思义，就是自动装配，其作用是为了消除代码java代码里面的getter/setter与bean属性中的property。当然，getter看个人需求，如果私有属性需要对外提供的话，应当予以保留。

因此，引入@autowired注解，先看一下spring配置文件怎么写：

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" 
 xmlns="http://www.springframework.org/schema/beans" 
 xmlns:context="http://www.springframework.org/schema/context" 
 xsi:schemalocation="http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
  http://www.springframework.org/schema/context
  http://www.springframework.org/schema/context/spring-context-4.2.xsd">

 <context:component-scan base-package="com.xrq" />

 <bean id="zoo" class="com.xrq.bean.zoo" />
 <bean id="tiger" class="com.xrq.domain.tiger" />
 <bean id="monkey" class="com.xrq.domain.monkey" />
</beans>

注意第10行，使用必须告诉spring一下我要使用注解了，告诉的方式有很多，<context:component-scan base-package="xxx" />是一种最简单的，spring会自动扫描xxx路径下的注解。

看到第12行，原来zoo里面应当注入两个属性tiger、monkey，现在不需要注入了。再看下，zoo.java也很方便，把getter/setter都可以去掉：

public class zoo
{
 @autowired
 private tiger tiger;
 
 @autowired
 private monkey monkey;
 
 public string tostring()
 {
  return tiger + "\n" + monkey;
 }
}

这里@autowired注解的意思就是，当spring发现@autowired注解时，将自动在代码上下文中找到和其匹配（默认是类型匹配）的bean，并自动注入到相应的地方去。

有一个细节性的问题是，假如bean里面有两个property，zoo.java里面又去掉了属性的getter/setter并使用@autowired注解标注这两个属性那会怎么样？答案是spring会按照xml优先的原则去zoo.java中寻找这两个属性的getter/setter，导致的结果就是初始化bean报错。

ok，假设此时我把.xml文件的13行、14行两行给去掉，再运行，会抛出异常：

exception in thread "main" org.springframework.beans.factory.beancreationexception: error creating bean with name 'zoo': injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.beancreationexception: could not autowire field: private com.xrq.domain.tiger com.xrq.bean.zoo.ttiger; nested exception is org.springframework.beans.factory.nosuchbeandefinitionexception: no qualifying bean of type [com.xrq.domain.tiger] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. dependency annotations: {@org.springframework.beans.factory.annotation.autowired(required=true)}
 at org.springframework.beans.factory.annotation.autowiredannotationbeanpostprocessor.postprocesspropertyvalues(autowiredannotationbeanpostprocessor.java:334)
 at org.springframework.beans.factory.support.abstractautowirecapablebeanfactory.populatebean(abstractautowirecapablebeanfactory.java:1214)
 at org.springframework.beans.factory.support.abstractautowirecapablebeanfactory.docreatebean(abstractautowirecapablebeanfactory.java:543)
 at org.springframework.beans.factory.support.abstractautowirecapablebeanfactory.createbean(abstractautowirecapablebeanfactory.java:482)
 at org.springframework.beans.factory.support.abstractbeanfactory$1.getobject(abstractbeanfactory.java:305)
 at org.springframework.beans.factory.support.defaultsingletonbeanregistry.getsingleton(defaultsingletonbeanregistry.java:230)
 at org.springframework.beans.factory.support.abstractbeanfactory.dogetbean(abstractbeanfactory.java:301)
 at org.springframework.beans.factory.support.abstractbeanfactory.getbean(abstractbeanfactory.java:196)
 at org.springframework.beans.factory.support.defaultlistablebeanfactory.preinstantiatesingletons(defaultlistablebeanfactory.java:772)
 at org.springframework.context.support.abstractapplicationcontext.finishbeanfactoryinitialization(abstractapplicationcontext.java:835)
 at org.springframework.context.support.abstractapplicationcontext.refresh(abstractapplicationcontext.java:537)
 at org.springframework.context.support.classpathxmlapplicationcontext.<init>(classpathxmlapplicationcontext.java:139)
 at org.springframework.context.support.classpathxmlapplicationcontext.<init>(classpathxmlapplicationcontext.java:83)
 at com.xrq.test.mytest.main(mytest.java:13)
caused by: org.springframework.beans.factory.beancreationexception: could not autowire field: private com.xrq.domain.tiger com.xrq.bean.zoo.ttiger; nested exception is org.springframework.beans.factory.nosuchbeandefinitionexception: no qualifying bean of type [com.xrq.domain.tiger] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. dependency annotations: {@org.springframework.beans.factory.annotation.autowired(required=true)}
 at org.springframework.beans.factory.annotation.autowiredannotationbeanpostprocessor$autowiredfieldelement.inject(autowiredannotationbeanpostprocessor.java:571)
 at org.springframework.beans.factory.annotation.injectionmetadata.inject(injectionmetadata.java:88)
 at org.springframework.beans.factory.annotation.autowiredannotationbeanpostprocessor.postprocesspropertyvalues(autowiredannotationbeanpostprocessor.java:331)
 ... 13 more
caused by: org.springframework.beans.factory.nosuchbeandefinitionexception: no qualifying bean of type [com.xrq.domain.tiger] found for dependency: expected at least 1 bean which qualifies as autowire candidate for this dependency. dependency annotations: {@org.springframework.beans.factory.annotation.autowired(required=true)}
 at org.springframework.beans.factory.support.defaultlistablebeanfactory.raisenosuchbeandefinitionexception(defaultlistablebeanfactory.java:1373)
 at org.springframework.beans.factory.support.defaultlistablebeanfactory.doresolvedependency(defaultlistablebeanfactory.java:1119)
 at org.springframework.beans.factory.support.defaultlistablebeanfactory.resolvedependency(defaultlistablebeanfactory.java:1014)
 at org.springframework.beans.factory.annotation.autowiredannotationbeanpostprocessor$autowiredfieldelement.inject(autowiredannotationbeanpostprocessor.java:543)
 ... 15 more

因为，@autowired注解要去寻找的是一个bean，tiger和monkey的bean定义都给去掉了，自然就不是一个bean了，spring容器找不到也很好理解。那么，如果属性找不到我不想让spring容器抛出异常，而就是显示null，可以吗？可以的，其实异常信息里面也给出了提示了，就是将@autowired注解的required属性设置为false即可：

public class zoo
{
 @autowired(required = false)
 private tiger tiger;

 @autowired(required = false)
 private monkey monkey;
 public string tostring()
 {
  return tiger + "\n" + monkey;
 }
}

此时，找不到tiger、monkey两个属性，spring容器不再抛出异而是认为这两个属性为null。

@autowired接口注入

上面的比较简单，我们只是简单注入一个java类，那么如果有一个接口，有多个实现，bean里引用的是接口名，又该怎么做呢？比如有一个car接口：

public interface car
{
 public string carname();
}

两个实现类bmw和benz：

@service
public class bmw implements car
{
 public string carname()
 {
  return "bmw car";
 }
}

@service
public class benz implements car
{
 public string carname()
 {
  return "benz car";
 }
}

写一个carfactory，引用car：

@service
public class carfactory
{
 @autowired
 private car car;
 public string tostring()
 {
  return car.carname();
 }
}

不用说，一定是报错的，car接口有两个实现类，spring并不知道应当引用哪个实现类。这种情况通常有两个解决办法：

1、删除其中一个实现类，spring会自动去base-package下寻找car接口的实现类，发现car接口只有一个实现类，便会直接引用这个实现类

2、实现类就是有多个该怎么办？此时可以使用@qualifier注解：

@service
public class carfactory
{
 @autowired
 @qualifier("bmw")
 private car car;
 
 public string tostring()
 {
  return car.carname();
 }
}

注意@qualifier注解括号里面的应当是car接口实现类的类名，我之前试的时候一直以为是bean的名字，所以写了"bmw"，结果一直报错。

@resource

把@resource注解放在@autowired下面说，是因为它们作用非常相似，这个就简单说了，例子过后点明一下@resource和@autowired的区别。先看一下@resource，直接写zoo.java了：

@service
public class zoo
{
 @resource(name = "tiger")
 private tiger tiger;
 @resource(type = monkey.class)
 private monkey monkey;
 public string tostring()
 {
  return tiger + "\n" + monkey;
 }
}

这是详细一些的用法，说一下@resource的装配顺序：

1、@resource后面没有任何内容，默认通过name属性去匹配bean，找不到再按type去匹配

2、指定了name或者type则根据指定的类型去匹配bean

3、指定了name和type则根据指定的name和type去匹配bean，任何一个不匹配都将报错

然后，区分一下@autowired和@resource两个注解的区别：

1、@autowired默认按照bytype方式进行bean匹配，@resource默认按照byname方式进行bean匹配

2、@autowired是spring的注解，@resource是j2ee的注解，这个看一下导入注解的时候这两个注解的包名就一清二楚了

spring属于第三方的，j2ee是java自己的东西，因此，建议使用@resource注解，以减少代码和spring之间的耦合。

@service

上面这个例子，还可以继续简化，因为spring的配置文件里面还有12行~14行三个bean，下一步的简化是把这三个bean也给去掉，使得spring配置文件里面只有一个自动扫描的标签，增强java代码的内聚性并进一步减少配置文件。

要继续简化，可以使用@service。先看一下配置文件，当然是全部删除了：

<?xml version="1.0" encoding="utf-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/xmlschema-instance" 
 xmlns="http://www.springframework.org/schema/beans" 
 xmlns:context="http://www.springframework.org/schema/context" 
 xsi:schemalocation="http://www.springframework.org/schema/beans 
  http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
  http://www.springframework.org/schema/context
  http://www.springframework.org/schema/context/spring-context-4.2.xsd">
 <context:component-scan base-package="com.xrq" />
</beans>

是不是感觉很爽？起码我觉得是的。ok，下面以zoo.java为例，其余的monkey.java和tiger.java都一样：

@service
public class zoo
{
 @autowired
 private tiger ttiger;
 @autowired
 private monkey mmonkey;
 public string tostring()
 {
  return ttiger + "\n" + mmonkey;
 }
}

这样，zoo.java在spring容器中存在的形式就是"zoo"，即可以通过applicationcontext的getbean("zoo")方法来得到zoo.java。@service注解，其实做了两件事情：

1、声明zoo.java是一个bean，这点很重要，因为zoo.java是一个bean，其他的类才可以使用@autowired将zoo作为一个成员变量自动注入

2、zoo.java在bean中的id是"zoo"，即类名且首字母小写

如果，我不想用这种形式怎么办，就想让zoo.java在spring容器中的名字叫做"zoo"，可以的：

@service
@scope("prototype")
public class zoo
{
 @autowired
 private monkey monkey;
 @autowired
 private tiger tiger;
 public string tostring()
 {
  return "monkeyname:" + monkey + "\ntigername:" + tiger;
 }
}

这样，就可以通过applicationcontext的getbean("zoo")方法来得到zoo.java了。

这里我还多加了一个@scope注解，应该很好理解。因为spring默认产生的bean是单例的，假如我不想使用单例怎么办，xml文件里面可以在bean里面配置scope属性。注解也是一样，配置@scope即可，默认是"singleton"即单例，"prototype"表示原型即每次都会new一个新的出来。

补充细节

最后再补充一个我发现的细节。假如animal包下有tiger、domain包下也有tiger，它们二者都加了@service注解，那么在zoo.java中即使明确表示我要引用的是domain包下的tiger，程序运行的时候依然会报错。

细想，其实这很好理解，两个tiger都使用@service注解标注，意味着两个bean的名字都是"tiger"，那么我在zoo.java中自动装配的是哪个tiger呢？不明确，因此，spring容器会抛出beandefinitionstoreexception异常，caused by：

caused by: org.springframework.context.annotation.conflictingbeandefinitionexception: annotation-specified bean name 'monkey' for bean class [com.xrq.domain.monkey] conflicts with existing, non-compatible bean definition of same name and class [com.xrq.animal.monkey]

以上就是本文的全部内容，希望本文的内容对大家的学习或者工作能带来一定的帮助，同时也希望多多支持!