元数据从metadata一词译来就是关于数据的数据的意思越来越的开源框架都提供了元数据支持了其实也就是注释支持今天系统学习一下Java注释(Java元数据)本文内容不限于Javadoc的注释
什么是Java元数据有什么作用?
元数据就是关于数据的数据功能也有很多啦你可能用过Javadoc的注释自动生成文档这就是元数据功能的一种总的来说元数据可以用来创建文档跟蹤代码的依赖性执行编译时格式检查代替已有的配置文件(如Hibernate也提供了注释配置)
注释有中基本类型
a标记注释 没有变量只有名称标识例如 @annotation
b单一值注释 在标记注释的基础上提供一段数据如 @annotation(data)
c完整注释 可以包括多个数据成员每个数据成员由名称和值构成
@annotation(val=dataval=data)
Java的注释
Java中提供个内置注释类型
a Override 只能用于方法(不能用于类包声明或者其他构造)
作用可以保证编译时候Override函数的声明正确性
用法@Override
public void fun(){}
bDeprecated 同样只能作用与方法
作用对不应再使用的方法进行注解
用法@Deprecated public void fun{} //它们说这个注释跟函数要同一行
cSupressWarnings 可以注释一段代码
作用关闭特定的警告信息例如你在使用泛型的时候未指定类型
用法 @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 允许子类继承父类中的注释
在Java中定义自己的注释
Java语言支持一种新的类型——注释类型(annotation type)跟普通类差不多在类中以符号( @ )的形式注释其他 Java 代码
下面将通过一个简单的例子来实现(代码是Brett McLaughlin 的)
@interface 申明
i简单的注释类型
package comoreillytigerch; /** * Marker annotation to indicate that a method or class * is still in progress */ public @interface InProgress { }
ii使用定制的注释类型
@comoreillytigerchInProgress public void calculateInterest(float amoutfloat rate) { //Need to finish this method later }
iii添加成员
package comoreillytigerch; /** * Marker annotation to indicate that a method or class * is still in progress */ public @interface InProgress { String value(); } @comoreillytigerchInProgress @TODO(Figure out the amount of interest per month) //或者@TODO(value=Figure out the amount of interest per month) public void calculateInterest(float amountfloat rate) { }
iv设置默认值
package comoreillytigerch; public @interface GroupTODO { public enum Serverity { CRITICALIMPORTANTIRIVIALDOCMENTATION }; Severity severity() default SeverityIMPORTANT; String item (); String assignedTo(); String dateAssigned(); } }
v使用默认值
@comoreillytigerchInProgress @GroupTODO( item=Figure out the amount of interest per month assignedTo = Brett McLaughlin dateAssigned = // ) public void calculateInterest(float amount float rate) { //Need to finish this method later }
vi改写默认值
@comoreillytigerchInProgress @GroupTODO { severity = GroupTODOSeverityDOCUMENTATION item = Need to explain how this rather unusal method works assignedTo = Jon Stevens dateAssigned = // }
这样就对Java元数据/Java注释进行了总结
