java

位置:IT落伍者 >> java >> 浏览文章

Spring注解入门


发布日期:2023年03月09日
 
Spring注解入门

使用Spring注解来注入属性

使用注解以前我们是怎样注入属性的

类的实现

Java代码

public class UserManagerImpl implements UserManager {

private UserDao userDao;

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

}

配置文件

Java代码

<bean id=userManagerImpl class=comkedacomspringannotationserviceUserManagerImpl>

<property name=userDao ref=userDao />

</bean>

<bean id=userDao class=comkedacomspringannotationpersistenceUserDaoImpl>

<property name=sessionFactory ref=mySessionFactory />

</bean>

引入@Autowired注解(不推荐使用建议使用@Resource)下面有对于他们两个的介绍>

类的实现(对成员变量进行标注)

Java代码

public class UserManagerImpl implements UserManager {

@Autowired

private UserDao userDao;

}

或者(对方法进行标注)

Java代码

public class UserManagerImpl implements UserManager {

private UserDao userDao;

@Autowired

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

}

配置文件

Java代码

<bean id=userManagerImpl class=comkedacomspringannotationserviceUserManagerImpl />

<bean id=userDao class=comkedacomspringannotationpersistenceUserDaoImpl>

<property name=sessionFactory ref=mySessionFactory />

</bean>

@Autowired可以对成员变量方法和构造函数进行标注来完成自动装配的工作以上两种不同实现方式中@Autowired的标注位置不同它们都会在Spring在初始化userManagerImpl这个bean时自动装配userDao这个属性区别是第一种实现中Spring会直接将UserDao类型的唯一一个bean赋值给userDao这个成员变量第二种实现中Spring会调用setUserDao方法来将UserDao类型的唯一一个bean装配到userDao这个属性

让@Autowired工作起来

要使@Autowired能够工作还需要在配置文件中加入以下代码 (对于这个问题spring也为我们考虑到了在下面的这个配置中省去了我们 编写bean的麻烦)

Java代码

<bean class=orgspringframeworkbeansfactoryannotationAutowiredAnnotationBeanPostProcessor />

<<<<<<<<<<<<<

在基于主机方式配置Spring的配置文件中你可能会见到<context:annotationconfig/>这样一条配置他的作用是式地向 Spring 容器注册

AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor

PersistenceAnnotationBeanPostProcessor 以及 RequiredAnnotationBeanPostProcessor 这 个BeanPostProcessor

注册这个 BeanPostProcessor的作用就是为了你的系统能够识别相应的注解

例如

如果你想使用@Autowired注解那么就必须事先在 Spring 容器中声明 AutowiredAnnotationBeanPostProcessor Bean传统声明方式如下

<bean class=orgspringframeworkbeansfactoryannotation AutowiredAnnotationBeanPostProcessor /> 如果想使用@ Resource @ PostConstruct@ PreDestroy等注解就必须声明CommonAnnotationBeanPostProcessor

如果想使用@PersistenceContext注解就必须声明PersistenceAnnotationBeanPostProcessor的Bean

如果想使用 @Required的注解就必须声明RequiredAnnotationBeanPostProcessor的Bean同样传统的声明方式如下

<bean class=orgspringframeworkbeansfactoryannotationRequiredAnnotationBeanPostProcessor/> 一般来说这些注解我们还是比较常用尤其是Antowired的注解在自动注入的时候更是经常使用所以如果总是需要按照传统的方式一条一条配置显得有些繁琐和没有必要于是spring给我们提供<context:annotationconfig/>的简化配置方式自动帮你完成声明

>>>>>>>>>>>>>>

@Qualifier (重点)

@Autowired是根据类型进行自动装配的在上面的例子中如果当Spring上下文中存在不止一个UserDao类型的bean时就会抛出BeanCreationException异常如果Spring上下文中不存在UserDao类型的bean也会抛出BeanCreationException异常我们可以使用@Qualifier配合@Autowired来解决这些问题

可能存在多个UserDao实例

Java代码

@Autowired

