注解概述
格式
public @interface 注解名称{
属性列表;
}
分类
大致分为三类:自定义注解、JDK内置注解、还有第三方框架提供的注解。
使用位置
实际开发中,注解常常出现在类、方法、成员变量、形参位置。当然还有其他位置,这里不提及。
作用
如果说注释是写给人看的,那么注解就是写给程序看的。它更像一个标签,贴在一个类、一个方法或者字段上。它的目的是为当前读取该注解的程序提供判断依据及少量附加信息。比如程序只要读到加了@Test的方法,就知道该方法是待测试方法,又比如@Before注解,程序看到这个注解,就知道该方法要放在@Test方法之前执行。有时我们还可以通过注解属性,为将来读取这个注解的程序提供必要的附加信息,比如@RequestMapping("/user/info")提供了Controller某个接口的URL路径。
注解的本质
@interface和interface从名字上看非常相似,其实注解的本身也就是一种接口。
编译后得到字节码文件:
反编译MyAnnotation.class:
所以注解实际上是一个继承接口Annotation的接口。
既然确实是个接口,那么我们自然可以在里面写方法
/**
* @author qiyu
*/
public @interface MyAnnotation {
String getValue();
}
getValue()赋值:
/**
* @author qiyu
*/
@MyAnnotation(getValue = "annotation on class")
public class Demo {
@MyAnnotation(getValue = "annotation on field")
public String name;
@MyAnnotation(getValue = "annotation on method")
public void hello() {}
}
这里看起来有点怪异,是在给方法赋值,由于方法是不能赋值的,所以底层或许是getValue()返回的一个同名变量。但不管怎么说,还是太怪异了。所以在注解里,类似于String getValue()这种,被称为“属性”,而给属性赋值显然听起来好接受多了。
另外,我们还可以为属性指定默认值:
当没有赋值时,属性将使用默认值,比如上面的defaultMethod(),它的getValue就是“no description"。
作者:知乎用户
链接:https://www.zhihu.com/question/24401191/answer/1724982163
来源:知乎
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
元注解
所谓元注解,就是加在注解上的注解。作为普通程序员,常用的就是:
- @Documented:用于制作文档,不是很重要,忽略便是
- @Target:加在注解上,限定该注解的使用位置。不写的话,好像默认各个位置都是可以的。
- @Retention:注解的保留策略
注解的保留策略有三种:SOURCE/ClASS/RUNTIME
“保留策略”这个元注解的意义在哪呢?
一般来说,普通开发者使用注解的时机都是运行时,比如反射读取注解(也有类似Lombok这类编译期注解)。既然反射是运行时调用,那就要求注解的信息必须保留到虚拟机将.class文件加载到内存为止。如果你需要反射读取注解,却把保留策略设置为RetentionPolicy.SOURCE、RetentionPolicy.CLASS,那就读取不到了。
注解三部曲
- 定义注解
- 使用注解
- 读取注解
仅仅完成前两步,是没什么卵用的。就好比你写了一本武林秘籍却没人去学,那么这门武功还不如一把菜刀。
定义注解
/**
* @author qiyu
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
String getValue() default "no description";
}
使用注解:
/**
* @author qiyu
*/
@MyAnnotation(getValue = "annotation on class")
public class Demo {
@MyAnnotation(getValue = "annotation on field")
public String name;
@MyAnnotation(getValue = "annotation on method")
public void hello() {}
@MyAnnotation() // 故意不指定getValue
public void defaultMethod() {}
}
重新运行程序,成功读取注解信息: