定义
Java注解是附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑,仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。
注解如同标签,用在接口,类,方法,属性上,起到解释说明的作用.同 classs 和 interface 一样,注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。
元注解
注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。
元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。
@Target
/**
@Target
指定了注解运用的地方。当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。
因为 @Target 的存在,标签比如只能张贴到方法上、类上、方法参数上等等。
取值
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
*/
@Target(ElementType.TYPE)
public @interface MyAnnotation3 {
}
@Retention
/**
@Retention
英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。
@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期。
取值:
RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
*/
@Retention(value=RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
}
@Inherited
/**
@Inherited
Inherited是继承的意思
但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,
那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
*/
@Inherited
public @interface MyAnnotation {
@MyAnnotation
public class MyAppication{
}
/**继承了父类的注解*/
public class MyAppication2 extends MyAppication{
}
}
@Documented
/**
@Documented
这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
*/
@Documented
public @interface MyAnnotation {
}
@Repeatable
Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。
什么样的注解会多次应用呢?通常是注解的值可以同时取多个.
@Repeatable(Peoples.class) //@Repeatable 后面括号中的类相当于一个容器注解。
public @interface People {
String role() default "";
}
//容器注解,用来存放其它注解的地方
public @interface Peoples {
People[] value();
}
@People(role="工人")
@People(role="农民")
public class MyApplication{
}
@Peoples(value = { @People(role="工人"),@People(role="农民") })
public class MyApplication2{
//Persons MyApplication2 贴上,相当于同时给他贴了"工人","农民"的标签。
}
属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。
注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@Documented()
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited()
/**Annotations只支持基本类型、String及枚举类型.*/
public @interface MyAnnotation2 {
enum Status {start,running,end};
String speak() default "你好.....";
String listen() default "听说.....";
Status status() default Status.end;
}
示例:
利用反射获取方法注解
public class MyDemo {
@MyAnnotation2(speak="吃饭了吗?",listen="听我说.....",status=Status.running)
public String method_1() throws Exception{
System.out.println("方法1执行");
return "";
}
public static void main(String[] args) throws Exception {
Class<?> clz = Class.forName("com.zqr.annotation.MyDemo");
Method[] methods = clz.getMethods();
for (Method method : methods) {
if (method.isAnnotationPresent(MyAnnotation2.class)) {
MyAnnotation2 ma = method.getAnnotation(MyAnnotation2.class);
String speak = ma.speak();//获取方法注解的speak属性
String listen = ma.listen();//获取方法注解的listen属性
Status status = ma.status();//获取方法注解的status属性
System.out.println("speak:"+speak+",listen:"+listen+",status:"+status);
method.invoke(clz.newInstance(),null);//执行方法
}
}
}
}