public void setUserDao(@Qualifier(userDao) UserDao userDao) {

thisuserDao = userDao;

}

这样Spring会找到id为userDao的bean进行装配

可能不存在UserDao实例

Java代码

@Autowired(required = false)

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

@Resource 和 @Autowired的区别 (一定要看)

@Resource(JSR标准注解推荐使用它来代替Spring专有的@Autowired注解)

Spring 不但支持自己定义的@Autowired注解还支持几个由JSR规范定义的注解它们分别是@Resource@PostConstruct以及@PreDestroy

@Resource的作用相当于@Autowired只不过@Autowired按byType自动注入而@Resource默认按byName自动注入罢了@Resource有两个属性是比较重要的分别是name和typeSpring将@Resource注解的name属性解析为bean的名字而type属性则解析为bean的类型所以如果使用name属性则使用byName的自动注入策略而使用type属性时则使用byType自动注入策略如果既不指定name也不指定type属性这时将通过反射机制使用byName自动注入策略

@Resource装配顺序

如果同时指定了name和type则从Spring上下文中找到唯一匹配的bean进行装配找不到则抛出异常

如果指定了name则从上下文中查找名称(id)匹配的bean进行装配找不到则抛出异常

如果指定了type则从上下文中找到类型匹配的唯一bean进行装配找不到或者找到多个都会抛出异常

