注解(annotation),也叫元数据。一种代码级别的说明。它是jdk1.5及以后版本引入的一个特性,与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面,用来对这些元素进行说明,注释。
我们可以把注解理解为代码里的特殊标记,这些标记可以在编译,类加载,运行时被读取,并执行相应的处理。通过注解,开发人员可以在不改变原有代码和逻辑的情况下,在源代码中嵌入补充信息。
1、注解的作用
编写文档:通过代码里标识的注解生成文档【生成文档doc文档】
代码分析:通过代码里标识的注解对代码进行分析【使用反射】
编译检查:通过代码里标识的注解让编译器能够实现基本的编译检查【@override】
2、jdk中预定义的注解
@override
检测被该注解标注的方法是否是继承自父类(接口)的。
@deprecated
该注解标识的内容,表示已过时,使用的时候,会有一个横线。
suppresswarnings
压制警告,一般传递参数all @suppresswarnings(“all”)。
(视频教程推荐:java视频)
3、自定义注解
格式
public @interface 注解名称 { 属性列表;}
本质:注解本质上就是一个接口,该接口默认继承annotation接口,可以通过javap 类名.class命令反编译class文件
public interface myanno extends java.lang.annotation.annotation { }
属性:
注解中的属性,就是接口中的抽象方法。
要求:
属性的返回值类型只能是以下类型
基本数据类型
string
枚举
注解
以上类型的数组
public @interface myanno { int age(); string name(); //枚举类型 person per(); //注解类型 myanno2 anno2(); //数组类型 string[] strs();}//枚举类personpublic enum person { p1,p2;}
注意:
定义了属性,在使用时必须给属性赋值,多个属性之间用逗号隔开,所以,一般注解中方法名一般取成属性名;
如果定义属性时,使用default关键字给属性默认初始化值,则使用时,可以不用给属性赋值;
如果只有一个属性需要赋值,并且属性的名称是value,则value可以省略,直接定义属性值;
数组赋值时,值使用{}包裹。如果数组中只有一个值,则{}可以省略。
@myanno(age=20, name="zhangsan", per=person.p1, anno2=@myanno2, strs={"zhangsan","lisi"})public class test {}
元注解:用于描述注解的注解
@target
当前被描述的注解能够作用的位置,该注解只有一个属性是value,返回值是elementtype枚举类型的数组。
elementtype 的常用值:
type:可以作用于类上
method:可以作用于方法上
field:可以作用于成员变量上
@rentention
描述注解被保留的阶段,该注解只有一个属性value,返回值是retentionpolicy枚举类型
retentionpolicy 的值
source:当前被描述的注解,不会保留到class文件中
class:当前被描述的注解,会保留到class字节码文件中,但是不会被jvm读取到
runtime:当前被描述的注解,会保留到class字节码文件中,并被jvm读取到,自定义的值,一般都取这个值
@documented
当前被描述的注解是否被抽取到api文档中
@inherited
当前被描述的描述注解是否被子类继承
一般经常用到的是前两个元注解。
4、注解的使用
在程序中使用注解:获取这几中定义的属性值
// pro 注解@target(elementtype.type)@retention(retentionpolicy.runtime)public @interface pro { string classname(); string methodname();}//在程序中使用注解@pro(classname="anli.demo1", methodname = "show1")public class useanno { public static void main(string[] args) throws exception { //获取这个类的class对象 class<useanno> useannoclass = useanno.class; //获取指定的注解类子类对象 pro proanno = useannoclass.getannotation(pro.class); //执行注解中的方法,获取注解中属性的值 string classname = proanno.classname(); string methodname = proanno.methodname(); }
通过class类中的getannotation()方法,获得的是注解类的实现类的对象,有了对象,就可以执行注解中的方法,返回值就是使用注解时设置的属性值。其实就是在内存中生成了一个该注解接口的子类实现对象
public class proimpl implements pro{ public string classname(){ return "cn.itcast.annotation.demo1"; } public string methodname(){ return "show"; } }
推荐教程:java开发入门
以上就是如何更好地使用java注解的详细内容。
