本文共 5829 字，大约阅读时间需要 19 分钟。
转自 ：http://javaopen.iteye.com/blog/645915
来越的开源框架都提供了“元数据”支持了。为了不outdate，今天系统学习一下Java的注释（又叫元数据）。本文将遵循以下的结构布局
1.什么是元数据？有什么作用 2.Java的“注释” 3.在Java中定义自己的注释 4.总结一下-----------------------开始----------------------
1.什么是元数据，有什么作用？
元数据，就是“关于数据的数据”。功能也有很多啦。你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件（如Hibernate也提供了注释配置）
注释有3中基本类型
a.标记注释 --没有变量，只有名称标识。例如 @annotation
b.单一值注释 --在标记注释的基础上提供一段数据。如 @annotation（“data”） c.完整注释 --可以包括多个数据成员，每个数据成员由名称和值构成。 @annotation(val1="data1",val2="data2")2.Java的“注释”
Java中提供3个内置注释类型
a. Override ，只能用于方法（不能用于类，包声明或者其他构造）
作用：可以保证编译时候Override函数的声明正确性 用法：@Override public void fun(){..}b.Deprecated 同样只能作用与方法
作用：对不应再使用的方法进行注解 用法：@Deprecated public void fun{...} //它们说这个注释跟函数要同一行c.SupressWarnings 可以注释一段代码
作用：关闭特定的警告信息，例如你在使用泛型的时候未指定类型 用法： @SupressWarnings(value={"unchecked"}) ..代码Java中还提供了四种元注释，专门负责注释其他的注释
@Target 表示该注释可以用于什么地方。可用的ElementType参数包括：
CONSTRUCTOR : 构造器的声明 FIELD : 域声明（包括enum实例） LOCAL_VARIABLE : 局部变量声明 METHOD : 方法声明 PACKAGE : 包声明 PARAMETER : 参数声明 TYPE : 类、接口 （包括注解类型) 或enum声明@Retention 表示需要在什么级别保存该注释信息。可选的RetentionPoicy参数包括：
SOURCE : 注释将被编译器丢掉 CLASS : 注释在class文件中可用，但会被VM丢弃 RUNTIME : VM将在运行时也保留注释，因此可以通过反射机制读取注释的信息。@Documented 将注释包含在JavaDoc中
@Inheried 允许子类继承父类中的注释。
3. 在Java中定义自己的注释
Java语言支持一种新的类型--注释类型（annotation type），跟普通类差不多，在类中以符号（ @ ）的形式注释其他 Java 代码
下面将通过一个简单的例子来实现（代码是Brett McLaughlin 的）
@interface 申明
i.简单的注释类型
package com.oreilly.tiger.ch06; /** * Marker annotation to indicate that a method or class * is still in progress. */ public @interface InProgress { }ii.使用定制的注释类型
@com.oreilly.tiger.ch06.InProgress public void calculateInterest(float amout,float rate) { //Need to finish this method later }iii.添加成员
package com.oreilly.tiger.ch06; /** * Marker annotation to indicate that a method or class * is still in progress. */ public @interface InProgress { String value(); }@com.oreilly.tiger.ch06.InProgress
@TODO("Figure out the amount of interest per month") //或者@TODO(value="Figure out the amount of interest per month") public void calculateInterest(float amount,float rate) { }iv.设置默认值
package com.oreilly.tiger.ch06; public @interface GroupTODO { public enum Serverity { CRITICAL,IMPORTANT,IRIVIAL,DOCMENTATION }; Severity severity() default Severity.IMPORTANT; String item (); String assignedTo(); String dateAssigned(); } }v.使用默认值
@com.oreilly.tiger.ch06.InProgress @GroupTODO( item="Figure out the amount of interest per month", assignedTo = "Brett McLaughlin", dateAssigned = "08/04/2004" )public void calculateInterest(float amount, float rate)
{ //Need to finish this method later }vi.改写默认值
@com.oreilly.tiger.ch06.InProgress @GroupTODO { severity = GroupTODO.Severity.DOCUMENTATION, item = "Need to explain how this rather unusal method works", assignedTo = "Jon Stevens", dateAssigned = "07/30/2004" }
【转至】：
核心提示：注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。
Java基础-学习使用Annotation注解对象 注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法,使我们可以在稍后某个时刻非常方便地使用这些数据
1-1:基本语法 Java SE5内置三种标准注解 @Override:表示当前的方法定义将覆盖超类中的方法.如果你不小心拼写错误,或者方法签名对不上被覆盖的方法,编译器就会发出错误提示
@Deprecated:如果程序员使用了注解为它的元素,那么编译器就会发出警告信息
@SupperessWarnings:关闭不当的编译器警告信息.
Java SE5内置四种元注解
@Target:表示该注解可以用于什么地方.可能的ElementType参数包括: 1)CONSTRUCTOR:构造器的声明 2)FIELD:域声明(包括enum实例) 3)LOCAL_VARIABLE:局部变量声明 4)METHOD:方法声明 5)PACKAGE:包声明 6)PARAMETER:参数声明 7)TYPE:类、接口(包括注解类型)或enum声明@Retention:表示需要在什么级别保存该注解信息.可选的RetentionPolicy参数包括:
1)SOURCE:注解将被编译器丢弃 2)CLASS:注解在class文件中可用,但会被VM丢弃 3)RUNTIME:VM将在运行期也保留注解,因此可以通过反射机制读取注解的信息@Documented:将此注解包含在Javadoc中
@Inherited:允许子类继承父类中的注解
大多数时候,程序员主要是定义自己的注解，并编写自己的处理器来处理它们.----------------------------- UseCase.java -------------------------
package com; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target(ElementType.METHOD)//用来定义你的注解将应用在什么地方,本处应用为方法 //用来定义该注解在哪一个级别可用,在源代码中(source)类文件中(class)或者运行时(runtime) @Retention(RetentionPolicy.RUNTIME) public @interface UseCase { public int id(); public String description()default "no description"; } ----------------------------- PasswordUtils .java ------------------------- package com; public class PasswordUtils { @UseCase(id=47,description="Passwords must contain at least one numeric") public boolean validatePassword(){ return true; } @UseCase(id=48) public String encryptPassword(String password){ return password; } @UseCase(id=49,description="Jong_Cai") public void showName(){ System.out.println("Jong_Cai"); } } 1-2:编写注解处理器 如果没有用来读取注解的工具,那注解也不会比注释更有用.使用注解的过程中.很重要的一个部分就是创建与使用注解处理器.Java SE5扩展了反射机制的API,以帮助程序员构造这类工具.同时,它还提
供了一个外部工具apt帮助程序员解析带有注解的Java源代码.
下面是一个非常简单的注解处理器,我们将用它来读取PasswordUtils类,并使用反射机制查找@UseCase标记.我们为其提供了一组id值得,然后它会列出在PasswordUtils中找到的用例,以及缺失的
用例.
------------------------ UseCaseTracker.java ---------------------------
package com; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.Collections; import java.util.List; public class UseCaseTracker { public static void trackUseCases(List<Integer> list, Class<?> cl) { for (Method m : cl.getDeclaredMethods()) { UseCase us = m.getAnnotation(UseCase.class); if (us != null) { System.out.println("Found Use Case:" + us.id() + " " + us.description()); list.remove(new Integer(us.id())); } } for (int i : list) { System.out.println("Warning:Missing use case-" + i); } } public static void main(String[] args) { List<Integer> list = new ArrayList<Integer>(); Collections.addAll(list, 47,48,49,50,51); trackUseCases(list, PasswordUtils.class); } } 这个程序用到了两个反射的方法:getDeclaredMethods()和getAnnotation(),它们都属于AnnotatedElement接口(class,Method与Field等类都实现了该接口).getAnnotation()方法返回指定类
型的注解对象,在这里就是UseCase,如果被注解的方法上没有该类型的注解,则返回null值.然后我们通过
调用id()和description()方法从返回的UseCase对象中提取元素的值.其中encryptPassword()方法在注
解的时候没有指定description的值,因此处理器在处理它对应的注解时,通过description()方法取得的
是默认值no description.
转载地址：http://pktwo.baihongyu.com/