如果既没有指定name又没有指定type则自动按照byName方式进行装配(见如果没有匹配则回退为一个原始类型(UserDao)进行匹配如果匹配则自动装配

@PostConstruct(JSR

在方法上加上注解@PostConstruct这个方法就会在Bean初始化之后被Spring容器执行(注Bean初始化包括实例化Bean并装配Bean的属性(依赖注入))

它的一个典型的应用场景是当你需要往Bean里注入一个其父类中定义的属性而你又无法复写父类的属性或属性的setter方法时

Java代码

public class UserDaoImpl extends HibernateDaoSupport implements UserDao {

private SessionFactory mySessionFacotry;

@Resource

public void setMySessionFacotry(SessionFactory sessionFacotry) {

thismySessionFacotry = sessionFacotry;

}

@PostConstruct

public void injectSessionFactory() {

supersetSessionFactory(mySessionFacotry);

}

}

这里通过@PostConstruct为UserDaoImpl的父类里定义的一个sessionFactory私有属性注入了我们自己定义的sessionFactory(父类的setSessionFactory方法为final不可复写)之后我们就可以通过调用supergetSessionFactory()来访问该属性了

@PreDestroy(JSR

在方法上加上注解@PreDestroy这个方法就会在Bean初始化之后被Spring容器执行由于我们当前还没有需要用到它的场景这里不不去演示其用法同@PostConstruct

使用<context:annotationconfig />简化配置

Spring添加了一个新的context的Schema命名空间该命名空间对注释驱动属性文件引入加载期织入等功能提供了便捷的配置我们知道注释本身是不会做任何事情的它仅提供元数据信息要使元数据信息真正起作用必须让负责处理这些元数据的处理器工作起来

AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是处理这些注释元数据的处理器但是直接在Spring配置文件中定义这些Bean显得比较笨拙Spring为我们提供了一种方便的注册这些BeanPostProcessor的方式这就是<context:annotationconfig />

Java代码

<beans xmlns=/schema/beans xmlns:xsi=//XMLSchemainstance xmlns:context=/schema/context

xsi:schemaLocation=/schema/beans

/schema/beans/springbeansxsd

/schema/context

/schema/context/springcontextxsd>

<context:annotationconfig />

</beans>

<context:annotationconfig />将隐式地向Spring容器注册AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor PersistenceAnnotationBeanPostProcessor以及RequiredAnnotationBeanPostProcessor这个BeanPostProcessor

使用Spring注解完成Bean的定义

以上我们介绍了通过@Autowired或@Resource来实现在Bean中自动注入的功能下面我们将介绍如何注解Bean从而从XML配置文件中完全移除Bean定义的配置

@Component(不推荐使用)@Repository@Service@Controller

只需要在对应的类上加上一个@Component注解就将该类定义为一个Bean了

Java代码

@Component

public class UserDaoImpl extends HibernateDaoSupport implements UserDao {

}

使用@Component注解定义的Bean默认的名称(id)是小写开头的非限定类名如这里定义的Bean名称就是userDaoImpl你也可以指定Bean的名称

@Component(userDao)

@Component是所有受Spring管理组件的通用形式Spring还提供了更加细化的注解形式@Repository@Service@Controller它们分别对应存储层Bean业务层Bean和展示层Bean目前版本()中这些注解与@Component的语义是一样的完全通用在Spring以后的版本中可能会给它们追加更多的语义所以我们推荐使用@Repository@Service@Controller来替代@Component

使用<context:componentscan />让Bean定义注解工作起来 指定扫描的范围

Java代码

<beans xmlns=/schema/beans xmlns:xsi=//XMLSchemainstance xmlns:context=/schema/context

xsi:schemaLocation=/schema/beans

/schema/beans/springbeansxsd

/schema/context

/schema/context/springcontextxsd>

<context:componentscan basepackage=comkedacomksoa />

</beans>

这里所有通过<bean>元素定义Bean的配置内容已经被移除仅需要添加一行<context:componentscan />配置就解决所有问题了——Spring XML配置文件得到了极致的简化(当然配置元数据还是需要的只不过以注释形式存在罢了)<context:componentscan />的basepackage属性指定了需要扫描的类包类包及其递归子包中所有的类都会被处理

<context:componentscan />还允许定义过滤器将基包下的某些类纳入或排除Spring支持以下种类型的过滤方式

过滤器类型 表达式范例 说明

注解 orgexampleSomeAnnotation 将所有使用SomeAnnotation注解的类过滤出来

类名指定 orgexampleSomeClass 过滤指定的类

正则表达式 com\kedacom\spring\annotation\web\* 通过正则表达式过滤一些类

AspectJ表达式 orgexample*Service+ 通过AspectJ表达式过滤一些类

以正则表达式为例我列举一个应用实例

Java代码

<context:componentscan basepackage=comcasheenspringannotation>

<context:excludefilter type=regex expression=com\casheen\spring\annotation\web\* />

</context:componentscan>

值得注意的是<context:componentscan />配置项不但启用了对类包进行扫描以实施注释驱动Bean定义的功能同时还启用了注释驱动自动注入的功能(即还隐式地在内部注册了AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor)因此当使用<context:componentscan />后就可以将<context:annotationconfig />移除了

使用@Scope来定义Bean的作用范围

在使用XML定义Bean时我们可能还需要通过bean的scope属性来定义一个Bean的作用范围我们同样可以通过@Scope注解来完成这项工作

Java代码

@Scope(session)

@Component()

public class UserSessionBean implements Serializable {

}

下面 是一些问答的可以看看

casheen 写道

使用Spring注解来注入属性

使用注解以前我们是怎样注入属性的

类的实现

Java代码

public class UserManagerImpl implements UserManager {

private UserDao userDao;

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

}

配置文件

Java代码

<bean id=userManagerImpl class=comkedacomspringannotationserviceUserManagerImpl>

<property name=userDao ref=userDao />

</bean>

<bean id=userDao class=comkedacomspringannotationpersistenceUserDaoImpl>

<property name=sessionFactory ref=mySessionFactory />

</bean>

引入@Autowired注解(不推荐使用建议使用@Resource)

类的实现(对成员变量进行标注)

Java代码

public class UserManagerImpl implements UserManager {

@Autowired

private UserDao userDao;

}

或者(对方法进行标注)

Java代码

public class UserManagerImpl implements UserManager {

private UserDao userDao;

@Autowired

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

}

配置文件

Java代码

<bean id=userManagerImpl class=comkedacomspringannotationserviceUserManagerImpl />

<bean id=userDao class=comkedacomspringannotationpersistenceUserDaoImpl>

<property name=sessionFactory ref=mySessionFactory />

</bean>

@Autowired可以对成员变量方法和构造函数进行标注来完成自动装配的工作以上两种不同实现方式中@Autowired的标注位置不同它们都会在Spring在初始化userManagerImpl这个bean时自动装配userDao这个属性区别是第一种实现中Spring会直接将UserDao类型的唯一一个bean赋值给userDao这个成员变量第二种实现中Spring会调用setUserDao方法来将UserDao类型的唯一一个bean装配到userDao这个属性

让@Autowired工作起来

要使@Autowired能够工作还需要在配置文件中加入以下代码

Java代码

<bean class=orgspringframeworkbeansfactoryannotationAutowiredAnnotationBeanPostProcessor />

@Qualifier

@Autowired是根据类型进行自动装配的在上面的例子中如果当Spring上下文中存在不止一个UserDao类型的bean时就会抛出BeanCreationException异常如果Spring上下文中不存在UserDao类型的bean也会抛出BeanCreationException异常我们可以使用@Qualifier配合@Autowired来解决这些问题

可能存在多个UserDao实例

Java代码

@Autowired

public void setUserDao(@Qualifier(userDao) UserDao userDao) {

thisuserDao = userDao;

}

这样Spring会找到id为userDao的bean进行装配

可能不存在UserDao实例

Java代码

@Autowired(required = false)

public void setUserDao(UserDao userDao) {

thisuserDao = userDao;

}

@Resource(JSR标准注解推荐使用它来代替Spring专有的@Autowired注解)

Spring 不但支持自己定义的@Autowired注解还支持几个由JSR规范定义的注解它们分别是@Resource@PostConstruct以及@PreDestroy

@Resource的作用相当于@Autowired只不过@Autowired按byType自动注入而@Resource默认按byName自动注入罢了@Resource有两个属性是比较重要的分别是name和typeSpring将@Resource注解的name属性解析为bean的名字而type属性则解析为bean的类型所以如果使用name属性则使用byName的自动注入策略而使用type属性时则使用byType自动注入策略如果既不指定name也不指定type属性这时将通过反射机制使用byName自动注入策略

@Resource装配顺序

如果同时指定了name和type则从Spring上下文中找到唯一匹配的bean进行装配找不到则抛出异常

如果指定了name则从上下文中查找名称(id)匹配的bean进行装配找不到则抛出异常

如果指定了type则从上下文中找到类型匹配的唯一bean进行装配找不到或者找到多个都会抛出异常

如果既没有指定name又没有指定type则自动按照byName方式进行装配(见如果没有匹配则回退为一个原始类型(UserDao)进行匹配如果匹配则自动装配

@PostConstruct(JSR

在方法上加上注解@PostConstruct这个方法就会在Bean初始化之后被Spring容器执行(注Bean初始化包括实例化Bean并装配Bean的属性(依赖注入))

它的一个典型的应用场景是当你需要往Bean里注入一个其父类中定义的属性而你又无法复写父类的属性或属性的setter方法时

Java代码

public class UserDaoImpl extends HibernateDaoSupport implements UserDao {

private SessionFactory mySessionFacotry;

@Resource

public void setMySessionFacotry(SessionFactory sessionFacotry) {

thismySessionFacotry = sessionFacotry;

}

@PostConstruct

public void injectSessionFactory() {

supersetSessionFactory(mySessionFacotry);

}

}

这里通过@PostConstruct为UserDaoImpl的父类里定义的一个sessionFactory私有属性注入了我们自己定义的sessionFactory(父类的setSessionFactory方法为final不可复写)之后我们就可以通过调用supergetSessionFactory()来访问该属性了

@PreDestroy(JSR

在方法上加上注解@PreDestroy这个方法就会在Bean初始化之后被Spring容器执行由于我们当前还没有需要用到它的场景这里不不去演示其用法同@PostConstruct

使用<context:annotationconfig />简化配置

Spring添加了一个新的context的Schema命名空间该命名空间对注释驱动属性文件引入加载期织入等功能提供了便捷的配置我们知道注释本身是不会做任何事情的它仅提供元数据信息要使元数据信息真正起作用必须让负责处理这些元数据的处理器工作起来

AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor就是处理这些注释元数据的处理器但是直接在Spring配置文件中定义这些Bean显得比较笨拙Spring为我们提供了一种方便的注册这些BeanPostProcessor的方式这就是<context:annotationconfig />

Java代码

<beans xmlns=/schema/beans xmlns:xsi=//XMLSchemainstance xmlns:context=/schema/context

xsi:schemaLocation=/schema/beans

/schema/beans/springbeansxsd

/schema/context

/schema/context/springcontextxsd>

<context:annotationconfig />

</beans>

<context:annotationconfig />将隐式地向Spring容器注册AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor PersistenceAnnotationBeanPostProcessor以及RequiredAnnotationBeanPostProcessor这个BeanPostProcessor

使用Spring注解完成Bean的定义

以上我们介绍了通过@Autowired或@Resource来实现在Bean中自动注入的功能下面我们将介绍如何注解Bean从而从XML配置文件中完全移除Bean定义的配置

@Component(不推荐使用)@Repository@Service@Controller

只需要在对应的类上加上一个@Component注解就将该类定义为一个Bean了

Java代码

@Component

public class UserDaoImpl extends HibernateDaoSupport implements UserDao {

}

使用@Component注解定义的Bean默认的名称(id)是小写开头的非限定类名如这里定义的Bean名称就是userDaoImpl你也可以指定Bean的名称

@Component(userDao)

@Component是所有受Spring管理组件的通用形式Spring还提供了更加细化的注解形式@Repository@Service@Controller它们分别对应存储层Bean业务层Bean和展示层Bean目前版本()中这些注解与@Component的语义是一样的完全通用在Spring以后的版本中可能会给它们追加更多的语义所以我们推荐使用@Repository@Service@Controller来替代@Component

使用<context:componentscan />让Bean定义注解工作起来

Java代码

<beans xmlns=/schema/beans xmlns:xsi=//XMLSchemainstance xmlns:context=/schema/context

xsi:schemaLocation=/schema/beans

/schema/beans/springbeansxsd

/schema/context

/schema/context/springcontextxsd>

<context:componentscan basepackage=comkedacomksoa />

</beans>

这里所有通过<bean>元素定义Bean的配置内容已经被移除仅需要添加一行<context:componentscan />配置就解决所有问题了——Spring XML配置文件得到了极致的简化(当然配置元数据还是需要的只不过以注释形式存在罢了)<context:componentscan />的basepackage属性指定了需要扫描的类包类包及其递归子包中所有的类都会被处理

<context:componentscan />还允许定义过滤器将基包下的某些类纳入或排除Spring支持以下种类型的过滤方式

过滤器类型 表达式范例 说明

注解 orgexampleSomeAnnotation 将所有使用SomeAnnotation注解的类过滤出来

类名指定 orgexampleSomeClass 过滤指定的类

正则表达式 com\kedacom\spring\annotation\web\* 通过正则表达式过滤一些类

AspectJ表达式 orgexample*Service+ 通过AspectJ表达式过滤一些类

以正则表达式为例我列举一个应用实例

Java代码

<context:componentscan basepackage=comcasheenspringannotation>

<context:excludefilter type=regex expression=com\casheen\spring\annotation\web\* />

</context:componentscan>

值得注意的是<context:componentscan />配置项不但启用了对类包进行扫描以实施注释驱动Bean定义的功能同时还启用了注释驱动自动注入的功能(即还隐式地在内部注册了AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor)因此当使用<context:componentscan />后就可以将<context:annotationconfig />移除了

使用@Scope来定义Bean的作用范围

在使用XML定义Bean时我们可能还需要通过bean的scope属性来定义一个Bean的作用范围我们同样可以通过@Scope注解来完成这项工作

Java代码

@Scope(session)

@Component()

public class UserSessionBean implements Serializable {

}

上一篇:如何更改Eclipse的字体和背景颜色

下一篇:O/R MAPPING(Hibernate)方法小结