Java的自定义注解编写、使用、获取

来源:互联网 发布:js 模块化开发 编辑:程序博客网 时间:2024/04/18 21:11

一、:自定义注解的编写。

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;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)@Documentedpublic @interface HBK {    public String name() default "凤姐";    public int age() default 88;    public boolean isMan() default false;}

(1)一个是语法问题,一定要使用@interface注解(国家规定)。
(2)@Target说明了Annotation所修饰的对象范围:Annotation可被用于
packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。可以通过ElementType枚举设置。
1.CONSTRUCTOR:用于描述构造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部变量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述参数
7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Retention定义了该Annotation被保留的时间长短:某些Annotation仅出现在源代码中,而被编译器丢弃;而另一些却被编译在class文件中;编译在class文件中的Annotation可能会被虚拟机忽略,而另一些在class被装载时将被读取(请注意并不影响class的执行,因为Annotation与class在使用上是被分离的)。使用这个meta-Annotation可以对
Annotation的“生命周期”限制。可以通过RetentionPolicy枚举设置。
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在运行时有效(即运行时保留)

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API,因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解,没有成员。
@Inherited元注解是一个标记注解,@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
注意:@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation,方法并不从它所重载的方法继承annotation。
当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME,则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时,反射代码检查将展开工作:检查class和其父类,直到发现指定的annotation类型被发现,或者到达类继承结构的顶层。

二、自定义注解的使用

import com.hbk.test.annotation.HBK;public class Person {    @HBK(age=28,name="黄宝康",isMan=true)    private Person huangbaokang;    @HBK    private Person fengjie;}

三、注解信息的获取

import java.lang.reflect.Field;import com.hbk.test.annotation.HBK;public class Test {    public static void main(String[] args) throws Exception {        Person p = new Person();        // 获取Person的Class实例        Class<? extends Person> c = p.getClass();        // 通过Class获取成员变量Field        Field field_huangbaokang = c.getDeclaredField("huangbaokang");        Field field_fengjie = c.getDeclaredField("fengjie");        // 通过Field获取注解        HBK huangbaokang = field_huangbaokang.getAnnotation(HBK.class);        HBK fengjie = field_fengjie.getAnnotation(HBK.class);        // 通过注解获取值        String huangbaokang_name = huangbaokang.name();        int huangbaokang_age = huangbaokang.age();        boolean huangbaokang_isman = huangbaokang.isMan();        String fengjie_name = fengjie.name();        int fengjie_age = fengjie.age();        boolean fengjie_isman = fengjie.isMan();        System.out.println("huangbaokang的姓名name为="+huangbaokang_name+" 年龄age="+huangbaokang_age+" "+((huangbaokang_isman==true)?"是":"不是")+"男人");        System.out.println("fengjie的姓名name为="+fengjie_name+" 年龄age="+fengjie_age+" "+((fengjie_isman==true)?"是":"不是")+"男人");    }}

由于我们是在成员变量中加入的注解,所以测试的时候使用Fileld.getAnnotation(HBK.class),同理,如果注解放在方法上,通过Class获取到Method,然后调用Method.getAnnotation(HBK.class),测试输出的结果如下:

huangbaokang的姓名name为=黄宝康 年龄age=28 是男人fengjie的姓名name为=凤姐 年龄age=88 不是男人

可以看出,由于fengjie成员字段只是加入了@HBK注解,输出了注解定义的默认值。

原创粉丝点击