`
jinchun1223
  • 浏览: 259478 次
  • 性别: Icon_minigender_1
  • 来自: 厦门
社区版块
存档分类
最新评论

Annotation 介绍

    博客分类:
  • java
阅读更多

Annotation英文单词翻译过来就是注释注解的意思,实际上它干的活也确实如此.我们在使用IDE时经常会看见一些@return,@param等样子的注释,实际上它就是一种annotation.这里估计大家都有一个共识,就是无论annotation怎么使用,它都不会改变程序最终的运行结果,这就是annotaion的特性了.那么annotation具体有什么作用呢?我们又该来怎么使用它呢?
也许大家会注意到,过时的方法往往会带有一条删除线,比如
new Date().toLocaleString();
又或者我们写的一个类如以下片段:
@Override
public String toString(){ return null;}
@Override
public void overrideTest(){ }
实际上,这时IDE会报错或者警告,但实际上这个类拿去编译,甚至运行都会毫无问题.但是它如何知道就错了呢?这就归功于Annotation注解了.编译器此时通过反射来获取这个方法的Annotation,通过Annotation来确认这个方法究竟是干嘛用的.比如注释是Override,那么它就会继续去检查父类是否有这个方法可以让子类来重写.如果没有,那么开发环境就报错.
实际上还有很多类似的用法,生成doc文档就是最常见的用法之一.那么对Annotation有了初步的了解后我们接下来就可以介绍一下Annotation了.

Annotation的作用域
SOURCE代表的是这个Annotation类型的信息只会保留在程序源码里,源码如果经过了编译之后,Annotation的数据就会消失,并不会保留在编译好的.class文件里面。
ClASS的意思是这个Annotation类型的信息保留在程序源码里,同时也会保留在编译好的.class文件里面,在执行的时候,并不会把这一些信息加载到虚拟机(JVM)中去.注意一下,当你没有设定一个Annotation类型的Retention值时,系统默认值是CLASS.
RUNTIME,表示在源码、编译好的.class文件中保留信息,在执行的时候会把这一些信息加载到JVM中去的.
以上三个范围都是在RetentionPolicy枚举中定义好的.
public enum RetentionPolicy {
 SOURCE,
 CLASS,
 RUNTIME
}
但是我们具体申明的时候不是直接使用这个枚举,因为是注释申明,所以只能使用注释的方式,所以jdk又把这个枚举封装成了一个注释@Retention,这个注释源码如下
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
 RetentionPolicy value();
}
那,这里可以看到, Annotation可以自己给自己定义使用的,有点奇怪吧…

Annotation的运作范围
一个annotation不是想在哪用就在哪用的,就好比java中方法必须写到类里面一样,annotation也有自己的定义范围,规定一个annotation在哪些地方可以去使用他.具体的范围有如下几个:
TYPE,
FIELD,
METHOD
PARAMETER
CONSTRUCTOR
LOCAL_VARIABLE
ANNOTATION_TYPE
PACKAGE
这几个名字不言而喻,type:申明的类型,field:字段, method:方法...等等,这里就不一一解释
好无疑问,这里jdk同样包装好了,用的是以一个ElementType枚举类型
public enum ElementType {
 TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
 LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
}
为了annotation使用有包装了一个名为Target的annotation类型.源码如下:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Target {
 ElementType[] value();
}
上面都找到两种annotation都提及一个@Documented,@Documented的目的就是让这一个Annotation类型的信息能够显示在javaAPI说明文档上;没有添加的话,使用javadoc生成API文档的时候就会找不到这一个类型生成的信息.

JDK5自带的几个Annotation:
@Deprecated用于修饰已经过时的方法;
@Override用于修饰此方法覆盖了父类的方法(而非重载);
@SuppressWarnings用于通知java编译器禁止特定的编译警告。

以下介绍关于Annotation的用法语法及使用了:
1。类型声明方式:
通常,应用程序并不是必须定义annotation类型,但是定义annotation类型并非难事。Annotation类型声明于一般的接口声明极为类似,区别只在于它在interface关键字前面使用“@”符号。
annotation类型的每个方法声明定义了一个annotation类型成员,但方法声明不必有参数或者异常声明;方法返回值的类型被限制在以下的范围:primitives、String、Class、enums、annotation和前面类型的数组;方法可以有默认值。

下面是一个简单的annotation类型声明:
清单1:
/**
* Describes the Request-For-Enhancement(RFE) that led
* to the presence of the annotated API element.
*/
public @interface RequestForEnhancement {
int id();
String synopsis();
String engineer() default "[unassigned]";
String date(); default "[unimplemented]";
}

代码中只定义了一个annotation类型RequestForEnhancement。

annotation到底能起什么作用呢?
1,编译工具或其他工具可以根据被附加在代码里的annotation信息自动生成配置文件或文档等外部文件。
比如,sun公司就提供了apt(Annotation Processing Tool)工具,apt工具是一个可以处理annotation的命令行工具,apt提供了在编译期针对源代码级别的解析,并可以在解析时生成新的源代码和其他文件,同时还可以对生成的源代码进行编译。
2,其他程序可以在运行时动态解析将要被执行的程序里的annotation信息,并根据被附加的annotation信息来执行不同的操作。
比如,EJB3规范就比较广泛地使用了annotation特性。比如只要在POJO为class注明@Stateless注释,EJB容器便会根据此annotation把该POJO注册为无状态的Session Bean。EJB3使用了annotation大大地简化了EJB的开发和配置过程。我们会在其他文章里专门介绍EJB Annotation的原理与使用方法,这里不做详述。

本文通过一个简单地例子来说明怎么在运行期动态解析annotation。Apt工具的使用我们会在近期其他文章里对其加以介绍。

比如,我们定义了MyAnnotation3注释:
MyAnnotation3.java

package com.test.annotation;

import java.lang.annotation.Annotation;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation3 {
public String value();
public String[] multiValues();
int number() default 0;
}

上面定义了一个名为MyAnnotation3的注释。

我们再定义一个GetMyAnnotation类,该类使用了MyAnnotation3注释:
GetMyAnnotation.java:

package com.test.annotation.test;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

import javax.ejb.EJB;
import javax.naming.InitialContext;
import javax.naming.NamingException;

import com.test.annotation.MyAnnotation3;

// 为GetMyAnnotation类附加MyAnnotation3 注释
@MyAnnotation3(value = "Class GetMyAnnotation", multiValues = {"1","2"})
public class GetMyAnnotation {
// 为testField1属性附加MyAnnotation3 注释
@MyAnnotation3(value = "call testField1", multiValues={"1"}, number = 1)
private String testField1;

// 为testMethod1方法附加MyAnnotation3 注释
@MyAnnotation3(value = "call testMethod1", multiValues={"1", "2"}, number = 1)
public void testMethod1() {

}

@Deprecated
@MyAnnotation3(value = "call testMethod2", multiValues={"3", "4", "5"})
public void testMethod2() {

}
}

上面的例子GetMyAnnotation非常简单,里面没有任何功能,但是分别为类(class),属性(field),方法(method)申明(附加)了MyAnnotation3 注释。

下面我们用程序TestMyAnnotation3对GetMyAnnotation里MyAnnotation3注释进行解析。

运行时解析annotation
TestMyAnnotation3.java

public class TestMyAnnotation3 {

public static void main(String[] args) {
System.out.println("--Class Annotations--");
if (GetMyAnnotation.class.isAnnotationPresent(MyAnnotation3.class)) {
System.out.println("[GetMyAnnotation].annotation:");
MyAnnotation3 classAnnotation = GetMyAnnotation.class.getAnnotation(MyAnnotation3.class);
printMyAnnotation3(classAnnotation);
}


System.out.println("--Fields Annotations--");
Field [] fields = GetMyAnnotation.class.getDeclaredFields();
for (Field field : fields) {
if (field.isAnnotationPresent(MyAnnotation3.class)) {
System.out.println("[GetMyAnnotation." + field.getName() + "].annotation:");
MyAnnotation3 fieldAnnotation = field.getAnnotation(MyAnnotation3.class);
printMyAnnotation3(fieldAnnotation);
}
}

System.out.println("--Methods Annotations--");
Method[] methods = GetMyAnnotation.class.getDeclaredMethods();
for (Method method : methods) {
System.out.println("[GetMyAnnotation." + method.getName() + "].annotation:");
if (method.isAnnotationPresent(MyAnnotation3.class)) {
MyAnnotation3 methodAnnotation = method.getAnnotation(MyAnnotation3.class);
printMyAnnotation3(methodAnnotation);
}
}
}

private static void printMyAnnotation3(MyAnnotation3 annotation3) {
if (annotation3 == null) {
return;
}

System.out.println("{value=" + annotation3.value());

String multiValues = "";
for (String value: annotation3.multiValues()) {
multiValues += "," + value;
}

System.out.println("multiValues=" + multiValues);

System.out.println("number=" + annotation3.number() + "}");
}
}


输出:

--Class Annotations--
[GetMyAnnotation].annotation:
{value=Class GetMyAnnotation
multiValues=,1,2
number=0}
--Fields Annotations--
[GetMyAnnotation.testField1].annotation:
{value=call testField1
multiValues=,1
number=1}
--Methods Annotations--
[GetMyAnnotation.testMethod1].annotation:
{value=call testMethod1
multiValues=,1,2
number=1}
[GetMyAnnotation.testMethod2].annotation:
{value=call testMethod2
multiValues=,3,4,5
number=0}



JDK1.5以后的版本提供的跟annotation有关的接口:

interface java.lang.reflect.AnnotatedElement {
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();
}

该接口主要用来取得附加在类(class),构造方法(constructor),属性(field),方法(method),包(package)上的annotation信息。

JDK1.5与此有关的几个类都实现了AnnotatedElement接口:

java.lang.reflect.AccessibleObject,
java.lang.reflect.Class,
java.lang.reflect.Constructor,
java.lang.reflect.Field,
java.lang.reflect.Method,
java.lang.reflect.Package

所以可以利用反射(reflection)功能在程序里动态解析附加的annotation信息。


总结:
本文通过举例简单地说明了怎么动态解析annotation,大家可以举一反三,利用Java的annotation特性,完成更复杂功能等。

  • 915.rar (51.8 KB)
  • 下载次数: 1
分享到:
评论

相关推荐

    JDK5.0 Java Annotation 介绍(ppt)

    以下是关于 Java Annotation 的详细介绍: 一、为什么使用 Annotation 1. **减少模板代码**:在开发过程中,有时我们需要重复编写相同的模板代码,例如创建 JAX-RPC Web 服务时。通过 Annotation,我们可以让工具...

    JDK5.0-Java Annotation 介绍

    Java Annotation(注解)是自JDK 5.0开始引入的一种元数据,它提供了一种安全、非侵入式的方式来向编译器、虚拟机或者其他的工具提供关于代码的信息。这种信息可以用来进行编译时检查、运行时处理、代码生成等。注解...

    hibernate中文APIhibernate annotation 中文API

    **Hibernate Annotation介绍:** Hibernate Annotation是Hibernate的扩展,它通过在Java实体类上使用注解来定义数据库表结构和字段映射。例如,@Entity标记一个类为数据库表,@Table指定对应的表名,@Id表示主键,@...

    Annotation详细介绍(大全)

    Annotation是Java语言中的一种元数据,它提供了在代码中附加信息的能力,这些信息可以在编译时或运行时被解析和使用。Annotation的本质是一种特殊类型的注解,它允许开发者向编译器、JVM或者工具提供关于代码的额外...

    精通Java Web整合开发(第2版)

    12.4.3 hibernate中的常用annotation介绍534 12.4.4 一对一关联的annotation注解实现536 12.4.5 多对一单向关联的annotation注解实现538 12.4.6 一对多双向关联的annotation注解实现540 12.4.7 一对多双向自身关联的...

    Annotation注解的介绍和使用

    ### Annotation注解的深入解析与应用 #### 一、Annotation概览 ##### 1.1 何为元数据 元数据,在计算机科学中,是指用于描述数据的数据,它提供了关于数据本身的附加信息,有助于理解、解释和管理数据。在编程...

    用Annotation简化Java程序的开发(PDF)

    #### 二、Annotation技术介绍 **Annotation** 是Sun Microsystems(现已被Oracle收购)在发布JDK 5.0时新增的重要特性之一。这种特性允许开发者在代码中添加元数据,即用来描述其他代码的数据。Annotation可以应用...

    Hibernate Annotation 中文文档

    以上是对Hibernate Annotation的简要介绍,深入理解和熟练应用这些注解,将有助于提升你在Java持久化领域的专业技能。对于更详细的用法和高级特性,建议查阅《Hibernate Annotations参考文档-3.20》这份资料,以获取...

    通过提问ChatGPT来解决枚举和注解等需求问题

    11.13基本的Annotation介绍 11.14基本的Annotation应用案例 11.14.1@Over ide注解的案例 11.14.2@Deprecated注解的案 例 11.14.3@Suppress Warnings 注解的案例 11.15J DK的元Annotation(元注 解,了解)

    annotation 详解

    通过本文的介绍,我们可以看到`Annotation`在Java编程中扮演着非常重要的角色。它不仅有助于提高代码的可读性和维护性,还能够帮助开发者更好地管理代码生命周期中的不同阶段。无论是用于文档化还是编译时检查,`...

    前端开源库-get-annotation

    - `README.md`文件:介绍项目的基本信息、安装和使用方法。 - `LICENSE`文件:声明项目的开源许可协议。 在实际开发中,要使用"get-annotation",首先需要通过npm安装(假设已安装Node.js环境): ```bash npm ...

    hibernate annotation 中文文档

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

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

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

    Spring MVC Annotation验证的方法

    本文将详细介绍 Spring MVC Annotation验证的方法,包括使用 Spring MVC 自带的 Annotation 验证和自定义 Annotation 验证。 一、Spring MVCAnnotation 验证简介 Spring MVC 框架提供了多种Annotation来实现验证,...

    springMVC-annotation注解介绍

    @Resource和@Autowired都是做bean的注入时使用,其实@Resource并不是Spring的注解,它的包是javax.annotation.Resource,需要导入,但是Spring支持该注解的注入。 1、共同点 两者都可以写在字段和setter方法上。两者...

    Java Annotation详解及实例代码

    二、基础Annotation介绍 1. @Override `@Override` 注解用于标识一个方法是重写父类的方法。使用这个注解可以确保子类确实覆盖了父类的方法,避免因方法签名不匹配而导致的意外。它只能应用于方法,不能用于类或...

    hibernate-annotation 所需要的jar包

    下面将详细介绍Hibernate-Annotation所涉及到的知识点。 1. **Hibernate框架**: Hibernate是Java领域中最流行的ORM框架之一,它提供了一种在Java应用程序中管理和访问关系数据库的方法。通过ORM,Java对象可以直接...

    注解annotation的详细介绍

    注解(Annotation)是Java语言中的一个重要特性,自JDK5开始引入,它提供了一种安全的方式,使得程序员可以向源代码中添加元数据(metadata)。元数据是关于数据的数据,它并不改变程序运行方式,但可以被编译器、...

Global site tag (gtag.js) - Google Analytics