Java元数据总结：Java注释的利用和界说

副标题#e#

元数据从metadata一词译来，就是“关于数据的数据”的意思。越来越的开源框架都提供了“元数据”支持了，其实也就是注释支持。本日系统进修一下Java注释（Java元数据）。本文内容不限于Javadoc的注释。

1.什么是Java元数据，有什么浸染？

元数据，就是“关于数据的数据”。成果也有许多啦。你大概用过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"})

..代码

#p#副标题#e#

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
}

#p#副标题#e#

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.改写默认值

#p#分页标题#e#

@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元数据/Java注释举办了总结。