安可林文章网新闻资讯
注解基础知识点
定义:注解(Annota路别缺眼并tion)，也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
作用分类:
①编写文档:通过代码里标识的元数据生成文档【生成文档doc文档】
② 代码分析:通过代码里标识的元弦数据对代码进行分析【使用反射】
③编译检查:通过代码里标识的元数据让编译器能够实现基本来自的编译检查【Override】
- 中文名 Java 注解
- 外文名 Annotation
- 别 名 元数据
- 含 义 一种代码级别的说明
总览
Annotation(注解)是JDK5.0及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注解是以‘@注解名’在代码中存在的，根据注解参数的个数，我们可以将注解分为：标记注解、单值注解、完整注解三类。它来自们都不会直接影响到程序的语义，只是作为注解（标识）存在，我们可以通过反射机制编程实现对这些元数据的访问善英架硫们边背抓业因端。另外，你可以在编译时选择代码里的注解是否只存在于源代码级，或者它也能在class文件中出现。
Annota360百科tion的工作原理：
JDK5.0中提供了注解的功能，允许开发者定义和使用自己的注解类型。该功能由一个定义注解类型的语法和描述一个注解声明的语法，读取议案何划妒拉传注解的API，一何急了破支个使用注解修饰的clas交负从品尽夜脸州s文件和一个注解处理工具组成。皇造Annotation并不直接影响代码的语义，但是他可以被看做是程序的工具或者类库。它会反过来对正在运行的程序语义有所影体逐流视洋某秋响。Annotation其态矿第来聚界婷明根可以从源文件、class文件或者在运行时通过反射机制多种方式被读取。
元比药米皇省或鲁间金格席数据的作用
如果要对于元数据的作用进行分类握班保乱探语句，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类：
编写文档：通过代码里标识的元数据生成文档。
代码分析：通妒过代码里标识的元数据对代码进行分析。
编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查
基本内置注解
@Overr专问础调情宣鲁小ide
Jav汽评声吃山该比觉侵a代码
ackagecom.iwtxokhtd.annotation;
/**
* 测试Override注解
* @authorAdministrator
*
*/
ublicclassOverrideDemo报日台好导战Test {
//@Override
ublicString tos节都振冷如京最统tring(){
return"测试注解";
}
}
@Deprecated的作用是对不应该在使用的方法添加注解，当编程人员使用这些方法免元可独溶罗拿适时，将会在编译时显示提示信息，它与javadoc里的@deprecated标记有相同的功能，准确的说，它还不如javadoc 终钢该实难扬犯解足弱@deprecated，因为它不支持参数，使用@Deprecated的示例代码示例如下：
Java代码
ackagecom.iwtxokhtd.annotation;
/**
* 测试Deprecated注解
* @authorAdministrator
*
*/
ublicclassDeprecatedDemoTest {
ublicstaticvoidmain(String[] args) {
//使用DeprecatedClass里声明被过时的方法
DeprecatedClass.DeprecatedMethod();
}
}
飞铁著教从英培现按技设 classDeprecatedClass{
@Deprecated
ublicstaticvoidDeprecatedMethod() {
}
}
@Sup能指械布续权pressWarnings,其参数有：
deprecation，使用了过时的类或方法时的警告
unchecked，执行了未检查的转换时的警告
fallthrough，当 Switch 程序块直接通往下一种情况而没有 Break 时的警告
ath，在类路径、源文件路径等中有不存在的路径时的警告
erial，当在可序列化的类上缺少serialVersionUID 定义时的警告
finally ，任何 finally 子句不能正常完成时的警告
all，关于以上所有情况的警告
Java代码
ackagecom.iwtxokhtd.annotation;
importjava.util.ArrayList;
importjava.util.List;
ublicclassSuppressWarningsDemoTest {
ublicstaticListlist=newArrayList();
@SuppressWarnings("unchecked")
ublicvoidadd(String data){
list.add(data);
编辑本段
自定义注解
它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为@interface,如下例：
Java代码
ackagecom.iwtxokhtd.annotation;
ublic@interfaceNewAnnotation {
}
使用自定义的注解类型
Java代码
ackagecom.iwtxokhtd.annotation;
ublicclassAnnotationTest {
@NewAnnotation
ublicstaticvoidmain(String[] args) {
}
}
为自定义注解添加变量
Java代码
ackagecom.iwtxokhtd.annotation;
ublic@interfaceNewAnnotation {
String value();
}
Java代码
ublicclassAnnotationTest {
@NewAnnotation("main method")
ublicstaticvoidmain(String[] args) {
aying();
}
@NewAnnotation(value = "say method")
ublicstaticvoidsaying() {
}
}
定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值
ublic@interfaceGreeting {
ublicenumFontColor {
BLUE, RED, GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
这里有两种选择，其实变数也就是在赋予默认值的参数上，我们可以选择使用该默认值，也可以重新设置一个值来替换默认值
Java代码
ublicclassAnnotationTest {
@NewAnnotation("main method")
ublicstaticvoidmain(String[] args) {
aying();
ayHelloWithDefaultFontColor();
ayHelloWithRedFontColor();
}
@NewAnnotation("say method")
ublicstaticvoidsaying() {
}
// 此时的fontColor为默认的RED
@Greeting(name = "defaultfontcolor")
ublicstaticvoidsayHelloWithDefaultFontColor() {
}
// 现在将fontColor改为BLUE
@Greeting(name = "notdefault", fontColor = Greeting.FontColor.BLUE)
ublicstaticvoidsayHelloWithRedFontColor() {
}
注解的高级应用
1.1. 限制注解的使用范围
用@Target指定ElementType属性
Java代码(jdk)
ackagejava.lang.annotation;
ublic enum ElementType {
TYPE,
// 用于类，接口，枚举但不能是注解
FIELD,
// 字段上，包括枚举值
METHOD,
// 方法，不包括构造方法
PARAMETER,
// 方法的参数
CONSTRUCTOR,
//构造方法
LOCAL_VARIABLE,
// 本地变量或catch语句
ANNOTATION_TYPE,
// 注解类型(无数据)
PACKAGE
// Java包
}
1.2. 注解保持性策略
Java代码
//限制注解使用范围
@Target({ElementType.METHOD,ElementType.CONSTRUCTOR})
ublic @interface Greeting {
//使用枚举类型
ublic enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
在Java编译器编译时，它会识别在源代码里添加的注解是否还会保留，这就是RetentionPolicy。下面是Java定义的RetentionPolicy枚举：
编译器的处理有三种策略：
将注解保留在编译后的类文件中，并在第一次加载类时读取它
将注解保留在编译后的类文件中，但是在运行时忽略它
按照规定使用注解，但是并不将它保留到编译后的类文件中
Java代码
ackagejava.lang.annotation;
ublic enum RetentionPolicy{
SOURCE,
// 此类型会被编译器丢弃
CLASS,
// 此类型注解会保留在class文件中，但JVM会忽略它
RUNTIME
// 此类型注解会保留在class文件中，JVM会读取它
}
Java代码
//让保持性策略为运行时态，即将注解编码到class文件中，让虚拟机读取
@Retention(RetentionPolicy.RUNTIME)
ublic @interface Greeting {
//使用枚举类型
ublic enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.3. 文档化功能
Java提供的Documented元注解跟Javadoc的作用是差不多的，其实它存在的好处是开发人员可以定制Javadoc不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下：
Java代码
//让它定制文档化功能
//使用此注解时必须设置RetentionPolicy为RUNTIME
@Documented
ublic @interface Greeting {
//使用枚举类型
ublic enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
1.4. 标注继承
Java代码
//让它允许继承，可作用到子类
@Inherited
ublic @interface Greeting {
//使用枚举类型
ublic enum FontColor{
BLUE,RED,GREEN
};
String name();
FontColor fontColor() defaultFontColor.RED;
}
2. 读取注解信息
属于重点，在系统中用到注解权限时非常有用，可以精确控制权限的粒度
注意：要想使用反射去读取注解，必须将Retention的值选为Runtime
Java代码
ackagecom.iwtxokhtd.annotation;
importjava.lang.annotation.Annotation;
importjava.lang.reflect.Method;
//读取注解信息
ublicclassReadAnnotationInfoTest {
ublicstaticvoidmain(String[] args) throwsException {
// 测试AnnotationTest类，得到此类的类对象
Class c = Class.forName("com.iwtxokhtd.annotation.AnnotationTest");
// 获取该类所有声明的方法
Method[] methods =c.getDeclaredMethods();
// 声明注解集合
Annotation[] annotations;
// 遍历所有的方法得到各方法上面的注解信息
for(Method method : methods) {
// 获取每个方法上面所声明的所有注解信息
annotations =method.getDeclaredAnnotations();
// 再遍历所有的注解，打印其基本信息
System.out.println(method.getName());
for(Annotation an :annotations) {
System.out.println("方法名为：" + method.getName()+ " 其上面的注解为："
+an.annotationType().getSimpleName());
Method[] meths =an.annotationType().getDeclaredMethods();
// 遍历每个注解的所有变量
for(Method meth :meths) {
System.out.println("注解的变量名为：" + meth.getName