注释基础知识
在J2SE 5.0 中,注释是以‘@ 注释名’在代码中存在的,例如:J2SE 5.0 内置的注释:@Override 、@Deprecated ;有的注释还可以添加一些参数值,例如:@SuppressWarnings (value="unchecked") ;对于这种只有一个参数,且参数名为value 的注释,我们在使用时可以简写为: @SuppressWarnings ("unchecked") 。
根据注释参数的个数,我们可以将注释分为:标记注释、单值注释、完整注释三类。它们都不会直接影响到程序的语义,只是作为注释(标识)存在,我们可以通过反射机制编程实现对这些元数据的访问。另外,你可以在编译时选择代码里的注释是否只存在于源代码级,或者它也能在class 文件中出现。

元数据的作用
如果要对于元数据的作用进行分类,目前还没有明确的定义,不过我们可以根据它所起的作用,大致可分为三类:
l 编写文档:通过代码里标识的元数据生成文档。
l 代码分析:通过代码里标识的元数据对代码进行分析。
l 编译检查:通过代码里标识的元数据让编译器能实现基本的编译检查。

基本内置注释
@Override 注释能实现编译时检查,你可以为你的方法添加该注释,以声明该方法是用于覆盖父类中的方法。如果该方法不是覆盖父类的方法,将会在编译时报错。例如我们为某类重写toString() 方法却写成了tostring() ,并且我们为该方法添加了@Override 注释;代码如下:

package com.gelc.annotation.demo.basic; 


public class OverrideDemo { 


 // @Override 

 public String tostring() { 


 return super.toString(); 

 } 

}


定制注释类型
好的,让我们创建一个自己的注释类型(annotation type )吧。它类似于新创建一个接口类文件,但为了区分,我们需要将它声明为@interface, 如下例:

public @interface NewAnnotation { 


}



使用定制的注释类型
我们已经成功地创建好一个注释类型NewAnnotation ,现在让我们来尝试使用它吧,如果你还记得本文的第一部分,那你应该知道他是一个标记注释,使用也很容易,如下例:

public class AnnotationTest { 


 @NewAnnotation 

 public static void main(String[] args) { 


 } 

}



添加变量
J2SE 5.0 里,我们了解到内置注释 @SuppressWarnings() 是可以使用参数的,那么自定义注释能不能定义参数个数和类型呢?答案是当然可以,但参数类型只允许为基本类型、String 、Class 、枚举类型等,并且参数不能为空。我们来扩展NewAnnotation ,为之添加一个String 类型的参数,示例代码如下:

public @interface NewAnnotation { 


 String value(); 

}


使用该注释的代码如下:正如你所看到的,该注释的使用有两种写法,这也是在之前的文章里所提到过的。如果你忘了这是怎么回事,那就再去翻翻吧。

public class AnnotationTest { 


 @NewAnnotation("Just a Test.") 

 public static void main(String[] args) { 

 sayHello(); 

 } 


 @NewAnnotation(value="Hello NUMEN.") 

 public static void sayHello() { 

 // do something 

 }


}

为变量赋默认值
我们对Java 自定义注释的了解正在不断的增多,不过我们还需要更过,在该条目里我们将了解到如何为变量设置默认值,我们再对NewAnnotaion 进行修改,看看它会变成什么样子,不仅参数多了几个,连类名也变了。但还是很容易理解的,我们先定义一个枚举类型,然后将参数设置为该枚举类型,并赋予默认值。

public @interface Greeting { 


 public enum FontColor {RED, GREEN, BLUE}; 


 String name(); 


 String content(); 


 FontColor fontColor() default FontColor.BLUE; 

}


我们还是来看看如何使用吧,这里有两种选择,其实变数也就是在赋予默认值的参数上,我们可以选择使用该默认值,也可以重新设置一个值来替换默认值,如下例:

public class AnnotationTest { 


 @NewAnnotation("Just a Test.") 

 public static void main(String[] args) { 


 sayHello(); 

 sayHelloWithDefaultFontColor(); 

 sayHelloWithRedFontColor(); 

 } 


 @NewAnnotation("Hello NUMEN.") 

 public static void sayHello() { 


 } 


 @Greeting(name="NUMEN", content="Hello") 

 public static void sayHelloWithDefaultFontColor() { 

 // do something 

 } 


 @Greeting(name="NUMEN", content="Hello", fontColor=Greeting.FontColor.RED ) 

 public static void sayHelloWithRedFontColor() { 

 // do something 

 } 

}



概要
通过对本文的学习,你应该了解和掌握到如何定制注释和使用注释,这样会在一定程度上辅助我们的开发。在下一篇文章中,我们会学习元注释。

读取注释信息
当我们想读取某个注释信息时,我们是在运行时通过反射来实现的,如果你对元注释还有点印象,那你应该记得我们需要将保持性策略设置为RUNTIME ,也就是说只有注释标记了@Retention(RetentionPolicy.RUNTIME) 的,我们才能通过反射来获得相关信息,下面的例子我们将沿用前面几篇文章中出现的代码,并实现读取AnnotationTest 类所有方法标记的注释并打印到控制台。好了,我们来看看是如何实现的吧: