JAVA元数据注释初探-优快云博客

本文介绍JAVA元数据注释的基本概念与使用方法，包括自定义注释类型的定义及如何通过反射机制获取注释信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

JAVA元数据注释初探

JAVA的元数据功能是JDK1.5才开始支持的,以前都没有,正因为是新支持的,所以有关于它的介绍挺少,用处也不太多,最近发现很多框架都可以把它用来配置一些东西,以代替以前比较复杂的XML配置.想像一下,在JAVA代码中直接写入注释来配置,那该是多么好的事情,让我们写习惯了代码和看习惯了代码的人来说,这无疑是一件很爽的事情.

　　我们可以使用JAVA内置的注释内型,如果觉得不够用,可以定义自己的注释内型,定义如下

　　/*

　　* MyType.java

　　*

　　* Created on 2006年12月7日, 下午3:40

　　*

　　* To change this template, choose Tools 　 Template Manager

　　* and open the template in the editor.

　　*/

　　package testAnno;

　　/**

　　*

　　* @author lbf

　　*/

　　import java.lang.annotation.*;

　　@Retention(RetentionPolicy.RUNTIME)

　　@Target()

　　public @interface MyType {

　　String authorName();

　　String lastModified();

　　String bugFixes() default "ok";

　　}

　　这里我定义了一个我自己的注释类,声明方式和声明接口差不多,只不过在interface前面多了一个@符号.

　　注释类也可以用注释类注释,如此下去.

　　@Retention(RetentionPolicy.RUNTIME)

　　这句表示它的保存范围是到RUNTIME,也就是运行时,这样在类运行的时候,我们也可以取到有关它的信息.

　　@Target()

　　这句表示它的适用对象,它可以用在哪里地方,我这里定义的是它可以用在类的定义和方法的定义上

　　然后我们看我们是怎么为我们写的类加上注释的

　　/*

　　* Test1.java

　　*

　　* Created on 2006年12月7日, 下午3:34

　　*

　　* To change this template, choose Tools 　 Template Manager

　　* and open the template in the editor.

　　*/

　　package testAnno;

　　/**

　　*

　　* @author lbf

　　*/

　　import java.lang.annotation.*;

　　@MyType(authorName="hadeslee",lastModified="20061207")

　　public class Test1 {

　　/** Creates a new instance of Test1 */

　　public Test1() {

　　}

　　@Deprecated

　　@MyType(authorName="hadeslee",lastModified="20061207",bugFixes="what")

　　public void doSth(){

　　}

　　@MyType(authorName="hadeslee",lastModified="20061207",bugFixes="what")

　　public void doAnother(){

　　}

　　}

　　加了元数据的类和不加元数据的类差不多,只不过如果你的元数据注释如果是运行时的话,你的类文件可能会比不加元数据大一些,因为它必须把一些注释的信息写入到class文件中去,我们已经注释了我们的类,现在我们来看一下,我们如何去取我们的注释,

　　/*

　　* GetAnno.java

　　*

　　* Created on 2006年12月7日, 下午3:46

　　*

　　* To change this template, choose Tools 　 Template Manager

　　* and open the template in the editor.

　　*/

　　package testAnno;

　　/**

　　*

　　* @author lbf

　　*/

　　import java.lang.annotation.*;

　　import java.lang.reflect.*;

　　public class GetAnno {

　　/** Creates a new instance of GetAnno */

　　public GetAnno() {

　　}

　　public static void main(String[] args)throws Exception {

　　Test1 t=new Test1();

　　Class c=Test1.class ;

　　Annotation[] as= c.getDeclaredAnnotations();

　　for(Annotation an:as){

　　System.out.println("类Test1的注释"+an);

　　}

　　Method med=c.getDeclaredMethod("doSth");

　　Annotation[] ass=med.getDeclaredAnnotations();

　　for(Annotation an:ass){

　　Class＜!--/sp--＞extends Annotation＞ clazz=an.annotationType();

　　Annotation[] ased=clazz.getAnnotations();

　　for(Annotation ad:ased){

　　System.out.println("注释的注释:"+ad);

　　}

　　System.out.println("方法doSth的注释："+an);

　　}

　　}

　　}

　　此程序输出如下

　　类Test1的注释@testAnno.MyType(bugFixes=ok, authorName=hadeslee, lastModified=20061207)

　　注释的注释:@java.lang.annotation.Documented()

　　注释的注释:@java.lang.annotation.Retention(value=RUNTIME)

　　方法doSth的注释：@java.lang.Deprecated()

　　注释的注释:@java.lang.annotation.Retention(value=RUNTIME)

　　注释的注释:@java.lang.annotation.Target(value=[TYPE, METHOD])

　　方法doSth的注释：@testAnno.MyType(bugFixes=what, authorName=hadeslee, lastModified=20061207)

　　从这代码里,我们可以看出,取注释其实很简单,就是利用反射机制来取的.不过我们要特别注意到的一点是,我们不但可以取我们定义的类的注释,也可以取注释的注释,我们这里只取到了MyType的注释,其实还可以往下取,在取的过程中,我们可以看到这些元数据注释类都用了哪些注释。

Metadata，元数据，是Tiger重要的改进之一，也叫注释（Annotate），这个改进的前身，有大家熟悉的JavaDoc。

