`
wangmengbk
  • 浏览: 292347 次
  • 性别: Icon_minigender_1
  • 来自: 上海
社区版块
存档分类
最新评论

Annotation:基础介绍

    博客分类:
  • J2EE
阅读更多
在5.0版之前的Java平台已经具有了一些ad hoc annotation机制。比如,使用transient修饰符来标
识一个成员变量在序列化子系统中应被忽略。而@deprecated这个javadoc tag也是一个ad hoc

annotation用来说明一个方法已过时。从Java5.0版发布以来,5.0平台提供了一个正式的annotation功

能:允许开发者定义、使用自己的annoatation类型。此功能由一个定义annotation类型的语法和一个描

述annotation声明的语法,读取annotaion的API,一个使用annotation修饰的class文件,一个 annotation处理工具(apt)组成.
    在JAVA应用中,我们常遇到一些需要使用模版代码。例如,为了编写一个JAX-RPC web service,我

们必须提供一对接口和实现作为模版代码。如果使用annotation对远程访问的方法代码进行修饰的话,

这个模版就能够使用工具自动生成。

 另外,一些API需要使用与程序代码同时维护的附属文件。例如,JavaBeans需要一个BeanInfo Class

与一个Bean同时使用/维护,而EJB则同样需要一个部署描述符。此时在程序中使用annotation来维护这

些附属文件的信息将十分便利而且减少了错误
    annotation并不直接影响代码语义,但是它能够工作的方式被看作类似程序的工具或者类库,它会

反过来对正在运行的程序语义有所影响。annotation可以从源文件、class文件或者以在运行时反射的多

种方式被读取。
 当然annotation在某种程度上使javadoc tag更加完整。一般情况下,如果这个标记对java文档产生影

响或者用于生成java文档的话,它应该作为一个javadoc tag;否则将作为一个annotation.
Annotation的使用方法:
   1.类型声明方式:

 通常,应用程序并不是必须定义annotation类型,但是定义annotation类型并非难事。Annotation类

型声明于一般的接口声明极为类似,区别只在于它在interface关键字前面使用"@"符号。

 annotation类型的每个方法声明定义了一个annotation类型成员,但方法声明不必有参数或者异常声

明;方法返回值的类型被限制在以下的范围:primitives、String、Class、enums、annotation和前面

类型的数组;方法可以有默认值。
   下面是一个简单的annotation类型声明:

 清单1:
    public @interface RequestForEnhancement {
        int    id();
        String synopsis();
        String engineer() default "[unassigned]";
        String date();    default "[unimplemented]";
    }

 代码中只定义了一个annotation类型RequestForEnhancement.
    2.修饰方法的annotation声明方式:

 annotation是一种修饰符,能够如其它修饰符(如public、static、final)一般使用。习惯用法是

annotaions用在其它的修饰符前面。annotations由"@+annotation类型+带有括号的成员-值列表"组成。

这些成员的值必须是编译时常量(即在运行时不变)。

 A:下面是一个使用了RequestForEnhancement annotation的方法声明:

 清单2:
    @RequestForEnhancement(
        id       = 2868724,
        synopsis = "Enable time-travel",
        engineer = "Mr. Peabody",
        date     = "4/1/3007"
    )
    public static void travelThroughTime(Date destination) { ... }

 B:当声明一个没有成员的annotation类型声明时,可使用以下方式:

清单3:


    public @interface Preliminary { }

 
 作为上面没有成员的annotation类型声明的简写方式:



 清单4:

    @Preliminary public class TimeTravel { ... }


 C:如果在annotations中只有唯一一个成员,则该成员应命名为value:

 

 清单5:
    public @interface Copyright {
        String value();
    }


 更为方便的是对于具有唯一成员且成员名为value的annotation(如上文),在其使用时可以忽略掉成

员名和赋值号(=):

 清单6:

    @Copyright("2002 Yoyodyne Propulsion Systems")
    public class OscillationOverthruster { ... }

3.一个使用实例:

 结合上面所讲的,我们在这里建立一个简单的基于annotation测试框架。首先我们需要一个

annotation类型来表示某个方法是一个应该被测试工具运行的测试方法。



 清单7:

    import java.lang.annotation.*;
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface Test { }


 值得注意的是annotaion类型声明是可以标注自己的,这样的annotation被称为“meta-annotations”



 在上面的代码中,@Retention(RetentionPolicy.RUNTIME)这个meta-annotation表示了此类型的

annotation将被虚拟机保留使其能够在运行时通过反射被读取。而@Target(ElementType.METHOD)表示

此类型的annotation只能用于修饰方法声明。



 下面是一个简单的程序,其中部分方法被上面的annotation所标注:



 清单8:

    public class Foo {
        @Test public static void m1() { }
        public static void m2() { }
        @Test public static void m3() {
            throw new RuntimeException("Boom");
        }
        public static void m4() { }
        @Test public static void m5() { }
        public static void m6() { }
        @Test public static void m7() {
            throw new RuntimeException("Crash");
        }
        public static void m8() { }
    }



测试类:

    import java.lang.reflect.*;

    public class RunTests {
       public static void main(String[] args) throws Exception {
          int passed = 0, failed = 0;
          for (Method m : Class.forName(args[0]).getMethods()) {
             if (m.isAnnotationPresent(Test.class)) {
                try {
                   m.invoke(null);
                   passed++;
                } catch (Throwable ex) {
                   System.out.printf("Test %s failed: %s %n", m, ex.getCause());
                   failed++;
                }
             }
          }
          System.out.printf("Passed: %d, Failed %d%n", passed, failed);
       }
    }


 这个程序从命令行参数中取出类名,并且遍历此类的所有方法,尝试调用其中被上面的测试

annotation类型标注过的方法。在此过程中为了找出哪些方法被annotation类型标注过,需要使用反射

的方式执行此查询。如果在调用方法时抛出异常,此方法被认为已经失败,并打印一个失败报告。最后

,打印运行通过/失败的方法数量。



 下面文字表示了如何运行这个基于annotation的测试结果:



 清单9:

    $ java RunTests Foo
    Test public static void Foo.m3() failed: java.lang.RuntimeException: Boom
    Test public static void Foo.m7() failed: java.lang.RuntimeException: Crash
    Passed: 2, Failed 2

Annotation分类:
根据annotation的使用方法和用途主要分为以下几类:



 1.内建Annotation——Java5.0版在java语法中经常用到的内建Annotation:



 @Deprecated用于修饰已经过时的方法;



 @Override用于修饰此方法覆盖了父类的方法(而非重载);



 @SuppressWarnings用于通知java编译器禁止特定的编译警告。



 2.开发者自定义Annotation:由开发者自定义Annotation类型。



 下面是一个使用annotation进行方法测试的sample:



 AnnotationDefineForTestFunction类型定义如下:



 清单11:



package com.bjinfotech.practice.annotation;

import java.lang.annotation.*;
//加载在VM中,在运行时进行映射
@Retention(RetentionPolicy.RUNTIME)
//限定此annotation只能标示方法
@Target(ElementType.METHOD)
public @interface AnnotationDefineForTestFunction{}


 测试annotation的代码如下:



 清单12:





package com.bjinfotech.practice.annotation;

import java.lang.reflect.*;


public class UsingAnnotation {
        @AnnotationDefineForTestFunction public static void method01(){}
      
        public static void method02(){}
      
        @AnnotationDefineForTestFunction public static void method03(){
                throw new RuntimeException("method03");
        }
      
        public static void method04(){
                throw new RuntimeException("method04");
        }
      
        public static void main(String[] argv) throws Exception{
                int passed = 0, failed = 0;
                //被检测的类名
                String className="com.bjinfotech.practice.annotation.UsingAnnotation";
                //逐个检查此类的方法,当其方法使用annotation声明时调用此方法
            for (Method m : Class.forName(className).getMethods()) {
               if (m.isAnnotationPresent(AnnotationDefineForTestFunction.class)) {
                  try {
                     m.invoke(null);
                     passed++;
                  } catch (Throwable ex) {
                     System.out.printf("测试 %s 失败: %s %n", m, ex.getCause());
                     failed++;
                  }
               }
            }
            System.out.printf("测试结果:通过: %d, 失败: %d%n", passed, failed);
        }
}


 3.使用第三方开发的Annotation类型


 这也是开发人员所常常用到的一种方式。比如我们在使用Hibernate3.0时就可以利用Annotation生成

数据表映射配置文件,而不必使用Xdoclet.


结论:


 1.前面的文字说明了annotation的使用方法、定义方式、分类。初学者可以通过以上的说明制作简单

的annotation程序,但是对于一些高级的annotation应用(例如使用自定义annotation生成javabean映

射xml文件)还需要进一步的研究和探讨。


 2.同时,annotation运行存在两种方式:运行时、编译时。上文中讨论的都是在运行时的annotation

应用,但在编译时的annotation应用还没有涉及,因为编译时的annotation要使用annotation

processing tool.

分享到:
评论

相关推荐

    JAVA核心技术第1卷:基础知识(原书第8版)--英文书和源代码

    《JAVA核心技术第1卷:基础知识(原书第8版)》是Java编程领域的经典教材,专为初学者设计,旨在全面、深入地介绍Java编程语言的基础概念和技术。这本书覆盖了从基本语法到面向对象编程的核心内容,对于想要踏入Java...

    ted-talks-annotation:TED演讲中的张力发展注解-开源

    1. **README.md** - 这是项目的自述文件,详细介绍了项目背景、安装步骤、使用方法以及相关的数据集和资源。通过阅读此文件,用户可以快速上手,了解如何利用这个工具进行注解和分析。 2. **data** - 这个目录存储...

    java2核心技术 卷1:基础知识

    13. **注解(Annotation)**:介绍注解的基本用法,自定义注解以及注解处理器。 14. **枚举类型(Enum)**:讲解枚举类型的定义和使用,以及枚举在多线程和集合框架中的特殊应用。 15. **反射机制**:通过反射,...

    young-ssm-annotation:ssm基本环境(spring boot+spring mvc+mybatis)

    在"young-ssm-annotation"项目中,Spring Boot作为基础框架,负责启动和管理整个应用生命周期。 【Spring MVC】 Spring MVC是Spring框架的一部分,用于构建Web应用。它提供了模型-视图-控制器(MVC)架构模式,将...

    hibernate annotation 中文文档

    《Hibernate Annotation 中文文档》是Java开发者们的重要参考资料,它详细介绍了如何在Hibernate框架中使用注解进行对象关系映射(ORM)。Hibernate是一款强大的开源Java持久化框架,它简化了数据库与Java对象之间的...

    前端项目-chartjs-plugin-annotation.zip

    ### chartjs-plugin-annotation插件介绍 `chartjs-plugin-annotation`是Chart.js的一个扩展,它允许开发者在图表上添加各种类型的注释,以增强图表的信息传递能力。这些注释可以是线性、曲线、文本、框选等,有助于...

    point-cloud-annotation-tool win10解压直接运行

    1. 点云标注工具介绍: 点云标注工具是专门用于标记和分类点云数据的软件,它可以辅助用户为点云数据添加各种元信息,如边界框、类别标签等。这在机器学习和深度学习项目中极其关键,因为准确的标注数据是训练模型...

    Hibernate Annotation 学习笔记

    本文将通过一个实际操作的实例,逐步介绍Hibernate Annotation的基础知识。 一、开始实践 1. 项目准备:首先,我们需要准备JDK 5.0或更高版本,以及Hibernate 3.2.2.ga、hibernate-annotations-3.2.1.GA和ejb3-...

    iOS地图显示、定位、大头针、气泡等简单使用

    本篇文章将详细介绍如何在iOS应用中使用这些功能。 首先,我们需要导入MapKit框架,这可以通过在Swift文件顶部添加`import MapKit`来实现。MapKit框架包含了展示地图、获取用户位置以及处理地图交互的关键类。 1. ...

    Java注解学习1-Java Annotation认知(包括框架图、详细介绍、示例说明)

    本文将详细介绍Java Annotation的基本概念、语法和用法,以及它们的框架结构。 首先,了解Annotation的架构至关重要。一个Annotation与一个RetentionPolicy相关联,这意味着每个Annotation实例都有一个特定的保留...

    Hibernate_Annotation参考文档

    本文档主要介绍Hibernate_Annotation的使用方法及其在Java持久化框架中的应用。该文档重点介绍了`javax.persistence`包下的注解,这些注解是实现对象关系映射(ORM)的核心。 #### 二、Hibernate_Annotation核心...

    hibernate annotation学习文档

    ### Hibernate Annotation 学习知识点详解 #### 一、概述 Hibernate 是一款开源的对象关系映射 (ORM) 巨具,它极大地简化了 Java 应用程序与数据库...对于初学者而言,掌握这些基础注解是学习 Hibernate 的关键一步。

    Java2核心技术第6版卷1基础知识.rar

    13. **注解(Annotation)**:注解是元数据的一种形式,提供了一种安全地向编译器和JVM提供信息的方式,可以用于编译时检查或运行时处理。 14. **反射(Reflection)**:Java反射机制允许在运行时动态地获取类的信息并...

    annotation hibernate struts spring springsecurity API中英文均有

    - **Hibernate+Annotation+文档.pdf**:详细介绍了如何使用Hibernate的注解进行对象关系映射。 这些资源可以帮助开发者快速理解和掌握这些框架,提高开发效率。同时,"spring注解的学习.pdf"这样的文档可能包含了...

    propbank annotation guideline1

    ### PropBank Annotation Guideline #### 一、PropBank简介 PropBank是一种用于自然语言处理(NLP)领域的语义知识库标注工具。它主要用于构建动词框架(verb frames),这些框架能够帮助理解句子中动作的发生方式...

    Java基础教程之理解Annotation详细介绍

    【Java Annotation详解】 Java Annotation(注解)是自Java 5开始引入的一种元数据机制,它允许程序员在源代码的各个层次(如类、方法、变量等)添加额外的信息,这些信息可以被编译器、IDE或其他工具读取,以实现...

    Annotation Based Spring MVC Basics

    接下来,我们将逐步介绍如何创建一个注解驱动的Spring MVC Web应用。 第一步涉及更新`web.xml`文件,这是所有Web应用程序的核心配置文件。我们需要添加一个名为`spring-mvc`的Servlet定义,使用`org.spring...

Global site tag (gtag.js) - Google Analytics