自定义注解

自定义注解的解释1

自定义Annotation
注解应用需要三个步骤:
1)、编写注解
2)、在类上应用注解
3)、对应用了注解的类进行反射操作的类

自定义Annotation的语法:
访问控制权限 @interface Annotation名称{}
举例:
public @interface MyAnnotation{}

1、在Annotation中定义变量{变量名称后面注意要用小括号()}
public @interface MyAnnotation{
    public String name();
    public String info();
}
定义变量后,在调用此Annotation时必须设置变量值
@MyAnnotation(name="vince",info="hello")
public class Demo{}

通过Default指定变量默认值,有了默认值在使用注解时就可以不设置
public @interface MyAnnotation{
    public String name() default "vince"
    public String info() default "hello"
}

2、在Annotation中定义一个数组
public @interface MyAnnotation{
    public String[] name();
}
在使用注解时需要指定数组的值
@MyAnnotation(name={"jack","vince"})
public class Demo{}

3、使用枚举限制变量取值范围
public enum Color{
    RED,GREEN,YELLOE
}
public @interface MyAnnotation{
    public Color color();
}

4、Retention和RetentionPolicy
注解的作用范围通过@Retention指定,而Retention指定的范围由RetentionPolicy决定,RetentionPolicy指定了三种范围:
RetentionPolicy.SOURCE   //在java源程序中存在
RetentionPolicy.CLASS    //在java生成的class中存在
RetentionPolicy.RUNTIME  //在java运行的时候存在
举例:
@Rentention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation{
    public String name();
}

自定义注解的解释2

5、反射使自定义注解生效
一个Annotation注解整整起作用,必须结合反射机制,在反射中提供了以下的操作方法:
public boolean isAnnotationPresent()  //判断是否是指定的Annotation
public Annotation getAnnotation()     //得到指定的Annotation
public Annotation[] getAnnotations()  //得到全部的Annotation

6、
@Documented 注解表示以上的注释会生成文档用

7、
@Target注解表示的是一个Annotation的使用范围,例如:之前定义的MyAnnotation可以在任意的位置上使用
ElementType.TYPE            //只能在类或接口或枚举上使用
ElementType.FIELD           //在成员变量中使用
ElementType.METHOD          //在方法中使用
ElementType.PARAMETER       //在参数中使用
ElementType.CONSTRUCTOR     //在构造中使用
ElementType.LOCAL_VARIABLE  //在局部变量上使用
ElementType.ANNOTATION      //只能在Annotation中使用
ElementType.PACKAGE         //只能在包中使用

8、
@Inherited注解:表示一个Annotation是否允许被其子类继承下来

自定义注解MyAnnotation.java

import java.lang.annotation.*;

//自定义注解
@Documented   //该注解表示:上方的注释会生成文档用
@Retention(RetentionPolicy.RUNTIME) //该注解表示:以下自定义的注解作用范围是在运行的时期
@Target({ElementType.TYPE,ElementType.METHOD})
@Inherited    //该注解表示:可以被其子类继承
public @interface  MyAnnotation {
    //定义自定义注解的变量
    public String name();
    public int age() default 2; //给变量设置默认值
    public String[] like();     //定义一个数组变量
    public Color color();       //定义一个枚举类型的变量
}

应用自定义注解

@MyAnnotation(name="vince",like={"鲫鱼","金鱼"},color=Color.BLACK)  //应用自定义注解
public class Cat {
    private String name;
    private int age;
    private Color color;
    private String[] like;

    public Cat(){ }

    public Cat(String name, int age, Color color, String[] like) {
        this.name = name;
        this.age = age;
        this.color = color;
        this.like = like;
    }


    public Color getColor() {
        return color;
    }
    public void setColor(Color color) {
        this.color = color;
    }

    public String[] getLike() {
        return like;
    }

    public void setLike(String[] like) {
        this.like = like;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override   //该注解表示:用于验证方法是否覆盖父类的方法
    public String toString() {
        return "Cat{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", color=" + color +
                ", like=" + Arrays.toString(like) +
                '}';
    }

    @Deprecated  //该注解表示:该方法已过时不建议再使用
    public String printInfo(){
        return "Cat{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

反射注解的应用

import org.junit.Test;
import java.lang.reflect.Method;

public class AnnotationDemo {
    @Test
    public void test() {
        Cat cat = new Cat("bin", 3,Color.YELLOW, new String[]{"鲫鱼", "金鱼"});
        cat.printInfo(); //这里划横线就表示该方法在源类中已被注解为过时的方法,但是强制调用也可以
    }

    @Test
    public void test2(){
        //源目标类的反射都到Class类
        Class<Cat> catClass = Cat.class;
        //获取类上应用的指定的注解
        MyAnnotation annotation = catClass.getAnnotation(MyAnnotation.class);
        //获取注解上的指定的变量值
        int age = annotation.age();
        Color color = annotation.color();
        String name = annotation.name();
        String[] like = annotation.like();

        try {
            //反射的newInstance方法获取原目标类的对象
            Cat cat = catClass.newInstance();
            //将注解里的变量值设置给类的属性
            cat.setAge(age);
            cat.setName(name);
            cat.setColor(color);
            cat.setLike(like);
            System.out.println(cat.toString());

        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        }

    }

    @Test
    public void test3(){
        try {
            Class<?> aClass = Class.forName("com.vince.Annotation.Cat");
            //反射找到指定的源目标类的方法setName()
            Method sn = aClass.getMethod("setName",String.class);
            if(sn.isAnnotationPresent(MyAnnotation.class)){ //判断源目标类的setName()方法是否是使用了指定的MyAnnotation
                MyAnnotation annotation = (MyAnnotation)sn.getAnnotation(MyAnnotation.class);
                String name = annotation.name();
                Cat cat = (Cat)aClass.newInstance();
                cat.setName(name);
                System.out.println(name);

            }

        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        }


    }

}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容