Java注解
定义
注解(Annotation)，也叫元数据，是一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一层次。它可以声明在包、类、字段、方法、局部变量、方法参数、构造函数等的前面，用来对这些元素进行说明和注释。
元注解
元注解的作用就是负责注解其他注解，即注解的注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其他annotatio类型作说明。Java5.0定义的元注解：@Retention、@Target、@Documented、@Inherited
@Retention
@Retention表示需要在什么级别保存该注释信息，用于描述注解的生命周期，取值有
1、@Retention(RetentionPolicy.SOURCE) 注解仅存在于源码中，在class字节码文件中不包含
2、@Retention(RetentionPolicy.CLASS) 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得
3、@Retention(RetentionPolicy.RUNTIME) 注解会在class字节码文件中存在，在运行时可以通过反射获取到
SOURCE 例1
自定义注解MyAnnotation,Retention的取值是保留策略的SOURCE
@Retention(RetentionPolicy.SOURCE)
public @interface MyAnnotation{
}
标注的类Test
@MyAnnotation
public classTest {
public static void main(String[] args) {
System.out.println("生成的class文件反编译后不会出现注解@MyAnnotation");
}
}
反编译生成的.class文件，Test类不存在MyAnnotation注解
CLASS 例2
自定义注解MyAnnotation,Retention的取值是保留策略的CLASS
@Retention(RetentionPolicy.CLASS)
public @interface MyAnnotation{
}
标注的类Test
@MyAnnotation
public classTest {
public static void main(String[] args) {
System.out.println("生成的class文件反编译后会出现注解@MyAnnotation");
Annotation[] annotations = Test.class.getAnnotations();
System.out.println("Runtime期间标注在Test类上的注解个数为："+ annotations.length);
}
}
验证结果：.class文件出现注解，运行期间获取Test类上的注解个数为0
RUNTIME 例2
自定义注解MyAnnotation,Retention的取值是保留策略的RUNTIME
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{
}
标注的类Test
@MyAnnotation
public classTest {
public static void main(String[] args) {
System.out.println("生成的class文件反编译后会出现注解@MyAnnotation");
Annotation[] annotations = Test.class.getAnnotations();
System.out.println("Runtime期间标注在Test类上的注解个数为："+ annotations.length);
}
}
验证结果：.class文件出现注解，运行期间获取Test类上的注解个数为1
@Target
用于设定注解使用范围，通过ElementType来指定可使用范围的枚举集合。
注解只能在ElementType设定的范围内使用，否则将会编译报错。
@Documented
@Documented标注的注解应该被javadoc工具记录。默认情况下，javadoc是不包括注解的，如果声明注解时指定了@Documented,注解类型信息也会被包括在生成的文档中。
@Inheried
@Inherited：允许子类继承标注在父类上的注解。
package-info.java
package-info.java不是平常类，其作用有三个：
1.为标注在包上Annotation提供便利
2.声明包的私有类和常量
3. 提供包的整体注释声明
package-info.java里不能声明public class 或 public interface，在package-info.java定义的类和普通类没什么却别。
例子 1
MyPackageAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PACKAGE)
@Documented
public@interfaceMyPackageAnnotation{
String version()default"";
}
package-info.java
@MyPackageAnnotation(version ="1.0")
packagecom.leeem.domain;
importcom.leeem.annotation.MyPackageAnnotation;
//类方法
classPackageClass{
public voidclassMethod(){
System.out.println("class method");
}
}
//类常量字段
classPackageClassConstant{
public static finalStringERROR_CODE="100001";
}
//接口方法
interfacePackageInterface{
public voidinterfaceMethod();
}
Test.java --获取包注解
public classTest {
public static voidmain(String[] args) {
Package p = Package.getPackage("com.leeem.domain");
MyPackageAnnotationmyPackageAnnotation = p.getAnnotation(MyPackageAnnotation.class);
if(myPackageAnnotation !=null&& p.isAnnotationPresent(MyPackageAnnotation.class)){
System.out.println("获取到包注解，且版本version为："+ myPackageAnnotation.version());
}
}
}
输出：获取到包注解，且版本version为：1.0
Test.java --使用package-info.java定义的类 (接口类似)
public classTest {
public static voidmain(String[] args) {
PackageClasspackageClass =newPackageClass();
packageClass.classMethod();
}
}
输出：class method
Test.java --使用package-info.java定义的类的常量
public classTest {
public static voidmain(String[] args) {
System.out.println(PackageClassConstant.ERROR_CODE);
}
}
输出：100001
Java内置注解
Java SE5内置了三种标准注解：@Override、@Deprecated、@SuppressWarnings
@Override:表示当前的方法定义将覆盖超类中的方法。
@Deprecated:标注已过时或已废弃的代码，通常存在更好的选择。使用该注解标注的元素时，编译器会报警
@SuppressWarnings:用来抑制编译时的警告信息
