Annotation(一) ：系统内建的Annotation、自定义Annotation

本文主要是介绍Annotation(一) ：系统内建的Annotation、自定义Annotation，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

(最近在学习李兴华的java视频，遂写下学习笔记以铭之)

简介

Annotation，被称为注释，即：使用注释的方式添加程序的一些信息。

Java.lang.annotation.Annotation是所有Annotation都必须实现的接口。

系统自建的三种Annotation

@override：覆写的Annotation
@Deprecated：不赞成使用的Annotation
@SuppressWarning：压制安全警告的Annotation

基本使用

(1) @override

表示方法覆写的正确性，例：

class Person{public String getInfo(){		// 取得信息return "这是一个Person类。" ;}
};
class Student extends Person{	// 继承此类@Overridepublic String getinfo(){	// 覆写方法return "这是一个Student类。" ;}
};
public class OverrideAnnotationDemo01{public static void main(String args[]){Person per = new Student() ;System.out.println(per.getInfo()) ;	// 输出信息}
};

(2) @Deprecated

使用@Deprecated注释的Annotation本事是不建议使用的一个操作

@Deprecated			// 声明不建议使用的操作
class Demo{public String getInfo(){return "这是一个Person类。" ;}
};
public class DeprecatedAnnotationDemo02{public static void main(String args[]){Demo d = new Demo() ;System.out.println(d.getInfo()) ;}
};

(3) @SuppressWarning

用于压制警告信息

以泛型为例，在泛型中如果没有指定泛型类型，则使用时肯定出现安全警告

class Demo<T>{private T var ;public T getVar(){return this.var ;}public void setVar(T var){this.var = var ;}
};
public class SuppressWarningsAnnotationDemo01{@SuppressWarnings("unchecked")public static void main(String args[]){Demo d = new Demo() ;d.setVar("Troy") ;System.out.println("内容：" + d.getVar()) ;}
};

以上只是压制了一个警告信息，如果要压制多个警告信息，只需要以数组的形式出现即可

@Deprecated
class Demo<T>{private T var ;public T getVar(){return this.var ;}public void setVar(T var){this.var = var ;}
};
public class SuppressWarningsAnnotationDemo02{@SuppressWarnings({"unchecked","deprecation"})public static void main(String args[]){Demo d = new Demo() ;d.setVar("Troy") ;System.out.println("内容：" + d.getVar()) ;}
};

@SuppressWarning中关键字

No.	关键字	描述
1	deprecated	使用了不赞成使用的类或方法的警告
2	unchecked	使用了未检查的转换时警告
3	fallthrough	当swithch块直接往下执行而没有break时的警告
4	path	当类路径和源文件路径中有不存在路径的警告
5	serial	当在可序列化的类中不存在serialVersionId出现的警告
6	finally	任何finally子句无法完成出现的警告
7	all	关于以上所有出现的警告

在设置注释信息时，是以key->value的形式出现的，所以也可以直接使用value={"unchecked","Deprecated"}的方式设置

定义简单的Annotation

Annotation定义格式：

[public] @interface Annotation名称 {

数据类型变量名称();

}

例：

public @interface MyDefaultAnnotationNoneParam{}

之后就可以在程序中使用 "@Annotation名称"的格式

@MyDefaultAnnotationNoneParam
class Demo{
};

这就表示在Demo类上使用Annotation

可以在Annotation使用成员接收参数

例如：

public @interface MyDefaultAnnotationSingleParam{public String value() ;	// 接收设置的内容
}

在使用的时候必须清楚的指定变量的内容

@MyDefaultAnnotationSingleParam("Troy")
class Demo{
};

也可以明确的指定变量赋值给哪个参数

@MyDefaultAnnotationSingleParam(value="Troy")
class Demo{
};

既然可以使用一个参数，就可以使用多个参数

public @interface MyDefaultAnnotationMoreParam{public String key() ;public String value() ;	// 接收设置的内容
}

此Annotation在使用的时候，必须明确指定key和value

@MyDefaultAnnotationMoreParam(key="科大",value="Troy")
class Demo{
};

参数也可以是一个数组

public @interface MyDefaultAnnotationArrayParam{public String[] value() ;	// 接收设置的内容
}

接收的类型是一个数组类型，则需传入一个数组，使用方式类似于SuppressWarning...

@MyDefaultAnnotationArrayParam(value={"MLDN","李兴华"})
class Demo{
};

可以为Annotation指定默认参数

在声明的时候使用default即可

public @interface MyDefaultAnnotationValue{public String key() default "科大" ;	// 指定好了默认值public String value() default "Troy" ;	// 指定好了默认值
}

则在使用此Annotation时不必传入参数

@MyDefaultAnnotationValue
class Demo{
};

使用枚举来指定Annotation的取值范围

在操作中，有时需要固定Annotation的取值范围，只能取固定几个值，这时便可以利用枚举.

public enum MyName{	// 定义枚举类型a,b,c ;
}

public @interface MyDefaultAnnotationEnum{public MyName name() default MyName.a ;	// 指定默认值
}

那么在使用此Annotation时，则必须从MyName中取值。

@MyDefaultAnnotationEnum(name=MyName.b)	// 只能从固定的枚举中取内容
class Demo{
};

Retention和RetentionPolicy

在Annotation中可以使用Retention定义一个Annotation的保存范围，此Retention的定义如下：

@Documented
@Retention(value=RUNTIME)
@Target(value=ANNOTATION_TYPE)
public @interface Retention {RetentionPolicy value();
}

以上Retention的定义中包含了一个RetentionPolicy变量，该变量用于指定Annotation的保存范围，该变量包含了三种取值范围

No.	取值	描述
1	SOURCE	此Annotation的信息只会保留在程序的源文件中，不会保存在编译好的类文件中
2	CLASS	此Annotation会保留在源文件和编译好的class文件中，而不会加载到JVM中，默认为此范围。
3	RUNTIME	此Annotation会保留在源文件，编译好的class文件，在运行时会被加载到JVM中

额外需要注意的RUNTIME范围，因为在执行的时候起作用，可以与反射搭配起来使用。

例：

import java.lang.annotation.Retention ;
import java.lang.annotation.RetentionPolicy ;
@Retention(value=RetentionPolicy.RUNTIME)	// 表示此Annotation在运行时有效
public @interface MyDefaultRententionAnnotation{public String name() default "Troy" ;
}

内建的Annotation的RetentionPolicy：