作为重要的改进，不少开发组织已经越来越多的开始使用元数据，如EJB3中将大力采用元数据。元数据作为附加数据或注释，可以被javac编译器或其他工具读取，并根据不同的属性指定，可以选择被保存在类文件中，也可以保存到运行时，并通过Java的反射机制提供调用，从而提供了广阔的使用空间，相信今后的Java开发中大家少不了要熟练掌握和使用它。

元数据，定义是数据的数据，比如做数据挖掘时，依据原始的数据提取出的供上层管理人员查看和分析的数据（上层管理人员更关注他们关注的数据，而不是基础业务数据），上述所提的原始数据就叫元数据。

元数据有3类作用：文档编制、编译器检查和代码分析。

先简单介绍3个Tiger内置的元数据：
Override、Deprecated和SuppressWarnings。

注释的使用通过"@"+注释名称的方式，@为我们熟悉的at标记，如果注释后面有参数，则使用paraName = paraValue的方式，类似方法的调用。

1）Override:
声明Override父类的方法，如果父类无此方法将提示错误，可以避免错误：

@Override
public String toString() {
return super.toString();
}

表示Override toString方法，如果把toString改为ToString，则编译会报错误表示必须Override父类的方法。

2）Deprecated：
用于对不应再使用的方法进行注释，如果覆盖或调用声明为Deprecated的方法，编译器将提示警告。
Deprecated的使用比较特殊，必须放在方法前：

@Deprecated public doSomething() {
... ...
}

3）SuppressWarnings:
是Tiger的所有新功能的副功能，如我们在使用5.0的jdk编写jdk1.4.x和以前版本jdk的应用时，会发现常使用的方法在编译时会报出一大堆的警告，如：List testList = new ArrayList(); 会警告没有定义类型，不是类型安全的代码，此时需要在含此定义的方法里，使用该 SupperssWarnings:

@SuppressWarings(value={"unchecked"})
public void test() {
List testList = new ArrayList();
testList.add("test");
}

以上是内置的注释，接下来看看怎么定义自己的注释类型，这才是最可以扩展和值得关注的部分：

定义一个注释类型：

package javayou.demo.j2se5;
import java.lang.annotation.*;

/**
* 注释的保持特性，
* 此处定义注释类型AuthorDetail将保留至JVM装载，供JVM读取
*/
@Retention(RetentionPolicy.RUNTIME)

/*
* 定义元注释，即允许何种程序元素具有定义的注释类型，
* 避免在其他地方误用此注释
*/
@Target(ElementType.METHOD)

/**
* 定义一个注释类型，需要在interface前加：@
*/
public @interface AuthorDetail {
        //定义有3个属性
        String name();
        String email();
        String callExtension();
}

使用例子：

package javayou.demo.j2se5;
import java.lang.annotation.Annotation;

public class MetadataDemo {
    @AuthorDetail(name="Liang.xf",
        email="javayou@gmail.com", callExtension="351")
    public void demo() {
        System.out.println("MetadataDemo方法调用");
    }
    public static void main(String[] args) {
        MetadataDemo metadata = new MetadataDemo();
        try {
            Annotation[] annotation = metadata.getClass(
                ).getMethod("demo").getAnnotations();
            for (Annotation a : annotation) {
                System.out.println("作者: "+
                    ((AuthorDetail) a).name());
                System.out.println("邮箱: "+
                    ((AuthorDetail) a).email());
                System.out.println("分机: "+
                    ((AuthorDetail) a).callExtension());
            }
            System.out.println("--------------");
            metadata.demo();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

输出:

作者: Liang.xf
邮箱: javayou@gmail.com
分机: 351
--------------
MetadataDemo方法调用

注释类型的定义：创建一个interface，在interface前加上符号：@
注释类型的定义里，使用了@Retention，它是一种对注释类型的注释，共有4种预定义的注释类型（称为元注释），分别为Retention、Target、Documented和Inherited，它们的含义如下：

1）Target
定义允许何种程序元素可以具有此处定义的注释类型，它的值引用了ElementType的枚举类型，ElementType：

package java.lang.annotation;
public enum ElementType {
TYPE,        // Class, interface, or enum (but not annotation)
FIELD,                 // Field (including enumerated values)
METHOD,             // Method (does not include constructors)
PARAMETER,        // Method parameter
CONSTRUCTOR,    // Constructor
LOCAL_VARIABLE,    // Local variable or catch clause
ANNOTATION_TYPE, // Annotation Types (meta-annotations)
PACKAGE                // Java package
}

2）Retention
定义注释类型的保存方式，值引用了枚举类型RetentionPolicy的值，

package java.lang.annotation;
public enum RetentionPolicy {
SOURCE,       // Annotation is discarded by the compiler
CLASS,         // Annotation is stored in the class file, but ignored by the VM
RUNTIME       // Annotation is stored in the class file and read by the VM
}

3）Documented：
Documented 表示注释应该出现在类的Javadoc中，而默认情况下，注释不包括在 Javadoc 中。

4）Inherited：
表示定义的注释类型将具备继承属性，使用该注释类型的类被继承时，其子类仍具备父类的注释。

元数据比较复杂，而且应用面比较广，在实际开发和应用中摸索和引入是最好的，这里没有举出实际应用案例，只是介绍了其简单的用法，具体的案例在以后的实际应用经验中给予提供。