前言
这段时间bug有点多,白天的时间几乎都用在改bug了,近一个月都很少看书了,得赶紧改完bug看书。在spring源码分析结束之后,我们也已经完成了循环依赖的解决方案以及设计模式,那么接下来我们分析下Spring中常用的注解。
这里先说明下注解类型。
Annotition的类型使用关键字 @interface 而不是interface。它继承了java.lang.annotition.Annotition接口,并非申明了一个interface。
Annotation类型、方法定义是独特的、受限制的:
Annotation类型的方法必须申明为无参数、无异常抛出的。这些方法定义了 Annotation的成员:方法名为成员名,而方法返回值为成员的类型。
特别的,如果方法名为 value(), 则在注解的地方需要设置属性值时可以直接写入值,如:@Target({ElemenetType.TYPE}) 而不必写为 @Target(value={ElemenetType.TYPE})
方法返回值必须为primitive类型、Class类型、枚举类型、Annotation类型或者由前面类型之一作为元素的一位数组。
方法的后面可以使用default关键字加一个默认数值来申明成员的默认值,null不能作为成员的默认值,这与我们在非Annotation类型中定义方法有很大不同。
Annotation类型和他的方法不能使用Annotation类型的参数,成员不能是generic。只有返回值类型是Class的方法可以在Annotation类型中使用generic,因为此方法能够用类转换将各种类型转换为Class。
Annotation类型又与接口有着近似之处:它可以定义常量、静态成员类型(比如枚举类型定义);Annotation类型也可以如接口一般被实现或者继承。
1、元注解
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它annotation类型作说明 。
- 1.@Target,
- 2.@Retention,
- 3.@Documented,
- 4.@Inherited
这些可以通过Spirngboot的注解@SpringBootApplication
了解到。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
1.1、@Target
用于设定注解使用范围
【详细参考】@Target注解
Target通过ElementType来指定注解可使用范围的枚举集合。
- ElementType.TYPE: 接口、类、枚举、注解
- ElementType.FIELD: 字段、枚举的常量
- ElementType.METHOD: 方法
- ElementType.PARAMETER: 方法参数
- ElementType.CONSTRUCTOR: 构造函数
- ElementType.LOCAL_VARIABLE: 局部变量
- ElementType.ANNOTATION_TYPE: 注解
- ElementType.PACKAGE: 包
1.2、@Retention
定义注解的保留策略。
【详细参考】@Retention
通过RetentionPolicy来指定注解的枚举集合。
- RetentionPolicy.SOURCE :注解仅存在于源码中,在class字节码文件中不包含
- RetentionPolicy.CLASS:默认的保留策略,注解会在class字节码文件中存在,但运行时无法获得
- RetentionPolicy.RUNTIME:注解会在class字节码文件中存在,在运行时可以通过反射获取到
1.3、@Documented
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
1.4、@Inherited
说明子类可以继承父类中的该注解
- 被@Inherited注解的注解只有在class上使用才会有“自动继承的特性”
- “自动继承的特性”是指如果在子类上搜索注解,其父类上的被@Inherited注解过的注解会考虑在内
【参考】@Inherited
2、Spring-IOC中的注解
2.1 、Autowired注解
按照byType注入,这是最核心的注解,左右就不说明了,直接看源码
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD, ElementType.PARAMETER, ElementType.FIELD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Autowired {
boolean required() default true;
}
这里我们看到了元注解,说明所有的注解都是基于这四种元注解。
@Autowired 根据bean 类型从spring 上下文中进行查找,注册类型必须唯一,否则报异常。与@Resource 的区别在于,@Resource 允许通过bean 名称或bean 类型两种方式进行查找@Autowired(required=false) 表示,如果spring 上下文中没有找到该类型的bean 时, 才会使用new()的方式;
@Autowired 标注作用于 Map 类型时,如果 Map 的 key 为 String 类型,则 Spring 会将容器中所有类型符合 Map 的 value 对应的类型的 Bean 增加进来,用 Bean 的 id 或 name 作为 Map 的 key。
@Autowired 还有一个作用就是,如果将其标注在 BeanFactory 类型、ApplicationContext 类型、ResourceLoader 类型、ApplicationEventPublisher 类型、MessageSource 类型上,那么 Spring 会自动注入这些实现类的实例,不需要额外的操作。
2.2 @Qualifier
通常和 @Autowired一起使用
@Autowired
@Qualifier("softService")
private ISoftPMService softPMService;
- 说明
使用@Autowired 时,如果找到多个同一类型的bean,则会抛异常,此时可以使用 @Qualifier("beanName"),明确指定bean的名称进行注入,此时与 @Resource指定name属性作用相同。
2.3 @Resource
@Resource默认按照ByName自动注入
@Resource有两个重要的属性:name和type,而Spring将@Resource注解的name属性解析为bean的名字,而type属性则解析为bean的类型
2.4、RequestMapping
这是springMVC中最常用的注解,在Spring4.0以后的版本推出了@GetMapping,@PostMapping,@PutMapping,@DeleteMapping等,这些是为restful风格提供的封装注解,其实就是@RequestMapping和对应RequestMethod合并的注解。
- 作用 :@GetMapping = @RequestMapping(method = RequestMethod.GET)
- 说明:可以作用在类或者方法上,请求地址为类上的地址+方法上的地址
- 参数绑定说明:
如:http://localhost/user/list?userId=10&userName=tom
@GetMapping("/user/list")
public User getUser(User user){
···········
}
这样userId和username会映射到user对应的属性上。
2.5、@RequestParam,@PathVariable
用于绑定参数,@PathVariable用于邦迪地址中rest风格的参数,@RequestParam用于绑定普通提交的参数。
@PostMapping("/status/update/{id}")
public RestResult updateStatus(@PathVariable Long id, @RequestParam("status") Boolean status) {
··········
}
@RequestParam(value="id",required=false),required = faluse该参数非必须,默认为true
2.6、@Scope
该方法指定bean的创建类型,默认为单例,另外scope还有prototype、request、session、global session作用域。scope="prototype"多例
1.singleton : 全局有且仅有一个实例
2.prototype:每次获取Bean的时候会有一个新的实例
3、request:request表示该针对每一次HTTP请求都会产生一个新的bean,同时该bean仅在当前HTTP request内有效
4、session:session作用域表示该针对每一次HTTP请求都会产生一个新的bean,同时该bean仅在当前HTTP session内有效
5、global session作用域类似于标准的HTTPSession作用域,不过它仅仅在基于portlet的web应用中才有意义
2.7、@Service,@Repository,@Component
用于标注业务层组件,可以看到该注解默认使用了@Component
【@Service】
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Service {
String value() default "";
}
【@Repository】
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Repository {
String value() default "";
}
【@Component】
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Component {
String value() default "";
}
由此可见这三个注解没有功能没有太大的区别,主要是用来标注业务,做业务方面的区分。
@Service用于标注业务层组件
@Repository用于标注数据访问组件,即DAO组件
@Component泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
2.8、@Controller、@RestController
用于标注控制层组件即SpringMVC中的Controler
在4.0之后推出了@RestController其实就是@Controller和@ResponseBody的合集
2.9、@ResponseBody
该注解用于将Controller的方法返回的对象,通过适当的HttpMessageConverter转换为指定格式后,写入到Response对象的body数据区。
作用域类或者方法上
【详细参考】(http://www.cnblogs.com/fangjian0423/p/springMVC-request-param-analysis.html)
这块详细的到springMVC源码分析的时候再讲
3.0、@RequestBody
该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;
再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。
写在最后
这一篇主要是写了一些Sping的注解,下一篇讲下配合SpingBoot推出的注解