Tiger系列三:Annotation第一部分:使用内置的Annotation

类别:Java 点击:0 评论:0 推荐:

1、引入

l         编程的一个最新趋势,尤其是 Java 编程,就是使用元数据

l         元数据可以用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查

l         许多元数据工具(如 Xdoclet)将这些功能添加到核心 Java 语言中,暂时成为 Java 编程功能的一部分

l         Javadoc是元数据工具,但除了生成文档之外,没有固定、实用、标准化的方式将数据用于其他用途,而且HTML代码经常混入到Javadoc输出中,更进一步降低了其用于任何其它目的的价值

l         JSR 175,Java编程语言的元数据工具,为将元数据合并到核心 Java 语言中提供了正式理由和说明

l         Tiger 增加了Annotation的新功能,将一个更通用的元数据工具合并到核心 Java 语言中

l         Annotation是可以添加到代码中的修饰符,可以用于包声明、类型声明、构造函数、方法、域变量、参数和变量

l         Tiger包含内置的Annotation,还支持自己编写的定制Annotation

l         本部分将概述元数据的优点,并介绍Tiger的内置Annotation

 

2、元数据的价值

一般来说,元数据的好处分为三类:文档编制、编译器检查和代码分析

(1)文档编制

l         代码级文档最常被引用,但对于将元数据添加到 Java 语言中来说,文档编制可能是最不相关的理由

l         因为Javadoc已经提供了非常容易理解和健壮的方法来文档化代码

(2)编译时检查

l         元数据更重要的优点是编译器可以使用它来执行基本的编译时检查

l         具体情况请参看后面介绍的Tiger内置Annotation:@Override

(3)代码分析

l         元数据工具的最好功能就是可以使用额外数据来分析代码

l         简单的案例就是:许多时候,方法的参数类型或返回类型实际上不是该方法想要的类型;例如,参数类型可能是Object,但方法可能仅使用Integer,这在覆盖超类的方法时很容易发生;元数据可以指示代码分析工具:虽然参数类型是 Object,但 Integer 才是真正需要的

l         复杂的案例就是:即使是简单EJB系统中也具有很强的依赖性和复杂性,要具有 Home和Remote接口,以及本地的Home 和Remote接口,以及一个实现类,保持所有这些类同步非常困难;好的工具(如XDoclet)可以管理所有这些依赖性,并确保这些没有“代码级”联系,但有“逻辑级”联系的类保持同步;元数据在这里确实可以发挥它的作用

 

3、Annotation基础

l         Annotation的格式是:@Annotation名

l         在Annotation需要数据时,通过name=value的形式提供

l         代码中可以用很多Annotation,有些Annotation会具有相同的Annotation类型

l         Annotation类型和Annotation的概念类似于类和对象的概念

l         Annotation有三种基本种类:

Ø         标记Annotation:只有Annotation名,不包含数据,如@MarkerAnnotation

Ø         单值Annotation:只有单一的数据,可以简化name=value的形式为value形式,如@SingleValueAnnotation("my data")

Ø         完整格式的Annotation:有多个数据成员,如@FullAnnotation(var1="data value 1", var2="data value 2", var3="data value 3")

l         可以使用花括号向Annotation变量提供值数组,如

@TODOItems({    // Curly braces indicate an array of values is being supplied

  @TODO(

    severity=TODO.CRITICAL,

    item="Add functionality to calculate the mean of the student's grades",

    assignedTo="Brett McLaughlin"

  ),

  @TODO(

    severity=TODO.IMPOTANT,

    item="Print usage message to screen if no command-line flags specified",

    assignedTo="Brett McLaughlin"

  ),

  @TODO(

    severity=TODO.LOW,

    item="Roll a new website page with this class's new features",

    assignedTo="Jason Hunter"

  )

})

 

4、Tiger内置Annotation

(1)@Override

l         @Override只用于方法,指明改方法覆盖超类中的对应方法

l         简单例子:

public class OverrideTester {

 

       public OverrideTester() {

       }

 

       @Override public String toString() {

              return super.toString() + " [Override Tester Implementation]";

       }

 

       @Override public int hashCode() {

              return toString().hashCode();

       }

}

l         @Override可以检查输入错误导致无法覆盖超类方法的问题,例如hashCode()错误的输入为hasCode(),在编译时就会报错:

The method hasCode() of type OverrideTester must override a superclass method

l         这个便捷的小功能将帮助快速捕获打字错误

(2)@Deprecated

l         同样只用于方法,指明该方法不应该再使用了

l         简单例子:

public class DeprecatedClass {

 

       @Deprecated public void doSomething() {

              System.out.println("Deprecated method!");

              // some code

       }

 

       public void doSomethingElse() {

              // This method presumably does what doSomething() does, but better

       }

}

l         单独编译正常通过,如果通过覆盖或调用Deprecated的方法,编译器会给出警告信息

l         注:本人在Eclipse 3.1M4环境中测试,根本不起作用(即使是改了编译参数,why?),在命令行下使用-Xlint:deprecated参数,JAVAC只给出警告信息,编译还是通过的

(3)@SuppressWarnings

l         Tiger的泛型功能使得编译器对类型的安全性进行检查,特别是Java集合,如下面的例子:

       public void nonGenericsMethod() {

              List wordList = new ArrayList(); // no typing information on the List

              wordList.add("foo"); // causes error on list addition

       }

l         编译器会给出下面的警告信息:

Type safety: The method add(Object) belongs to the raw type List. References to generic

 type List<E> should be parameterized

l         这对于Tiger的代码是很有帮助的,但对于JDK1.4及以前版本,不断的收到无关的警告信息是很烦人的

l         可以使用@SuppressWarnings来阻止指定类型的警告信息,如:

       @SuppressWarnings(value = { "unchecked" })

       public void nonGenericsMethod() {

              List wordList = new ArrayList(); // no typing information on the List

              wordList.add("foo"); // causes error on list addition

       }

l         传递给@SuppressWarnings的类型值是一个数组,因此可以同时阻止多种类型的警告信息

l         类型值是由编译器厂商所指定的,所以上面的例子我在Eclipse 3.1M4环境和命令行中测试,都不起作用,大概是类型值没有指定对吧

本文地址:http://com.8s8s.com/it/it11863.htm