Java Annotation(2)

作者：曾巧（numenzq）

 

摘要

在前一篇文章中，已经向你介绍了Annotation的基本概念、作用、Java内置注释等，本文将向你展示在J2SE 5.0或更高版本中Annotation(注释)更强大的一面：自定义注释，开发人员可以根据需求编写特定功能的注释。通过对本文的学习，我们将了解到如何创建注释，使用自定义注释等知识。

 

内容

l         定制注释类型

l         使用定制的注释类型

l         添加变量

l         为变量赋默认值

l         概要

 

定制注释类型

    好的，让我们创建一个自己的注释类型（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

    }

}

 

概要

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