java注解（@interface）

之所以写这篇博文，是因为今天在公司项目中看见了这段代码

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;http:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Message {

	String mo() default "";
	String mt() default "";
	String transType() default "";
	boolean forward() default false;
}

刚一看到这段代码有点莫名其妙，不过我想你看完下面的内容可能很容易理解。

元注解

作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

　　　　1.@Target,
　　　　2.@Retention,
　　　　3.@Documented,

　　　　4.@Inherited

这些注解和它们所支持的类在java.lang.annotation包中可以找到

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）

ElementType：

　　　　1.CONSTRUCTOR:构造器的声明
　　　　2.FIELD:域声明（包括enum实例）
　　　　3.LOCAL_VARIABLE:局部变量声明
　　　　4.METHOD:方法声明
　　　　5.PACKAGE:包声明
　　　　6.PARAMETER:参数声明
　　　　7.TYPE:类、接口(包括注解类型) 或enum声明

@Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

　　RetentionPoicy参数有：

　　　　1.SOURCE:在源文件中有效（即源文件保留），注解被编译器丢弃。
　　　　2.CLASS:在class文件中有效（即class保留），但会被VM丢弃。
　　　　3.RUNTIME:在运行时有效（即运行时保留），VM在运行期间保留注解，因此可以通过反射机制读取注解信息。

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

@Inherited 允许子类继承父类的注解。

自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

自定义注解的基本格式：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
  
}

定义注解时需要用到元注解。

Annotation类型里面的参数该设定:

            只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；

            参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;

            如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

例：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AnimalName{
    String value() default "";
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface AnimalColor {
    public enum Color{ RED,BLACK,WHITE};
    Color animalColor() default Color.WHITE;

}

public class Dog {
    
    @AnimalName("Dog")
    private String dogName;
    
    @AnimalColor(animalColor=Color.RED)
    private String dogColor;
} 

注解参数支持的数据类型：

                1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2.String类型
　　　　3.Class类型
　　　　4.enum类型
　　　　5.Annotation类型
　　　　6.以上所有类型的数组

例子：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Message {
public String id();
     public String description() default "no description";
}

public class EmailUtils {
     @UseCase(id = 47, description = "Emails contain at least one numeric")
     public boolean validateEmail(String email) {
         return (email.matches("\\w*\\d\\w*"));
     }
 
     @UseCase(id = 48)
     public String encryptEmail(String email) {
         return new StringBuilder(email).reverse().toString();
     }
 }

使用注解最主要的部分在于对注解的处理，那么就会涉及到注解处理器。 从原理上讲，注解处理器就是通过反射机制获取被检查方法上的注解信息，然后根据注解元素的值进行特定的处理

未完待续......