注解的概念
JDK5及其以后JDK版本开始支持Java注解;
Java注解(Annotation)也叫作元数据,以‘@注解名’在代码中存在,它是一种在源代码中标注的特殊标记,可以标注源代码中的类、属性、方法、参数等代码,主要用于创建文档,跟踪代码中的依赖性,甚至执行基本编译时检查。
Java注解的种类
按照含不含参数分为三种
1.不带参数,语法结构:@Annotation
例如:
2.带一个参数的注解,语法结构:@Annotation(参数)
例如:
3.带多个参数的注解,语法结构为:@Annotiation(参数1, 参数2, 参数3...)
例如:
内置注解
@override注解
用于标注方法,用于说明所标注方法是是重写父类的方法
@Deprecated注解
用于说明所标注元素(成员变量或方法)因存在安全问题或有更好选择而不鼓励程序员使用,如果强行使用,则编译器会发出警告。
@SuppressWarnings注解
用于取消编译器所显示的警告,该注解常用属性值如下:
1.deprecation:使用已被@Deprecated标注的程序元素。
2.unused:程序含有未被使用的元素。
3.serial:在可序列化的类上缺少serialVersionUID定义。
元注解
Java 提供了四个用于修饰自定义注解的元注解 @Target @Retention @Documented @Inherited
1.@Target :用于指定自定义注解可以修饰程序里的哪些元素
以下是其中可用的属性值
ElementType.FIELD:指定该注解可以用在全局属性上
ElementType.METHOD:应用于方法上
ElementType.PARAMETER:应用在方法的参数上
ElementType.TYPE:应用在类 接口 枚举类型上
ElementType.ANNOTATION_TYPE:应用于其他注解的元注解
ElementType.CONSTRUCTOR:应用于构造函数
ElementType.LOCAL_VARIABLE:应用于方法中的本地变量
ElementType.PACKAGE:应用于包
使用示例:
package test;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ElementType.TYPE,ElementType.METHOD})
public @interface Test {
}
//以下是另一个源文件
package test;
@Test
public class User {
@Test
public void user() {
}
}
2.@Retention
以下是其可用的属性值
RetentionPolicy.SOURCE:编译器将直接丢弃这个注解
RetentionPolicy.CLASS:默认值 将记录在class文件里 当Java程序运行的时候将会丢弃这个注解
RetentionPolicy.RUNTIME:将注解记录class文件里 当Java程序运行时保留这个注解
使用示例:
package test;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}
3.@Documented
执行javadoc命令时,被该原注解修饰的自定义注解将会生成在文档里
示例:
package test;
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.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Test {
String info();
}
//代码分界线
package test;
@Test(info="皮一下真开心")
public class User {
@Test(info="你猜猜看啊")
public void user() {
}
}
执行以上代码的javadoc命令后文档内会生成以下内容
4.@Inherited
如果父类所使用的注解有该注解修饰则该注解可以继承给子类 否则不能继承
自定义注解
注解的语法结构:
[public] @interface 注解名 {
[属性1;]
[属性2;]
...
[属性n;]
}
属性语法结构:
数据类型 属性名() [default 默认属性值];
注意:注解属性没有默认值
若没有默认值则在使用该注解时需要给该注解属性赋值
如果注解属性名为value,则使用该注解时可以直接赋值
如果注解属性的数据类型为数组类型,赋多个值时必须使用{}括起来;但若只赋一个值,则无需使用{}