`

Java Annotation注释语法(三)

阅读更多
这样说来,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特性,完成更复杂功能等。    
分享到:
评论

相关推荐

    Java Annotation

    #### 二、Java Annotation 的基本语法与类型 - **声明注解**:使用 `@interface` 关键字来声明一个注解。 ```java public @interface MyAnnotation { String value() default ""; } ``` - **使用注解**:通过 ...

    javaAnnotation.pdf

    而Annotation是一种特殊的注释,它的语法以`@`符号开头,后跟注释的名字。例如,`@Override`和`@Deprecated`是Java内置的两种注释。对于带有参数的注释,如`@SuppressWarnings("unchecked")`,可以省略参数名`value`...

    重难点之JavaAnnotation手册.pdf

    在《Java Annotation入门》之后的这篇《重难点之JavaAnnotation手册》中,作者深入探讨了Annotation的概念、定义以及其在Java开发中的应用。 一、Annotation是什么? Annotation是一种在代码中添加的特殊注解,用于...

    Java_Annotation详解

    Java提供了几种常用的内置注释,每种都有其特定用途,下面详细介绍三种典型的内置注释: - **@Override**:用于明确表示当前方法是覆盖父类中的同名方法。此注释有助于编译器在遇到方法签名改变时及时给出错误提示...

    Java 注释编码

    Java 注释编码的知识点涵盖了Java注解(Annotations)的基本概念、语法、使用场景以及与Java SE 8的变化。注解是Java SE 5引入的一个特性,用于为Java代码提供元数据。这些元数据可以被编译器读取,也可以用于运行时...

    JDK1.5 注释语法(Annotations)新鲜试用

    总结来说,JDK 1.5的注释语法为Java开发者提供了更强大的工具,用于添加额外的元数据,提高了代码的可读性,简化了代码维护和扩展。无论是自定义注解还是使用已有的标准注解,它们都在构建更健壮、更易于维护的系统...

    graphql-java-annotations:Java的GraphQL注释

    该库为GraphQL模式定义提供了基于注释的语法。 如果您想使用使用graphql-java-annotations创建graphql spring引导服务器的工具,则可以查看库。 目录 入门 (Gradle语法) dependencies { compile " io.github....

    java高手真经 光盘源码

    java高手真经 全光盘源代码 打包rar 第1部分(2个程序包) HelloWorld.zip 01.Java入门样例HelloWorld demo.zip 03.Eclipse入门样例...javaannotation.zip 28.Java注释符编程 javafeature.zip 29.Java5.0语言新特性

    Java高手真经(编程基础卷)光盘全部源码 免积分

    看到那些要积分的很不酸,发布免费版本。 第1部分(2个程序包) HelloWorld.zip 01.Java入门样例HelloWorld demo.zip 03.Eclipse入门...javaannotation.zip 28.Java注释符编程 javafeature.zip 29.Java5.0语言新特性

    Java高手真经(编程基础卷)光盘全部源码

    看到很多人都分卷打包的,下载很是不方便,还浪费积分,我就整合压缩打包到一个包里面,里面包含全部源码 源码目录如下: ...javaannotation.zip 28.Java注释符编程 javafeature.zip 29.Java5.0语言新特性

    java源代码中文注释.zip

    1. **基础语法**:Java的基础包括变量、数据类型(如整型、浮点型、字符型和布尔型)、运算符(算术、比较、逻辑和位运算符)、流程控制(if-else、switch、for、while循环)以及方法定义。 2. **类与对象**:面向...

    Annotation

    ### Annotation在Java中的深入解析与应用 #### 一、Annotation概览 Annotation,中文译为“注解”,是Java 5引入的一种元数据机制,用于向编译器或运行时环境提供额外的信息。注解本质上是一种特殊的注释,但它比...

    java自定义注解实现由类自动生成表

    在Java编程中,自定义注解(Annotation)是一种强大的元数据机制,允许程序员在源代码中插入信息,这些信息可以被编译器、IDE或运行时环境用来进行各种处理。自定义注解使得代码更加可读,易于维护,并且可以自动化...

    注释java源码-tic303-annotation:托管在Github.io上的注释网站,用于注释JavaTP解决方案源代码

    综上所述,"注释java源码-tic303-annotation"项目专注于注解在Java源代码中的应用,旨在提升代码的可读性和理解性,同时也可能利用注解进行元编程操作,例如通过自定义注解和注解处理器增强JavaTP的开发体验。

    java初学者完整代码+注释2

    这个“java初学者完整代码+注释2”压缩包提供了21课的学习内容,涵盖了Java的基础知识,包括语法、数据类型、控制结构、类与对象等关键概念。 在Java的世界里,初学者首先会接触到的是基础语法。Java是一种强类型...

    \java超强笔记(超级经典)

    四种元注释:java.lang.annotation中的类 元注释:注释注释的注释,用来限定注释的特征 @Terget 用来限定某个注释的使用范围,可以对什么元素进行注释 @Retention 用来描述注释的有效范围 @Inherited ...

    java高级特性,涵盖了多种java常用的一些例子

    Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 Java 语言中的类、方法、变量、参数和包等都可以被标注。Java标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节...

Global site tag (gtag.js) - Google Analytics