java中的注解
注解:
Java 注解用于为 Java 代码提供元数据。
作为元数据,注解不直接影响你的代码执行,但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。
注解定义:
注解通过 @interface 关键字进行自定义.
//创建一个名为TestAnnotation的注解
1 pubic @interface TestAnnotation{ 2 }
java中的常见注解
jdk的自带注解
- @Override:告诉编译器我重写了接口方法
- @Deprecated:告诉编译器这个方法过时了,不建议使用,Ide会在方法上划横线
- @SuppressWarnings("deprecation"):关闭方法中出现的警告
下面列出@SuppressWarnings注解参数的几个常见用法
例:@SuppressWarnings(value={ "rawtypes", "unchecked" }) 1.deprecation:去除不暂成使用类的警告 2.serial:当在可序列化的类上缺少 serialVersionUID 定义时的警告 3.finally:任何 finally 子句不能正常完成时的警告 4.rawtypes:去除传参数时也要带泛型 5.unchecked:执行了未检查的转换时的警告,例如当使用集合时没有用泛型来指定集合保存的类型 6.unused:去除对未使用代码的警告 7:all:去除所有类型的警告
元注解:Meta Annotation
元注解的作用就是注解其他注解,一般我们使用自定义注解时,就需要用元注解来标注我们自己的注解,一共有以下五个元注解:
@Retention、@Documented、@Target、@Inherited
1.@Target:指定了注解运用的地方
说明了Annotation被修饰的范围,限定了运用场景.
可被用于 packages、types(类、接口、枚举、Annotation类型)、
类型成员(方法、构造方法、成员变量、枚举值)、
方法参数和本地变量(如循环变量、catch参数)。
在Annotation类型的声明中使用了target可更加明晰其修饰的目标, @Target取值:
例:@Target(ElementType.TYPE) 1.ElementType.ANNOTATION_TYPE 可以给一个注解进行注解 2.ElementType.CONSTRUCTOR:用于描述构造器 3.ElementType.FIELD:用于描述域(类的成员变量) 4.ElementType.LOCAL_VARIABLE:用于描述局部变量(方法内部变量) 5.ElementType.METHOD:用于描述方法 6.ElementType.PACKAGE:用于描述包 7.ElementType.PARAMETER:用于描述参数 8.ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明
2.@Retention:描述注解的声明周期
定义了该Annotation被保留的时间长短,有些只在源码中保留,有时需要编译成的class中保留,有些需要程序运行时候保留。
@Retention
作用:表示需要在什么级别保存该注释信息,用于描述注解的生命周期(即:被描述的注解在什么范围内有效)
例:@Retention(RetentionPolicy.RUNTIME) 1.RetentionPoicy.SOURCE:在源文件中有效(即源文件保留),在编译器进行编译的时候它将被忽视丢弃 2.RetentionPoicy.CLASS:在class文件中有效(即class保留),只保留到编辑进行的时候,不会加载到jvm中 3.RetentionPoicy.RUNTIME:在运行时有效(即运行时保留),会被加载到JVM中,所以在程序运行时可以获取到
1 @Retention(RetentionPolicy.RUNTIME) 2 public @interface TestAnnotation{ 3 }
//指明了该注解的时间周期
3.@Documented
@Documented
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。@Documented
是一个标记注解,没有成员。
4.@Inherited
Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
1 import java.lang.annotation.Inherited; 2 import java.lang.annotation.Retention; 3 import java.lang.annotation.RetentionPolicy; 4 @Inherited 5 @Retention(RetentionPolicy.RUNTIME) 6 public @interface Test {} 7 8 @Test 9 class A{} 10 11 class C extends A{}
//注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。
父类的类上 和方法上 有自定义注解, 并且被@inherited标记, 那么子类只有继承的情况下才会继承父类的注解.
重写,重载,实现父类方法这些都不会继承父类注解.
自定义注解
格式:
public @interface 注解名{定义体}
使用@interface定义一个注解,自动继承了java.lang.annotation.Annotation接口,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short) 2.String类型 3.Class类型 4.enum类型 5.Annotation类型 6.以上所有类型的数组
定义注解成员的注意点: 第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型;
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface userName { String value() default ""; }
第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组。
//定义一个枚举 public enum RequestMethod { GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE } @Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Mapping public @interface RequestMapping { String name() default ""; String[] path() default {}; RequestMethod[] method() default {};//枚举数组 }
第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号。
注解的默认值
注解元素必须有确定的值,要么指定时给默认值,要么使用时给值。不过有时候我们需要确定表达一个元素不存在值,所以使用空字符串或者负数表示某个元素不存在,在定义注解时,这已经成为一个约定用法。
@Target(ElementType.FIELD) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface User { public int id() default -1; public String name() default ""; public String address() default ""; }