Java自定义Annotation方法

1. 基本语法

Java代码

import java.lang.annotation.ElementType;  
import java.lang.annotation.Target;  
// The @Bind tag.  
@Target(ElementType.METHOD)  
@Retention(RetentionPolicy.RUNTIME)  
public @interface Bind {  
    public String name();  
    public int time() default 0;  
}

以上是一个用于Method级的简单的@Bind注解类,比较有点象接口的结构,事实上,与其它任何Java接口一样,注解也将会编译成class文件。

 /** 
 * Use the @Bind tag. 
 */  
public class BindCase {  
  
    @Bind(name="case", time=1)  
    public void method(){  
        // do something..  
    }  
  
    public void method1(){  
        // do something..  
    }  
  
    @Bind(name="case1", time=20)  
    public void method2(){  
        // do something..  
    }  
}

编写注解处理器:
     在 JASE 1.5扩展了了反射机制的API,为我们提供了相应的注解处理器的API,另外还可以通过外部工具 apt 来解析带有注解的Java Code.

public class BindCaseTracker{  
      
    private static Logger logger = Logger.getLogger(BindCaseTracker.class);  
      
    public static void printBindCase(Class<?> bindClass){  
        assert bindClass != null;  
        for (Method method : bindClass.getDeclaredMethods()){  
            Bind bind = method.getAnnotation(Bind.class);  
            if (bind == null) continue; // Not found annotation.  
  
            logger.debug(String.format("Found [%s] Bind Case : %s-%d", method  
                    .getName(), bind.name(), bind.time()));  
        }  
    }  
  
    public static void main(String[] args) {  
        BindCaseTracker.printBindCase(BindCase.class);  
    }  
}
  /* Output: 
[DEBUG] 11-08 14:15 Found [method] Bind Case : case-1 
[DEBUG] 11-08 14:15 Found [method2] Bind Case : case1-20 
*///~

2. 元注解

在J2SE中内置了三种常用标准注解(Override, Deprecated, SuppressWarnings)以及四种元注解:

    @Target:  表示该注解可以用于什么地方。可用ElementType枚举类型主要有: 
               TYPE : 类、接口或enum声明 
               FIELD: 域(属性)声明 
               METHOD: 方法声明 
               PARAMETER: 参数声明 
               CONSTRUCTOR: 构造方法声明 
               LOCAL_VARIABLE:局部变量声明 
               ANNOTATION_TYPE:注释类型声明 
               PACKAGE: 包声明 
     @Retention:  表示需要在什么级别保存该注解信息。可用RetentionPolicy枚举类型主要有: 
              SOURCE: 注解将被编译器丢弃。 
              CLASS  :  注解在class文件中可能。但会被VM丢弃。 
              RUNTIME: VM将在运行时也保存注解(如果需要通过反射读取注解,则使用该值)。 
     @Documented:  将此注解包含在Javadoc中。 
     @Inherited:  允许子类继承父类中的注解。

3. 使用技巧

a. 如果希望定义的注解用于多种  ElementType 的话可以写成:

import static java.lang.annotation.ElementType  
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })

b. 在声明注解中的方法时可通过 default 来指定默认值。
           c.  在声明注解中的方法返回类型可结合泛型使用,如:

Class<? extends Payload>[] payload() default {};

d. 可在注解类中定义嵌套注解,如:

import static java.lang.annotation.ElementType  
  
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })  
@Retention(RUNTIME)  
@Documented  
public @interface NotNull {  
    String message() default "{javax.validation.constraints.NotNull.message}";  
  
    @Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })  
    @Retention(RUNTIME)  
    @Documented  
    @interface List {  
        NotNull[] value();  
    }  
}
@NotNull.List(value = { @NotNull })  
protected List<?> list;

e. 在JASE中提供了很少的内置注解,不过JBoss提供了一个 validation-api 的类库,提供常用验证注解。有兴趣的朋友可以下载看看,其 maven 依赖为:

<dependency>  
  <groupId>javax.validation</groupId>  
  <artifactId>validation-api</artifactId>  
  <version>1.0</version>  
</dependency>
时间: 2024-10-10 18:03:45

Java自定义Annotation方法的相关文章

java自定义Annotation,得到注解类中Annotation设定的注解值

java注解机制在各大框架中应用普遍,注解中可以设置一些值,如何得到呢. 要得到注解类中Annotation设定的注解值 即:遍历自定义Annotation中的方法,反射执行方法,结果就是 对应的注解值. java代码例子: package com.doctor.spring.core; import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotat

Java自定义Annotation

创建一个自定义的Annotation import java.lang.annotation.*; import java.lang.reflect.Method; @Documented @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface MethodInfo { String author() default "hupeng"; String version() defa

android反射组件 (一)java 自定义annotation基础知识

自定义annotation包括三部分: 自定义annotation.使用annotation的类.annotation的处理方法. 一.自定义annotation  元注解包括以下: 1)@Target    描述注解使用的范围 取值包括: 1.CONSTRUCTOR:用于描述构造器 2.FIELD:用于描述域 3.LOCAL_VARIABLE:用于描述局部变量 4.METHOD:用于描述方法 5.PACKAGE:用于描述包 6.PARAMETER:用于描述参数 7.TYPE:用于描述类.接口(

Java自定义Annotation,通过反射解析Annotation

创建一个自定义的Annotation import java.lang.annotation.*; import java.lang.reflect.Method; @Documented @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface MethodInfo { String author() default "hupeng"; String version() defa

java自定义Annotation(载自百度文库)

java中自定义annotation需要@interface关键字和用到几个内置annotation. 用到的注解有@Target,@Retention,@Documented,@Inherited ,用途如下:      @Target 表示该注解用于什么地方,可能的 ElemenetType 参数包括: ElemenetType.CONSTRUCTOR 构造器声明           ElemenetType.FIELD 域声明(包括 enum 实例) ElemenetType.LOCAL_

Java中的Annotation (二、自定义Annotation)

今天学习如何开发一个自定义的Annotation.要想使Annotation有意义,还需要借用前几天学习的反射机制. 下面就开始今天的学习吧. Annotation的定义格式.它类似于新创建一个接口类文件,但为了区分,我们需要将它声明为 @interface public @interface Annotation名称{ 数据类型 变量名称(); } 下面声明了一个Annotation public @interface MyAnnotation { } 使用这个Annotation @MyAn

深入JAVA注解(Annotation):自定义注解 (转)

原文出自:http://blog.csdn.net/yjclsx/article/details/52101922 一.基础知识:元注解 要深入学习注解,我们就必须能定义自己的注解,并使用注解,在定义自己的注解之前,我们就必须要了解Java为我们提供的元注解和相关定义注解的语法. 元注解: 元注解的作用就是负责注解其他注解.Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明.Java5.0定义的元注解: [email prote

Java自定义注解Annotation详解

注解相当于一种标记,在程序中加了注解就等于为程序打上了某种标记,没加,则等于没有某种标记,以后,javac编译器,开发工具和其他程序可以用反射来了解你的类及各种元素上有无何种标记,看你有什么标记,就去干相应的事.标记可以加在包,类,字段,方法,方法的参数以及局部变量上. 自定义注解及其应用 1).定义一个最简单的注解 public @interface MyAnnotation { //...... } 2).把注解加在某个类上: @MyAnnotation public class Annot

java的Annotation注解和自定义注解

import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; //target 代表目标 value里面可以是值也可以是数组 METHOD(方法) TYPE(类型) @Target(value={ElementType.METHOD,Ele