传统的Spring做法是使用.xml文件来对bean进行注入或是配置aop,事物,这样做有两个缺点:
1.如果所有的内容都配置在.xml文件中,那么.xml文件将会非常庞大;如果按需求分开.xml文件,那么.xml文件又会非常多。与可维护性变得很低。
2.在开发中在.java文件和.xml文件之间不断切换,是一件麻烦的事,同时这种思维上的不连贯也会降低开发效率。
为了解决这两个问题,Spring贴了注解,通过@XXX的方式,让注解与Java Bean紧密结合,既大大减少了配置文件的体积,又增加了Java Bean的选择性与内聚性。
**
如果大家对于学习Java有任何问题(学习方法,学习效率,如何就业),可以随时来咨询我,这是我的Java交流学习扣扣群:六三零,四七三,七一 一。 多多交流问题,互帮互助,群里有不错的学习教程和开发工具。**
不使用注解:
先看一个不使用注解的Spring示例,在这个示例的基础上,改成注解版本的,这样也能修剪使用与不使用注解之间的区别。
先定义一个老虎:
package com.spring.model;
public class Tiger {
private String tigerName="TigerKing";
public String toString(){
return "TigerName:"+tigerName;
}
}
再定义一个猴子:
package com.spring.model;
public class Monkey {
private String monkeyName = "MonkeyKing";
public String toString(){
return "MonkeyName:" + monkeyName;
}
}
定义一个动物园:
package com.spring.model;
public class Zoo {
private Tiger tiger;
private Monkey monkey;
public Tiger getTiger() {
return tiger;
}
public void setTiger(Tiger tiger) {
this.tiger = tiger;
}
public Monkey getMonkey() {
return monkey;
}
public void setMonkey(Monkey monkey) {
this.monkey = monkey;
}
public String toString(){
return tiger + "\n" + monkey;
}
}
Spring的配置文件这么写:
<bean id="zoo" class="com.spring.model.Zoo" >
<property name="tiger" ref="tiger" />
<property name="monkey" ref="monkey" />
</bean>
<bean id="tiger" class="com.spring.model.Tiger" />
<bean id="monkey" class="com.spring.model.Monkey" />
测试方法:
public class TestAnnotation {
/**
* 不使用注解
*/
@Test
public void test(){
//读取配置文件
ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext2.xml");
Zoo zoo=(Zoo) ctx.getBean("zoo");
System.out.println(zoo.toString());
}
}
都很熟悉,权当复习一遍了。
1,@自动接线
@Autowired顾名思义,就是自动装配,其作用是为了消除代码Java代码里面的getter / setter与bean属性中的属性。当然,getter看个人需求,如果所有权属性需要对外提供的话,应予以保留。
@Autowired替代按类型匹配的方式,在容器查找匹配的Bean,当有且仅有一个匹配的Bean时,Spring将其注入@Autowired标注的变量中。
因此,♡@ Autowired注解,先看一下spring配置文件怎么写:
<context:component-scan base-package="com.spring" />
<bean id="zoo" class="com.spring.model.Zoo" />
<bean id="tiger" class="com.spring.model.Tiger" />
<bean id="monkey" class="com.spring.model.Monkey" />
注意第13行,使用必须告诉spring一下我要使用注解了,告诉的方式有很多,<context:component-scan base-package =“ xxx” />是一种最简单的,spring会自动扫描xxx路径下的注解。
看到第15行,原来zoo里面注入了两个属性tiger,monkey,现在不需要注入了。再看下,Zoo.java也很方便,把getter / setter都可以去掉:
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
public class Zoo {
@Autowired
private Tiger tiger;
@Autowired
private Monkey monkey;
public String toString(){
return tiger + "\n" + monkey;
}
}
这里@Autowired注解的意思是,当Spring发现@Autowired注解时,将自动在代码所在中找到和其匹配的(是类型匹配)的Bean,并自动注入到相应的地方去。
有一个细节性的问题是,假如bean里面有两个属性,Zoo.java里面又去掉了属性的getter / setter并使用@Autowired注解标注这两个属性那会怎么样?答案是Spring会遵循xml优先的原则去Zoo.java中寻找这两个属性的getter / setter,导致的结果就是初始化bean报错。
OK,假设此时我把.xml文件的16行,17行两行给去掉,再运行,会引发异常
o
rg.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.spring.model.Tiger com.spring.model.Zoo.tiger; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No matching bean of type [com.spring.model.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)}
...
Caused by: org.springframework.beans.factory.BeanCreationException: Could not autowire field: private com.spring.model.Tiger com.spring.model.Zoo.tiger; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No matching bean of type [com.spring.model.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)}
...
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No matching bean of type [com.spring.model.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)}
因为,@ Autowired注解要去寻找的是一个Bean,Tiger和Monkey的Bean定义都给去掉了,自然就不是一个Bean了,Spring容器变得也很好理解。那么,如果属性找不到我不想让Spring容器抛出异常,而就是显示null,可以吗?可以的,其实异常信息里面也发出了提示了,就是将@Autowired注解的必需属性设置为false:
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
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。
2,Qualifier(指定注入Bean的名称)
如果容器中有一个以上匹配的Bean,则可以通过@Qualifier注解限定Bean的名称,看下面的例子:
定义一个汽车接口:
package com.spring.service;
public interface ICar {
public String getCarName();
}
两个实现类BMWCar和BenzCar:
package com.spring.service.impl;
import com.spring.service.ICar;
public class BMWCar implements ICar{
public String getCarName(){
return "BMW car";
}
}
package com.spring.service.impl;
import com.spring.service.ICar;
public class BenzCar implements ICar{
public String getCarName(){
return "Benz car";
}
}
再写一个CarFactory,引用car(这里先不用@Qualifier注解):
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
import com.spring.service.ICar;
public class CarFactory {
@Autowired
private ICar car;
public String toString(){
return car.getCarName();
}
}
配置文件:
<context:component-scan base-package="com.spring" />
<!-- Autowired注解配合Qualifier注解 -->
<bean id="carFactory" class="com.spring.model.CarFactory" />
<bean id="bmwCar" class="com.spring.service.impl.BMWCar" />
<bean id="benz" class="com.spring.service.impl.BenzCar" />
测试方法:
/**
* Autowired注解配合Qualifier注解
*/
@Test
public void test1(){
//读取配置文件
ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext2.xml");
CarFactory carFactory=(CarFactory) ctx.getBean("carFactory");
System.out.println(carFactory.toString());
}
运行一下,不用说,一定是报错的,Car接口有两个实现类,Spring并不知道应该引用该实现类。
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'carFactory': Injection of autowired dependencies failed; nested exception is org.springframework.beans.factory.BeanCreationException:
Could not autowire field: private com.spring.service.ICar com.spring.model.CarFactory.car; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException:
No unique bean of type [com.spring.service.ICar] is defined: expected single matching bean but found 2: [bmwCar, benz]
...
Caused by: org.springframework.beans.factory.BeanCreationException: Could not autowire field: private com.spring.service.ICar com.spring.model.CarFactory.car; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [com.spring.service.ICar] is defined: expected single matching bean but found 2: [bmwCar, benz]
...
Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No unique bean of type [com.spring.service.ICar] is defined: expected single matching bean but found 2: [bmwCar, benz]
…
出现这种情况通常有两种解决方法:
在配置文件中删除其中一个实现类,Spring会自动去base-package下查找Car接口的实现类,发现Car接口只有一个实现类,便会直接引用这个实现类。
实现类就是有多个该怎么办?此时可以使用@Qualifier注解来指定Bean的名称:
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import com.spring.service.ICar;
public class CarFactory {
@Autowired
@Qualifier("bmwCar")
private ICar car;
public String toString(){
return car.getCarName();
}
}
此处会注入称为“ bmwCar”的Bean。
3,资源
@Resource注解与@Autowired注解作用非常相似,这个就简单说了,看例子:
package com.spring.model;
import javax.annotation.Resource;
public class Zoo1 {
@Resource(name="tiger")
private Tiger tiger;
@Resource(type=Monkey.class)
private Monkey monkey;
public String toString(){
return tiger + "\n" + monkey;
}
}
这是详细一些的用法,说一下@Resource的装配顺序:
- @Resource后面没有任何内容,替换通过名称属性去匹配bean,找到再按type去匹配
2.指定了名称或类型则根据指定的类型去匹配bean
3.指定了名称和类型则根据指定的名称和类型去匹配bean,任何一个不匹配都将报错
然后,区别一下@Autowired和@Resource两个注解的区别:
-
@Autowired默认按照byType方式进行bean匹配,@ Resource替换按照byName方式进行bean匹配
-
@Autowired是Spring的注解,@ Resource是J2EE的注解,这个看一下引入注解的时候这两个注解的包名就一清二楚了
Spring属于第三方的,J2EE是Java自己的东西,因此,建议使用@Resource注解,以减少代码和Spring之间的转换。
4,服务
上面的这个例子,还可以继续简化,因为spring的配置文件里面还有15行〜17行三个bean,接下来的简化是把这三个bean也给去掉,因此spring配置文件里面只有一个自动扫描的标签,增强Java代码的内聚性并进一步减少配置文件。
要继续简化,可以使用@Service。先看一下配置文件,当然是全部删除了:
<context:component-scan base-package=“com.spring” />
是,感觉很爽?起码我觉得是的。好的,下面以Zoo.java为例,其余的Monkey.java和Tiger.java都一样:
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
@Service
public class Zoo {
@Autowired
private Tiger tiger;
@Autowired
private Monkey monkey;
public String toString(){
return tiger + "\n" + monkey;
}
}
这样,Zoo.java在Spring容器中存在的形式就是“ zoo”,即可以通过ApplicationContext的getBean(“ zoo”)方法来得到Zoo.java。@ Service注解,其实做了两件事情:
声明Zoo.java是一个bean,这点很重要,因为Zoo.java是一个bean,其他的类才可以使用@Autowired将Zoo作为一个成员变量自动注入。
Zoo.java在bean中的id是“ zoo”,即类名且首字母小写。
如果,我不想用这种形式怎么办,就想让Zoo.java在Spring容器中的名字叫做“ Zoo”,可以的:
package com.spring.model;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Service;
@Service("Zoo")
@Scope("prototype")
public class Zoo {
@Autowired
private Tiger tiger;
@Autowired
private Monkey monkey;
public String toString(){
return tiger + "\n" + monkey;
}
}
这样,就可以通过ApplicationContext的getBean(“ Zoo”)方法来得到Zoo.java了。
这里我还多加了一个@Scope注解,应该很好理解。因为Spring变为产生的bean是单例的,假如我不想使用单例怎么办,xml文件里面可以在bean里面配置scope属性。注解也是一样,配置@Scope即可,默认为“单例”即单例,“ prototype”表示原型即每次都会new一个新的出来。
使用注解来构造IoC容器
需要在applicationContext.xml
中注册<context:component-scan base-package =“ pagkage1 [,pagkage2,…,pagkageN]” />。
如:在base-package
规范一个包
<context:component-scan base-package="cn.gacl.java"/>
出现在cn.gacl.java包及其子包中,如果某个类的头上带有特定的注解@ Component / @ Repository / @ Service / @ Controller
,就会将这个对象作为Bean注册进弹簧容器。可以在<context:component-scan base-package =”” />
中指定多个包,如:
<context:component-scan base-package="cn.gacl.dao.impl,cn.gacl.service.impl,cn.gacl.action"/>
多个包逗号重置。
1,@组件
@Component
是所有受Spring管理组件的通用形式,@ Component
注解可以放在类的头上,@ Component
不推荐使用。
2,@控制器
@Controller
对应表现层的Bean
,也就是动作,例如:
@Controller
@Scope("prototype")
public class UserAction extends BaseAction<User>{
……
}
使用@Controller注解标识UserAction之后,就表示要把UserAction交给Spring容器管理,在Spring容器中会存在一个名字为“ userAction”的动作,这个名字是根据UserAction类名来取的。注意:如果@Controller不指定其值【@Controller】,则替换的豆名字为这个类的类名首字母小写,如果指定值【@Controller(value =“ UserAction”)】或者【@Controller(“ UserAction”))】,则使用value作为bean的名字。
这里的UserAction还使用了@Scope注解,@ Scope(“ prototype”)表示将动作的范围声明为原型,可以利用容器的scope =“ prototype”来保证每一个请求有一个单独的Action来处理,避免struts spring默认范围是单例模式(scope =“ singleton”),这样只会创建一个动作对象,每次访问都是相同的动作对象,数据不安全,struts2是要求每次次访问都对应不同的动作,scope =“ prototype”可以保证当有请求的时候都创建一个Action对象。
3,@服务
@Service对应的是业务层Bean,例如:
@Service("userService")
public class UserServiceImpl implements UserService {
………
}
@Service(“ userService”)注解是告诉Spring,当Spring要创建UserServiceImpl的实例时,bean的名字必须叫做“ userService”,这样当操作需要使用UserServiceImpl的实例时,就可以由Spring创建好的“ userService “,然后注入给Action:在Action只需要声明一个名字叫“ userService”的变量来接收由Spring注入的“ userService”即可,具体代码如下:
// 注入userService
@Resource(name = "userService")
private UserService userService;
注意:
在动作声明的“ userService”变量的类型必须是“ UserServiceImpl”或者是其父类“ UserService”,否则由于类型相反而无法注入,由于动作中的声明的“ userService”变量使用了@Resource注解去标注,并且指明了其名称=“ userService”,这就等于告诉Spring,说我动作要实例化一个“ userService”,你Spring快点帮我实例化好,然后给我。
当Spring看到userService变量上的@Resource的注解时,根据其指定的名称属性可以知道,Action中需要用到一个UserServiceImpl的实例,此时Spring就会把自己创造好的名字叫做“ userService”的UserServiceImpl的实例注入给Action中的“ userService”变量,帮助Action完成userService的实例化,这样在Action中就不用通过UserService userService = new UserServiceImpl();这种最原始的方式去实例化userService了。
如果没有Spring,那么当动作需要使用UserServiceImpl时,必须通过UserService userService = new UserServiceImpl();主动去创建实例对象,但使用了SpringAfter,Action要使用UserServiceImpl时,就不用主动去创建UserServiceImpl的实例了,创建UserServiceImpl实例已经完成Spring来,Spring把创建好的UserServiceImpl实例给Action,Action拿到就可以直接用了。
Action由原来的主动创建UserServiceImpl实例后就可以立即使用,变成了被动等待由Spring创建好的UserServiceImpl实例之后再注入给Action,Action才能够使用。这说明Action对“ UserServiceImpl”类的“控制权”已经被“反转”了。
原来主动权在自己的手上,自己要使用“ UserServiceImpl”类的实例,自己主动去新一个出来马上就可以使用了,但现在自己不能主动去新“ UserServiceImpl”类的实例,新“ UserServiceImpl”类的实例的权力已经被Spring拿走了,只有Spring才能够新“ UserServiceImpl”类的实例,而动作只能等Spring创建好的“ UserServiceImpl”类的实例后,再“恳求” Spring把创建好的“ UserServiceImpl”类的实例给他,这样他才能够使用“ UserServiceImpl”。
这就是Spring核心思想“控制反转”,也叫“依赖注入”,“依赖注入”也很好理解,动作需要使用UserServiceImpl干活,那么就是对UserServiceImpl产生了依赖,Spring把Acion需要依赖的UserServiceImpl注入(也就是“给”)给动作,这就是所谓的“依赖注入”。对动作而言,动作依赖什么东西,就请求Spring注入给他,对Spring而言,动作需要什么,Spring就主动注入给他。
4,@资料库
@Repository对应数据访问层Bean,例如:
@Repository(value="userDao")
public class UserDaoImpl extends BaseDaoImpl<User> {
………
}
@Repository(value =“ userDao”)
注解是告诉Spring,让Spring创建一个名字叫“ userDao”的UserDaoImpl实例。
当Service需要使用Spring创建的名字叫“ userDao”
的UserDaoImpl
实例时,就可以使用@Resource(name =“ userDao”)
注解告诉Spring,Spring把创建好的用户Dao注入给服务即可。
// 注入userDao
,从数据库中根据用户Id取出指定用户时需要用到
@Resource(name = "userDao")
private BaseDao<User> userDao;
春季常用注解汇总
本文总结了Spring的常用注解,以方便大家查询和使用,具体如下:
使用注解之前要开启自动扫描功能,其中base-package为需要扫描的包(含子包)。
<context:component-scan base-package="cn.test"/>
@Configuration
把一个类作为一个IoC容器,它的某个方法头上如果注册了@Bean,就会作为这个Spring容器中的Bean。
@Scope
注解:作用域
@Lazy
(true):表示延迟初始化
@Service
:用于标注业务层组件
@Controller
:用于注释控制层组件(如struts中的action)
@Repository
:用于标注数据访问组件,即DAO组件。
@Component
:泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
@Scope
:用于指定范围作用域的(用在类上)
@PostConstruct
:用于指定初始化方法(用在方法上)
@PreDestory
:用于指定销毁方法(用在方法上)
@DependsOn
:定义Bean初始化及销毁时的顺序
@Primary
:自动装配时当出现多个Bean附加者时,被注解为@Primary Bean将作为首选者,否则将引发异常
@Autowired
:替换按类型装配,如果我们想使用按名称装配,可以结合@Qualifier注解一起使用。如下:@Autowired @Qualifier(“ personDaoBean”)存在多个实例配合使用
@Resource
:默认按名称装配,当发现与名称匹配的bean才会按类型装配。
@PostConstruct
:初始化注解
@PreDestroy
:破坏注解默认单例启动就加载
@Async
:异步方法调用