1、注解的理解
- 从JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)
- Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
- Annotation 可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。
- 在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架= 注解+ 反射+ 设计模式。
2、Annotation的使用示例
使用Annotation 时要在其前面增加@ 符号, 并把该Annotation 当成一个修饰符使用。用于修饰它支持的程序元素
- 示例一:生成文档相关的注解
- @author标明开发该类模块的作者,多个作者之间使用,分割
- @version标明该类模块的版本
- @see参考转向,也就是相关主题
- @since从哪个版本开始增加的
- @param对方法中某参数的说明,如果没有参数就不能写
- @return对方法返回值的说明,如果方法的返回值类型是void就不能写
- @exception对方法可能抛出的异常进行说明,如果方法没有用throws显式抛出的异常就不能写其中
- @param@return和@exception这三个标记都是只用于方法的。
- @param的格式要求:@param形参名形参类型形参说明
- @return的格式要求:@return返回值类型返回值说明
- @exception的格式要求:@exception异常类型异常说明
- @param和@exception可以并列多个
- 示例二:在编译时进行格式检查(JDK内置的三个基本注解)
- @Override: 限定重写父类方法, 该注解只能用于方法
- @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
- @SuppressWarnings: 抑制编译器警告
- 示例三:跟踪代码依赖性,实现替代配置文件功能
- Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。
- spring框架中关于“事务”的管理 ```java import java.util.ArrayList; import java.util.Date;
/**
- 注解的使用 *
- 理解Annotation:
- ① jdk 5.0 新增的功能 *
- ② Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用 Annotation,
- 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。 *
- ③在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android
- 中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗
- 代码和XML配置等。 *
- Annocation的使用示例
- 示例一:生成文档相关的注解
- 示例二:在编译时进行格式检查(JDK内置的三个基本注解)
- @Override: 限定重写父类方法, 该注解只能用于方法
- @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
- @SuppressWarnings: 抑制编译器警告 *
示例三:跟踪代码依赖性,实现替代配置文件功能 */ public class AnnotationTest { public static void main(String[] args) {
Person p = new Student();
p.walk();
Date date = new Date(2020, 10, 11);
System.out.println(date);
@SuppressWarnings("unused")
int num = 10;
// System.out.println(num);
@SuppressWarnings({ "unused", "rawtypes" })
ArrayList list = new ArrayList();
}
}
class Person{ private String name; private int age;
public Person() {
super();
}
public Person(String name, int age) {
this.name = name;
this.age = age;
}
public void walk(){
System.out.println("学习中……");
}
public void eat(){
System.out.println("摸鱼中……");
}
}
interface Info{ void show(); }
class Student extends Person implements Info{
@Override
public void walk() {
System.out.println("喷子走开");
}
@Override
public void show() {
}
}
<a name="V7cQf"></a>
# 3、如何自定义注解
- 定义新的Annotation类型使用****@interface****关键字
- 自定义注解自动继承了****java.lang.annotation.Annotation****接口
- Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型**、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。**
- 可以在定义Annotation的成员变量时为其指定初始值,指定成员变量的初始值可使用**default**关键字
- 如果只有一个参数成员,建议使用**参数名为value**
- 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名=参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”
- 没有成员定义的Annotation称为标记;包含成员变量的Annotation称为元数据Annotation
- 注意:**自定义注解必须配上注解的信息处理流程才有意义**。
```java
public @interface MyAnnotation {
String value();
}
/**
* 注解的使用
*
* 3.如何自定义注解:参照@SuppressWarnings定义
* ① 注解声明为:@interface
* ② 内部定义成员,通常使用value表示
* ③ 可以指定成员的默认值,使用default定义
* ④ 如果自定义注解没有成员,表明是一个标识作用。
*
* 如果注解有成员,在使用注解时,需要指明成员的值。
* 自定义注解必须配上注解的信息处理流程(使用反射)才有意义。
* 自定义注解通过都会指明两个元注解:Retention、Target
*
*/
@MyAnnotation(value = "hello")
4、jdk中的4个元注解
元注解:对现有的注解进行解释说明的注解
Retention:
- 指定所修饰的 Annotation 的生命周期:
- SOURCE:不会在.class文件中包含
- CLASS(默认行为) : 会被保留 .class文件中,但是运行是不会被加载
- RUNTIME : 被保留在.class中,在运行时会被加载到内存中。可以通过反射进行获取,只有声明为RUNTIME生命周期的注解,才能通过反射获取。
- 只有声明为RUNNTIME生命周期的注解才能通过反射获取
Target
- 用于指定被修饰的Annotation 能用于修饰那些程序元素
- TYPE : 表示注解可以修饰 类、接口、枚举
- FIELD : 表示注解可以修饰 属性
- METHOD : 表示注解可以修饰 方法
- PARAMETER : 参数
- CONSTRUCTOR : 构造器
- LOCAL_VARIABLE : 局部方法
- ANNOTATION_TYPE : 注解类型
- PACKAGE : 包
Documented
- 表示所修饰的注解在被javadoc解析时保留下来
Inherited
- 被他修饰的注解将具有继承性
5、jdk8后的注解新特性:可重复注解、类型注解
5.1、可重复注解
可重复注解 :
①、在想要可重复注解上声明@Repeatable,成员值为另外注解的.class,另外注解中创建 以想要可重复注解的数组类型
②、可重复注解的Target和Retention等元注解 需要和成员值中的注解一致 ```java import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
@Retention(RetentionPolicy.RUNTIME) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) public @interface MyAnnotations {
MyAnnotation[] value();
}
```java
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
String value() default "hello";
}
5.2、类型注解
- ElementType.TYPE_PARAMETER 表示该注解那能写在类型变量的声明语句中(如:泛型声明) ,可以修饰泛型类型
- ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。 ```java import java.util.ArrayList;
/**
- 注解的使用 *
- 6.jdk 8 中注解的新特性:可重复注解、类型注解 *
- 6.1可重复注解:① 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
- ② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。 *
- 6.2类型注解:
- ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)。
- ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。 / public class AnnotationTest {
}
class Generic<@MyAnnotation T>{
public void show() throws @MyAnnotation RuntimeException{
ArrayList<@MyAnnotation String> list = new ArrayList<>();
int num = (@MyAnnotation int) 10L;
}
}
```java
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {
String value() default "hello";
}