什么是注解
注解是在java1.5版本引入的。java提供了一种原程序中的元素关联任何信息和任何元素的途径和方法。
为什么学习java注解?学习java注解的好处?学完能做什么?
- 能够读懂别人的代码
- 让编程更简洁,代码清晰
- 提升逼格
java中常见的注解
JDK自带注解
- @Override 覆盖
- @Deprecated 方法过时了
- @Suppvisewarnings 忽略警告
常见第三方注解
Spring 里面的 @Autowired @Service @Repository
MyBbatis 里面的@InsertProvider @UpdateProvider @Options
注解分类
运行机制分类
- 源码注解
- 注解在源码中存在,编译成.class文件就不存在了。
- 编译时注解
- 在源码和.class文件中都存在。 jdk自带的基本上都是编译时注解。
- 运行时注解
- 运行时一直存在 @Autowired
- 源码注解
来源来分
- 来自JDk的注解
- 来自第三方的注解
- 自定义注解
- 元注解
- 注解的注解
自定义注解
自定义注解的语法要求
@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
String desc();
String author();
int age()default 18;
}
使用interface定义注解,成员以无参,无异常方式声明。可以指定默认值。
成员类型是受限的,合法的类型包过原始类型以及Sting,Class,Annotation,Enumeration
注解只有一个成员的时候,则成员名必须取为Value(),
元注解
@Target:
@Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。
作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
@Retention:
@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)
Retention meta-annotation类型有唯一的value作为成员,它的取值来自java.lang.annotation.RetentionPolicy的枚举类型值。
@Inherited:
@Inherited 元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。
@Documented:
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
如何使用自定义注解
@<注解名>(<成员1>=<成员值1>,<成员2>=<成员值2>,...)
@Description(desc = "color",author = "hejj",age = 19)
public String getColor(){
return "red";
}