涉及概念:注解、三种标准注解(java内置)、四种元注解、标记注解
如果没有用了读取注解的工具,那注解也不会比注释更有用。
一:注解概念
注解(也称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使得我们可以在稍后的某个时刻非常方便的使用这些数据。
注解在一定程度上是在把元数据与源代码文件结合在一起,而不是保存在外部文档文件中这一大的趋势下所催生的。
其语法比较简单,除了@符号的使用外,他基本与其他java固有的语法一致。javaSE内置了三种注解(标准注解):
@Override
@Deprecated
@SuppressWarnings
java另外还提供了四种注解(元注解),负责新注解的创建。(默认为所有)
@Target
@Retention
@Documented
@Inherited
二: 定义注解
package Test_annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;
import java.lang.annotation.RetentionPolicy;
/*
* 元注解@Target,@Retention,@Documented,@Inherited
*
* @Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括:
* ElemenetType.CONSTRUCTOR 构造器声明
* ElemenetType.FIELD 域声明(包括 enum 实例)
* ElemenetType.LOCAL_VARIABLE 局部变量声明
* ElemenetType.METHOD 方法声明
* ElemenetType.PACKAGE 包声明
* ElemenetType.PARAMETER 参数声明
* ElemenetType.TYPE 类,接口(包括注解类型)或enum声明
*
* @Retention 表示在什么级别保存该注解信息。可选的 RetentionPolicy 参数包括:
* RetentionPolicy.SOURCE 注解将被编译器丢弃
* RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃
* RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息。
*
* @Documented 将此注解包含在 javadoc 中
*
* @Inherited 允许子类继承父类中的注解
*
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
/*
* 定义注解 Test
* 注解中含有两个元素 id 和 description
* description 元素 有默认值 "no description"
*/
public @interface Test {
public int id();
public String description() default "no description";
}
如上所示:
1.除了@符合外,定义注解的语法和java语法很是类似,请注意部分不同之处:(1)类型声明@interface (2)元素:public String description() default "no description";
2.注解有一些限制:(1)注解元素只允许以下几种类型:所有基本类型、String、Class(Class<Object>)、enum、Annotation、以上类型的数组(2)元素不能有默认值;对于基本类型的元素,无论是默认值还是使用时,都不能赋值null(3)同一个域可以使用多个注解,但是其中同一个注解不能多次出现(4)注解不支持继承
没有元素的注解称为标记注解
三:注解使用
package Test_annotation;
import java.lang.reflect.Method;
public class Test_1 {
/*
* 被注解的三个方法
*/
@Test(id = 1, description = "hello method_1")
public void method_1() {
}
@Test(id = 2)
public void method_2() {
}
@Test(id = 3, description = "last method")
public void method_3() {
}
}
四:注解解析
如果没有用了读取注解的工具,那注解也不会比注释更有用。使用注解的过程中,更重要的就是创建与使用注解处理器。java扩展了反射机制的api,以帮助程序员构造这类工具,同是还提供了一个外部工具apt帮助程序员解析带有注解的java源代码。
package Test_annotation;
import java.lang.reflect.Method;
public class Test_2 {
/*
* 解析注解,将Test_1类 所有被注解方法 的信息打印出来
*/
public static void main(String[] args) {
Method[] methods = Test_1.class.getDeclaredMethods();
for (Method method : methods) {
/*
* 判断方法中是否有指定注解类型的注解
*/
boolean hasAnnotation = method.isAnnotationPresent(Test.class);
if (hasAnnotation) {
/*
* 根据注解类型返回方法的指定类型注解
*/
Test annotation = method.getAnnotation(Test.class);
System.out.println("Test( method = " + method.getName()
+ " , id = " + annotation.id() + " , description = "
+ annotation.description() + " )");
}
}
}
}
运行结果:
Test( method = method_1 , id = 1 , description = hello method_1 )
Test( method = method_2 , id = 2 , description = no description )
Test( method = method_3 , id = 3 , description = last method )
从上述事例来看,记住这句话“注解(也称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使得我们可以在稍后的某个时刻非常方便的使用这些数据。”
--------以上内容大多来自《java编程思想》