浅析Spring中的注解

简介:

    Spring的配置,通常有两种:使用配置文件和注解。那么Spring如何知道各个Bean或者Service、Controller以及Bean中各类属性之间的关系呢?答案肯定是在定义各个Java文件的时候使用了各种注解,它们交织在一起,实现了使用配置文件完成的配置功能。

一、Bean相关的注解

    与SpringBean相关的注解有以下四大类:

  • @Component:标注一个普通的Spring Bean类

  • @Controller:标注一个控制器组件类

  • @Service:标注一个业务逻辑组件类

  • @Repository:标注一个DAO组件类

    如果我们需要定义一个普通的Spring Bean,那么直接使用@Component标注即可。但如果用@Repository、@Service或者@Controller来标注,那么这个Bean类将被作为特殊的JavaEE组件来对待。在Spring的未来版本中,@Controller、@Service和@Repository也许还能携带更多的语义,因此,如果需要在JavaEE应用中使用这些注解时,尽量考虑使用@Controller、@Service和@Repository来代替普通的@Component注解。例如:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
@Scope ( "prototype" )
@Component ( "pp" )
public  class  People {
     private  int  age;
     private  String name;
     //省略getter和setter
}
 
@Service
public  class  PeopleService {
     @Autowired
     private  PeopleRepo peopleDao;
     
     public  void  addPeople(People p) {
         //other business logic here
         //...call method in PeopleRepo to complete
     }
     //省略 peopleDao的setter和getter
}
 
@Repository
public  class  PeopleRepo {
     public  void  addPeople(PeopleEntity p) {
         //...insert data only
     }
}

    指定了某些类可以作为Spring Bean后,还需要为Spring指定Bean的搜索路径,便于Spring自动在这个路径下搜索相关的Bean。在指定这个(或这些,如果有多个的话)路径之前,需要在Spring配置文件中导入context Schema:

?
1
2
3
4
5
6
7
8
9
10
11
12
<!-- 第4,6,7行是用于导入context Schema的 -->
< beans  xmlns=" 
     xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
     xmlns:context = "http://www.springframework.org/schema/context"
     xsi:schemaLocation = "http://www.springframework.org/schema/beans"
     http://www.springframework.org/schema/context
     http://www.springframework.org/schema/context/spring-context-3.0.xsd">
     
     <!-- 指定Spring将要扫描的包 -->
     < context:component-scan  base-package = "com.abc.model"  />
     < context:component-scan  base-package = "com.abc.service"  />
</ bean >

    上面的配置文件中的 comtext:component-scan指定了Spring将把com.abc.model包和com.abc.service包作为扫描目录,搜索其中带了@Component、@Controller、@Repository和@Service等注解的类作为容器中的Bean(某些是特殊的Bean)。

    在基于XML配置方式下,每个Bean实例的名称都由其id属性指定,而在使用注解配置Spring的方式下,Spring将采用约定的方式来为这些Bean实例指定名称,这些Bean实例的名称默认是Bean类的首字母小写,其他部分不变。 当然,Spring也允许使用@Component注解时自定义Bean的名字,如上面的People的注解@Component("pp"),意为把People的Bean实例命名为“pp”。

    当使用XML配置Bean时,可以通过scope来指定Bean的作用域,在使用注解时,可通过@Scope注解来标注,只要在该注解中提供作用域的名称即可。例如上面的:

?
1
2
3
4
5
6
7
@Scope ( "prototype" )
@Component ( "pp" )
public  class  People {
     private  int  age;
     private  String name;
     //省略getter和setter
}

    另外,我们还可以通过为<component-scan>元素添加<include-filter>和<exclude-filter>子元素来限制Spring Bean的类。满足<include-filter>定义的规则的Java类,才会被当作Bean处理,满足<exclude-filter>规则的Java类,则不会当作Bean处理。使用这两个属性时,都需要为其指定下面两个元素:

  • type:指定过滤器类型

  • expression:知道你过过滤器所需要的表达式

    Spring支持以下几种过滤器:

  • annotation:Annotation过滤器,该过滤器需要指定一个Annotation名

  • assignable:类名过滤器,该过滤器直接指定一个Java类

  • regex:正则表达式过滤器,该过滤器指定一个正则表达式,匹配该正则表达式的Java类将满足该过滤规则。如:com\.abc\.*

  • aspectj:AspectJ过滤器

?
1
2
3
4
5
<!-- 指定Spring将要扫描的包 -->
< context:component-scan  base-package = "com.abc.model" >
     < context:include-filter  type = "regex"  expression = ".*Peo*"  />
     < context:exclude-filter  type = "regex"  expression = ".*PPP*"  />
</ context:component-scan >

    

二、使用@Resource配置依赖

    @Resource注解位于java.annotation包下,是来自JavaEE规范中的一个注解,Spring直接借鉴了该注解,其作用是为目标Bean指定协作者Bean。

    @Resource有一个name属性,在默认情况下,Spring将这个值解释为需要被注入的Bean实例的名字。换句话说:使用@Resource与配置文件中<property>中的ref属性有相同的效果。例如:

?
1
2
3
4
5
6
7
8
@Component
public  class  People {
     private  Work work;
     @Resource (name= "computerWork" )
     public  void  setWork(Work work) {
         this .work = work;
     }
}

    上例就是将“computerWork”注入该setWork方法,也就是将容器中的computerWork作为setWork()方法的参数传入。

    @Resource方法不仅可以修饰setter方法,还可以直接修饰Field。如果使用@Resource修饰Field将更加简单,此时Spring将直接使用JavaEE中规范的Field注入,此时连setter方法都可以不要,例如可以将刚刚的例子改写为:

?
1
2
3
4
5
6
@Component
public  class  People {
     @Resource (name= "computerWork" )
     private  Work work;
     //do not need setter anymore
}

    使用@Resource注解时,其name属性也可以省略,默认情况下,name属性是该setter方法去掉set子串后,再将首字母小写得到的值。例如:使用@Resource标注setWork方法,则Spring默认会注入容器中名为work的组件。

    当使用@Resource标注一个Field时,如果省略name属性,则name属性默认与被标注的Field同名。例如:使用@Resource标注private Work work域,则Spring将把容器中名为work的组件注入。


三、使用@PostConstruct和@PreDestroy定制Bean的生命周期行为

    @PostConstruct和@PreDestroy两个注解同样位于java.annotation包下,也是来自JavaEE规范的注解,Spring也借鉴了它们,用于定制Spring容器中Bean的生命周期行为。这里介绍了Spring中的Bean可以指定init-method和destroy-method属性,而@PostConstruct和@PreDestroy的作用与此大致相似,他们都用于修饰方法,无需任何属性。其中前者修饰的方法是Bean的初始化方法;而后者修hi的方法是Bean销毁之前将要调用的方法。例如:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
@Component
public  class  People {
     @Resource (name= "computerWork" )
     private  Work work;
     
     @PostConstruct
     public  void  init() {
         //...other operations here
         System.out.println( "init方法:所有依赖注入完成" );
     }
     
     @PreDestroy
     public  void  destroy() {
         //...other operations here
         System.out.println( "destroy方法:销毁之前" );
     }
}


四、Spring3.0新增的注解

    Spring3.0增加了两个新的注解:@DependsOn和@Lazy ,其中@DependsOn用于强制初始化其他Bean,而@Lazy则用于指定该Bean是否取消预初始化。

    @DependsOn可以修饰Bean类或方法,使用该注解时可以指定一个字符串数组作为参数,每个数组元素对应一个强制初始化的Bean,例如:

?
1
2
3
4
5
6
7
8
@DependsOn ({ "computerWork" , "job" })
@Component
public  class  People {
     @Resource (name= "computerWork" )
     private  Work work;
     @Resource (name= "job" )
     private  Job job;
}

    上面的代码使用了@DependsOn修饰了People类,这就指定在初始化People Bean之前,会强制初始化computerWork和job两个Bean。

    @Lazy注解主要用于修饰Spring Bean类,用于指定该Bean的预初始化行为,使用该注解时可以指定一个bool类型的值,该属性决定是否预初始化这个Bean。如果该值为true,则表示该Bean不会预初始化。例如:

?
1
2
3
4
5
@DependsOn ( true //这个Bean不会预初始化
@Component
public  class  People {
     //....
}


五、自动装配与精确装配

    Spring提供了@Autowired注解来指定自动装配,使用@Autowired可以标注setter方法,普通方法,Field和构造器等。例如:

?
1
2
3
4
5
6
7
8
9
@Component
public  class  People {
     private  Work work;
     
     @Autowired
     public  void  setWork(Work work) {
         this .work = work;
     }
}

    上面的代码使用了@Autowired指定对setWork()方法进行自动装配,Spring会将自动搜索器中类型为Work的Bean实例,并将该Bean实例作为setWork()方法的参数传入,注入给People实例。由此可见,当使用@Autowired注解标注setter方法时,默认使用的是byType的自动装配策略。

    Spring允许使用@Autowired来标注同时注入多个参数的普通方法,例如:

?
1
2
3
4
5
6
7
8
9
10
11
@Component
public  class  People {
     private  Work work;
     private  Job job;
     
     @Autowired
     public  void  init(Work work, Job job) {
         this .work = work;
         this .job = job;
     }
}

    使用@Autowired来标注Field和构造器的例子:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
@Component
public  class  People {
     @Autowired
     private  School school;
     private  Work work;
     private  Job job;
     
     @Autowired
     public  People(Work work, Job job) {
         this .work = work;
         this .job = job;
     }
}

    当使用@Autowired来标注一个Field时,Spring将会把容器中与该Field类型匹配的Bean注入该属性。例如程序中使用@Autowired标注了school属性,则Spring会自动搜索容器中的School实例,并将该实例设置成该school Field的值;如果此时容器中不止一个School类型的Bean,则Spring将抛出一个BeanCreateException异常。

    @Autowired甚至可以用来修饰数组:

?
1
2
3
4
5
@Component
public  class  People {
     @Autowired
     private  School[] schools;
}

    在这种情况下,Spring将会搜集容器中所有类型为School的Bean,并用这些Bean创建一个数组,最后将这个数组注入给People的schools属性。与此类似的是,@Autowired也可以标注集合Field,或标注形参类型是集合的方法,Spring对这种集合属性,集合形参的处理与前面数组的处理是完全相同的。例如:

?
1
2
3
4
5
6
7
8
9
10
11
@Component
public  class  People {
     @Autowired
     private  Set<School> schools;
     
     private  Set<Work> works;
     @Autowired
     public  void  setWorks(Set<Work> works) {
         this .works = works;
     }
}

    对于这种集合类型的参数而言,程序代码中必须使用泛型,正如上面的程序所示,程序制定了该方法参数是Set<Work>类型,这表明,Spring会自动搜索容器中所有的Work类型实例,并将这些示例注入到到works属性中。如果程序中没有使用泛型来指明集合元素类型, 则Spring将不知所措。

    正如上面看到的,@Autowired总是采用byType的自动装配策略,在这种策略下,符合自动装配的类型的候选Bean常常有多个,这个时候就可能引起异常了(对于数组,集合类型的参数则不会)。

    为了实现精确的自动装配,Spring提供了@Qualifier注解,通过使用这个注解,允许Bean标识来指定自动装配。通常会为@Qualifier指定一个名字,表示精确定位id为这个名字的Bean,@Qualifier通常用于修饰Field,例如:

?
1
2
3
4
5
6
7
8
9
10
11
@Component
public  class  People {
     @Autowired
     @Qualifier ( "juniorHighSchool" )
     private  School school;
     
     //setter
     public  void  setSchool(School school) {
         this .shool = school;
     }
}

    上面的配置文件中指定了school将使用自动装配,且精确指定了被装配的Bean实例名称为juniorHighSchool,这意味着如果Spring容器中有多个School类型的Bean,只会将一个名为juniorHighSchool的Bean注入进来。

    除此之外,Spring还允许使用@Qualifier来标注方法的形参,例如:

?
1
2
3
4
5
6
7
8
9
@Component
public  class  People {   
     private  School school;
     
     //setter
     public  void  setSchool( @Qualifier ( "juniorHighSchool" )School school) {
         this .shool = school;
     }
}

目录
相关文章
|
30天前
|
Java Spring 容器
如何解决spring EL注解@Value获取值为null的问题
本文探讨了在使用Spring框架时,如何避免`@Value(&quot;${xxx.xxx}&quot;)`注解导致值为null的问题。通过具体示例分析了几种常见错误场景,包括类未交给Spring管理、字段被`static`或`final`修饰以及通过`new`而非依赖注入创建对象等,提出了相应的解决方案,并强调了理解框架原理的重要性。
97 4
|
14天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
3天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
15 4
SpringBoot必须掌握的常用注解!
|
27天前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
58 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
5天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
29 2
|
5天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
23 1
|
19天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
24天前
|
XML Java 数据库
Spring boot的最全注解
Spring boot的最全注解
|
25天前
|
JSON NoSQL Java
springBoot:jwt&redis&文件操作&常见请求错误代码&参数注解 (九)
该文档涵盖JWT(JSON Web Token)的组成、依赖、工具类创建及拦截器配置,并介绍了Redis的依赖配置与文件操作相关功能,包括文件上传、下载、删除及批量删除的方法。同时,文档还列举了常见的HTTP请求错误代码及其含义,并详细解释了@RequestParam与@PathVariable等参数注解的区别与用法。
|
25天前
|
Java API Spring
springBoot:注解&封装类&异常类&登录实现类 (八)
本文介绍了Spring Boot项目中的一些关键代码片段,包括使用`@PathVariable`绑定路径参数、创建封装类Result和异常处理类GlobalException、定义常量接口Constants、自定义异常ServiceException以及实现用户登录功能。通过这些代码,展示了如何构建RESTful API,处理请求参数,统一返回结果格式,以及全局异常处理等核心功能。