java 注解，从名字上看是注释，解释。但功能却不仅仅是注释那么简单。注解（Annotation） 为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后 某个时刻方便地使用这些数据（通过 解析注解 来使用这些数据），常见的作用有以下几种：
包class="Apple-converted-space">?java.lang.annotation?中包含所有定义自定义注解所需用到的原注解和接口。如接口 java.lang.annotation.Annotation?是所有注解继承的接口,并且是自动继承，不需要定义时指定，类似于所有类都自动继承Object。
该包同时定义了四个元注解，Documented,Inherited,Target(作用范围，方法，属性，构造方法等),Retention(生命范围，源代码，class,runtime)。下面将在实例中逐个讲解他们的作用，及使用方法。
Inherited :?在您定义注解后并使用于程序代码上时，预设上父类别中的注解并不会被继承至子类别中，您可以在定义注解时加上java.lang.annotation.Inherited 限定的Annotation，这让您定义的Annotation型别被继承下来。注意注解继承只针对class 级别注解有效（这段建议看完全文后在来回顾）。 多说无益，下面就一步步从零开始建一个我们自己的注解。
???建第一个注解
?
在下面这个程序中使用它：
编译没有报错，ok，一个注解实验完成。这个注解也太简单了吧，好像什么信息也不能传递。别急下面就来一步步完善它，也该四位元注解依次开始上场了。四个元注解分别是：@Target,@Retention,@Documented,@Inherited?，再次强调下元注解是java API提供，是专门用来定义注解的注解，其作用分别如下。
???
??? ? ? @Target 表示该注解用于什么地方，可能的值在枚举类 ElemenetType 中，包括：?
????????? ElemenetType.CONSTRUCTOR 构造器声明?
????????? ElemenetType.FIELD 域声明（包括 enum 实例）?
????????? ElemenetType.LOCAL_VARIABLE 局部变量声明
??????????ElemenetType.ANNOTATION_TYPE 作用于注解量声明????????? ElemenetType.METHOD 方法声明
????????? ElemenetType.PACKAGE 包声明?
????????? ElemenetType.PARAMETER 参数声明?
????????? ElemenetType.TYPE 类，接口（包括注解类型）或enum声明?
???????????
???? @Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中，包括：?
????????? RetentionPolicy.SOURCE 注解将被编译器丢弃?
????????? RetentionPolicy.CLASS 注解在class文件中可用，但会被VM丢弃?
????????? RetentionPolicy.RUNTIME VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。?
???????????
????? @Documented 将此注解包含在 javadoc 中 ，它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。
???????
????? @Inherited 允许子类继承父类中的注解，例子中补充。
???
学习最忌好高骛远，我们就一个一个来实验。
第一个：@Target，动手在前面我们编写的注解上加上元注解。
?
ctrl+ s 保存，今天电脑比较给力，我们的测试类那边立马出现了一堆错误，除了类注解。我想到这，聪明的你立刻明白了这个元注解的意义了。是不是想当然的偷起懒来了。？难道还有意外？细心的朋友应该发现了，我们的测试类少了一个属性没用，就是ElemenetType.PACKAGE。在我们的注解加上这个属性的元注解后，我们测试程序的元注解全部阵亡，不对，还有一个没加呢，好加上。package 包，想当然是加载 package 前面。即
?
什么也报错。这就搞不明白了，不加在这加哪去呢。我也不知道了，不过这是编译错误，我们的eclipse 将错误给我们指出了，就是
? Package annotations must be in file package-info.java ，e 文虽然不好，但这个简单的还是难不倒几个人的，package 注解必须定义在 package-info.java 中。package-info 又是什么东西，好了为节省你们的时间帮你百度好了，传送门。ok,到此 target 元注解就全部完成了。
第二个元注解： @Retention 参数 RetentionPolicy。有了前面的经验这个注解理解起来就简单多了，并且幸运的是这个注解还没有特殊的属性值。 简单演示下如何使用：
?
@Retention(RetentionPolicy.RUNTIME)
第三和第四个元注解就不再举例了。比较简单，也没有值，相信看过上面的解释也就清楚了。下面我们还是继续来深入的探讨下注解的使用。上面的例子都非常简单，注解连属性都没有。ok，下面我们就来定义一个有属性的注解，并在例子程序中获取都注解中定义的值。
开始之前将下定义属性的规则：
????????@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
代码：
?
下面改下我们的测试类：
?
?
下面到了最重要的一步了，就是如何读取我们在类中定义的注解。只要读取出来了使用的话就简单了。
jdk1.5 既然增加了注解，肯定就增加了相关读取的api
在java.lang.reflect包中新增了AnnotatedElement接口，JDK源码如下：
?
?
?
?
?
先别说话，运行：
?
?
看到了吧，我们定义的注解都完整的输出了，你要使用哪个，直接拿去用就好了。
为了不让这篇文章打开太慢，我省略了类属性注解，及参数注解的解析。其实都大同小异。
另外，我也没有举使用例子。因为我认为好的教程是讲的详细的同时，还会留有扩展。如果我全部写出来，而你只是学习的话，那基本不会自己去动脑了，而是复制粘贴运行一遍完事。
???最后提醒下：
?????1. 要用好注解，必须熟悉java 的反射机制，从上面的例子可以看出，注解的解析完全依赖于反射。
???? 2. 不要滥用注解。平常我们编程过程很少接触和使用注解，只有做设计，且不想让设计有过多的配置时。
?疑问：
????? 即?ElementType.?ANNOTATION_TYPE：注解类型，到底什么作用，我发现即使不使用这个类型，我们自定义的注解也可以用来注释其他注解（eclipse 报错，但仍可以编译，也仍可以在测试类中读取出报错的注解，使用TYPE编译器都不报错），难道只是标示注解是个元注解，知道的麻烦告知一下
?
?
java注解
?
自JDK1.5之后引入注解之后，各个框架中都提供了支持注解的方式。在日常开发中慢慢的将XML许多的配置转换成注解，经常的使用 甚至陶sir在定义日终类的时候，自定义了注解：@Trigger 和 @TargetMethod 以作使用。可见注解的易用性和广泛性。
这边对注解做一些了解
元注解：在jdk中提供了 为自定义注解 所需要的几个元注解：
??? @interface ： 用于定义注解
??? @Target ：用于描述注解的使用范围? 大致有 method(方法) field(属性) type (类)
??? @Retention ： 注解的生命周期 SOURCE ：源文件有效，CLASS ：class文件有效， RUNTIME ： 运行时有效
??? @Documented ： javadoc记录标记
然后对应注解 自定义 method field type 三类注解：
?
/**
?* 自定义注解，目标范围是字段
?*
?* @author yanbin
?*
?*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface AnnotationField {
??? public String fieldValue() default "default Field value";
}
/**
?* 自定义注解，目标范围是方法
?*
?* @author yanbin
?*
?*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface AnnotationMethod {
??? public String methodValue() default "default Method value";
???
}
/**
?* 自定义注解，目标是类
?*
?* @author yanbin
?*
?*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface AnnotationType {
??? public String typeValue() default "default Type value";
}
?
?
在一个类上面使用自定义的注解：
?
/**
?* 注解使用者
?*
?* @author yanbin
?*
?*/
@AnnotationType(typeValue = "user Type value")
public class AnnotationUser {
??? /** 字段属性 */
??? @AnnotationField(fieldValue = "user Field value")
??? private String userField;
??? /**
???? * 使用者方法
???? */
??? @AnnotationMethod(methodValue = "user method value")
??? public String userMethod() {
??????? return "user default method value";
??? }
??? /**
???? * 做事
???? */
??? public void doIt() {
??????? System.out.println(userField);
??? }
??? public String getUserField() {
??????? return userField;
??? }
??? public void setUserField(String userField) {
??????? this.userField = userField;
??? }
}
?
?
测试类，解析注解：
?
/**
?* 注解测试类，获取注解关键在反射
?*
?* @author yanbin
?*
?*/
public class AnnotationTest {
??? public static void main(String[] args) {
??????? AnnotationTest test = new AnnotationTest();
??????? test.resolve();
??????? test.testDoIt();
??? }
??? /**
???? * 解析如何获取注解对应注解中的值
???? */
??? @SuppressWarnings({ "rawtypes", "unchecked" })
??? public void resolve() {
??????? try {
??????????? // 后去对应的类?www.2cto.com
??????????? Class clazz = Class.forName("annotation.user.AnnotationUser");
??????????? // 判断clazz是否存在FirstAnno.class注解
??????????? if (clazz.isAnnotationPresent(AnnotationType.class)) {
??????????????? // 存在，则获取这个注解
??????????????? AnnotationType annoType = (AnnotationType) clazz.getAnnotation(AnnotationType.class);
??????????????? System.out.println("AnnotationType value： " + annoType.typeValue());
??????????? }
??????????? // 获取该类的所有方法
??????????? Method[] methods = clazz.getDeclaredMethods();
??????????? // 解析方法注解
??????????? for (Method method : methods) {
??????????????? if (method.isAnnotationPresent(AnnotationMethod.class)) {
??????????????????? AnnotationMethod annoMethod = method.getAnnotation(AnnotationMethod.class);
??????????????????? System.out.println("AnnotationMethod value： " + annoMethod.methodValue());
??????????????? }
??????????? }
??????????? // 获取该类的所有属性字段
??????????? Field[] fields = clazz.getDeclaredFields();
??????????? // 解析字段注解
??????????? for (Field field : fields) {
??????????????? if (field.isAnnotationPresent(AnnotationField.class)) {
??????????????????? AnnotationField annoField = field.getAnnotation(AnnotationField.class);
??????????????????? System.out.println("AnnotationField value： " + annoField.fieldValue());
??????????????? }
??????????? }
??????? } catch (SecurityException e) {
??????????? e.printStackTrace();
??????? } catch (ClassNotFoundException e) {
??????????? e.printStackTrace();
??????? }
??? }
??? /**
???? * 解释注解中的值，并且赋值给相关属性或者方法
???? */
??? public void testDoIt() {
??????? try {
??????????? AnnotationUser user = new AnnotationUser();
??????????? Field field = user.getClass().getDeclaredField("userField");
??????????? if (field.isAnnotationPresent(AnnotationField.class)) {
??????????????? AnnotationField annoField = field.getAnnotation(AnnotationField.class);
??????????????? // getDeclaredMethod()返回一个 Method 对象，该对象反映此 Class
??????????????? // 对象所表示的类或接口的指定已声明方法。name 参数是一个
??????????????? // String，它指定所需方法的简称，parameterTypes 参数是 Class 对象的一个数组
??????????????? // Method doIt = user.getClass().getDeclaredMethod("doIt");
??????????????? // 属性必须要由set 或者get 方法，才能调用invoke方法
??????????????? PropertyDescriptor pd = new PropertyDescriptor(field.getName(), AnnotationUser.class);
??????????????? Method doIt = pd.getWriteMethod();
??????????????? if (null != doIt) {
??????????????????? String value = annoField.fieldValue();
??????????????????? doIt.invoke(user, value);
??????????????? }
??????????? }
??????????? user.doIt();
??????? } catch (Exception e) {
??????????? e.printStackTrace();
??????? }
??? }
}
?
相关文章
