Spring学习之@Autowired注解，@Resource和@Service注解

前言：这是在博客园看到的一位大佬关于Spring学习的系列文章，这里转载仅为方便学习所用，感谢大佬的文章
原文地址：https://www.cnblogs.com/xrq730/p/5313412.html

正文开始

什么是注解？

传统的Spring做法是使用.xml文件对bean进行注入或者是配置AOP，事物，这么做有俩个缺点：
1、如果所有的内容都配置在.xml文件中，那么xml文件将会变得十分庞大；如果按需求分开.xml文件，那么.xml文件又会变得非常多。总之传统的spring做法将导致配置文件的可读性与可维护性变得很低。
2、在开发中在java文件和xml文件之间不断切换，是一件很麻烦的事情，同时这种思维上的不连贯也会降低开发的效率。
为了解决这俩个问题，Spring引入了注解，通过“@XXX”的方式，让注解与JavaBean紧密结合，既大大减少了配置文件的体积，又增加了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属性中的peoperty。当然，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行，使用注解前必须告诉Sping说我要使用注解了，告诉的方式有很多，< context:xomponent-scan base-package=“com.xrg”/>是一种最简单的，Spring会自动扫描xxx路径下的注解。建议出错时仔细看一下这里的xml文件，有些人的xml文件会缺少一些声明，比如我用的xml文件是之前搭建Spring框架时复制其他文章的，结果相比本文的xml文件在开头beans标签中缺少了一些声明导致运行时有错误产生，另外再写一个知识点，Spring的bean在读取xml文件时就已经被加载了，而不是调用getBean才加载的，想试试的可以把Zoo.java中被注释掉静态代码块和测试类的注释去掉，运行一下即可
看到第12行，原来zoo里面应当注入俩个属性tiger，monkey，现在不需要注入了。再看下，Zoo.java也很方便，把getter/setter都可以去掉：

public class Zoo{
     

	@Autowired
	private Tiger tiger;
	
	@Autowired
	private Monkey momkey;
	
	/*static {
		System.out.println("读取文件时就已经加载Zoo类了");
	}*/
	
	public String toString(){
     
		return tiger + "\n" + monkey;
	}
}

测试类：

public class AnnotationTest {
     
	
	public static void main(String[] args){
     
		
		 ApplicationContext ac = 
	                new ClassPathXmlApplicationContext("beans.xml");
		// System.out.println("Zoo类还没被加载");
		 Zoo bean = (Zoo) ac.getBean("zoo");
		 System.out.println(bean);
	}

}

运行结果：

运行过程详解

这里的@Autowired注解的意思就是，当Spring在根据xml文件加载bean对应的类时发现@Autowired注解时，将自动根据代码上下文的类名去xml文件找到与其匹配（默认是类型匹配）的bean，并自动注入到相应的地方去。

有一个细节性的问题是，假如在xml文件中Zoo的bean里面添加两个property（如第一个xml文件中），Zoo.java里面又去掉了getter/setter方法并使用@Autowired注解标注这两个属性时会发生什么？答案是Spring会按照xml优先的原则去Zoo.java中寻找这两个属性的getter/setter，导致的结果就是初始化bean报错。

那如果我把使用@Autowired后的配置文件中的第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注解中的属性设置为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两个bean时，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默认按照by type方式进行bean匹配，@Resource默认按照By name方式进行bean匹配。
2、@Autowired是Spring的注解，@Resource是J2EE的注解，这个看一下导入注解的时候这两个注解的包名就一清二楚了。Spring属于第三方的，J2EE是Java自己的东西，因此，建议使用@Resource的注解，以减少代码和Spring之间的耦合。

@Service

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

要继续简化，可以使用@Service。先看一下配置文件，当然是先把三个bean的声明定义全部删除啦：

<?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标签即可）：

@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实例 。@Service注解在这个过程中其实只做了两件事：
1、声明Zoo.java是一个bean，这点很重要，因为Zoo.java是一个bean，其他的类才可以使用@Autowired将Zoo作为一个成员变量自动注入。
2、Zoo.java在bean中的id是“zoo”，即类名且首字母小写。如果类的名字是两个或以上连续的大写字母开头，bean的名字会与类名是一样的，不会首字母变小写。
如果，我不想用这种形式怎么办，就想让Zoo.java在Spring容器中的名字叫做“Zoo”，可以的：

@Service("Zoo") // 看这里
@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: 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]