Java 注解
Java 注解
1.注解的作用:
从JDK5开始,Java增加对元数据的支持,也就是注解,注解与注释是有一定区别的,可以把注解理解为代码里的特殊标记,这些标记可以在编译,
类加载,运行时被读取,并执行相应的处理。通过注解开发人员可以在不改变原有代码和逻辑的情况下在源代码中嵌入补充信息。
2.常见的基本注解:
import java.util.ArrayList; import java.util.List; //创建线程的方式一:继承Thread类,重写run()方法,调用start开启线程 public class Demo1 extends Object{ //重写 object的toString方法 @Override public String toString(){ return super.toString(); } //Deprecated 不推荐使用 @Deprecated public static void text(){ System.out.println("Deprecated"); } //SuppressWarnings 镇压警告 根据参数的不同 可以将指定的警告消除 @SuppressWarnings("all") public void text2(){ List list = new ArrayList(); } public static void main(String[] args) { } }
2.元注解:
元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解有以下几种:
- @Target
- @Retention
- @Documented
- @Inherited
1.1 @Target
用于描述注解的范围,即注解在哪用。它说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)等。取值类型(ElementType)有以下几种:
- CONSTRUCTOR:用于描述构造器
- FIELD:用于描述域即类成员变量
- LOCAL_VARIABLE:用于描述局部变量
- METHOD:用于描述方法
- PACKAGE:用于描述包
- PARAMETER:用于描述参数
- TYPE:用于描述类、接口(包括注解类型) 或enum声明
- TYPE_PARAMETER:1.8版本开始,描述类、接口或enum参数的声明
- TYPE_USE:1.8版本开始,描述一种类、接口或enum的使用声明
示例:
@Target({ElementType.METHOD, ElementType.TYPE}) public @interface Log { ...... }
上述表示Log注解可以用在类、接口、enum和方法上
1.2 @Retention
用于描述注解的生命周期,表示需要在什么级别保存该注解,即保留的时间长短。取值类型(RetentionPolicy)有以下几种:
- SOURCE:在源文件中有效(即源文件保留)
- CLASS:在class文件中有效(即class保留)
- RUNTIME:在运行时有效(即运行时保留)
示例:
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) public @interface Log { ...... }
上述示例使用RetentionPolicy.RUNTIME,这样注解处理器可以通过反射,获取到该注解的属性值,从而去做一些运行时的逻辑处理。
1.3 @Documented
用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。它是一个标记注解,没有成员。
示例:
@Target({ElementType.METHOD, ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Log { ...... }
1.4 @Inherited
用于表示某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
2.自定义注解:
使用@interface自定义注解时,自动继承了java.lang.annotation.Annotation接口,由编译程序自动完成其他细节。在定义注解时,不能继承其他的注解或接口。
@interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型就是参数的类型(返回值类型只能
是基本类型、Class、String、enum)。可以通过default来声明参数的默认值。
定义注解格式:
public @interface 注解名 {定义体}
注解参数的可支持数据类型:
1.所有基本数据类型(int,float,boolean,byte,double,char,long,short)
2.String类型
3.Class类型
4.enum类型
5.Annotation类型
6.以上所有类型的数组
代码:
import java.lang.annotation.*; public class Demo { //注解可以显示赋值,如果没有默认值,我们就必须给注解赋值 @My(name = "xiaofu") public void text(){ } } //自定义一个注解 @Target({ElementType.TYPE,ElementType.METHOD}) //限制注解只可以在类和方法上使用 @Retention(RetentionPolicy.RUNTIME) //在运行时有效(即运行时保留)注解 @interface My{ //注解的参数 : 参数类型 + 参数名()default 默认值; String name() default ""; int age() default 0; }