详解Java注解教程及自定义注解

自Java5.0版本引入注解之后，它就成为了Java平台中非常重要的一部分。开发过程中，我们也时常在应用代码中会看到诸如@Override，@Deprecated这样的注解。这篇文章中，我将向大家讲述到底什么是注解，为什么要引入注解，注解是如何工作的，如何编写自定义的注解(通过例子)，什么情况下可以使用注解以及最新注解和ADF(应用开发框架)。这会花点儿时间，所以为自己准备一杯咖啡，让我们来进入注解的世界吧。

1.定义：

Java提供了一种原程序中的元素关联任务信息和任何元素的途径与方法。乍一看这个概念，我反正是没看懂，不知道您是否看懂了。但是@override这个您总认识吧，这个就是注解。

2.分类：

本教程对Java注解是按以下两个维度进行分类的：

第一类：按运行机制分类

源码注解：

这类注解只存在于源码之中，编译后的Class文件里不存在

编译时注解：

这类注解存在于源码与Class文件中

运行时注解：

在运行阶段还起作用的注解，比较典型的是Spring中的@Autowired.

特别注意：只有第3种注解才会在反射的时候获取到

第二类：按来源分类

JDK本身自带的，比如以下的注解

@Override:重写一个方法

@Deprecated：标示某个方法是过时的

@Suppvisewarnings：忽略注解的提示

第三方的注解，比如Spring中的注解

自定义注解

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。

1.新建Interface，建完在名字前加@，就成了自定义的注解

[java] view plain copy
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* 定义一个注解
*/
@Target(ElementType.METHOD) // 这是一个对方法的注解，还可以是包、类、变量等很多东西
@Retention(RetentionPolicy.RUNTIME) // 保留时间，一般注解就是为了框架开发时代替配置文件使用，JVM运行时用反射取参数处理，所以一般都为RUNTIME类型
@Documented // 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化
public @interface OneAnnotation {

// 定义注解的参数，类型可以为基本类型以及String、Class、enum、数组等，default为默认值
String parameter1() default "";
int parameter2() default -1;
}

2.使用注解的类

[java] view plain copy
/**
* 一个用到了自定义的注解的类
*/
public class OneClass {

@OneAnnotation(parameter1="YES", parameter2=10000)
public void oneMethod () {
}
}

3.提取注解参数

[java] view plain copy
import java.lang.reflect.Method;

public class TestThis {

public static void main(String[] args) throws Exception {
// 提取到被注解的方法Method，这里用到了反射的知识
Method method = Class.forName("OneClass").getDeclaredMethod("oneMethod");
// 从Method方法中通过方法getAnnotation获得我们设置的注解
OneAnnotation oneAnnotation = method.getAnnotation(OneAnnotation.class);

// 得到注解的俩参数
System.out.println(oneAnnotation.parameter1());
System.out.println(oneAnnotation.parameter2());
}
}

测试结果：

YES

10000