学习笔记之注解

一. 什么是注解

Annotation是JDK1.5开始引入的新技术

Annotation的作用:
  1. 不是程序本身,可以对程序作出解释。这一点与注释没什么区别。注释是给程序猿看的,注解是给机器看的。
  2. 可以被其他程序(比如编译器等)读取。注解信息处理流程,是注解和注释的重要区别。如果没有注解信息处理流程,则注解毫无意义。
Annotation的格式:
  1. 注解是以“@注释名”在代码中存在的,如:@Test
  2. 还可以添加一些参数信息。如:String value default "";

二. 内置注解:

1. @Override
2. @Deprecated
3. @SuppressWarnings:
  • deprecation:使用了过时的方法或类的警告
  • unchecked:执行了未检查的转换时的警告,如果使用集合时未指定泛型。
  • fallthrough:当使用switch语句使用时发生case穿透
  • path:在类路径、源文件路径等中有不存在路径的警告
  • serial:当在序列化的类上确山serialVersionUID定义时的警告
  • finally:任何finally子句不能完成时的警告
  • all:以上所有情况
4. @SafeVarargs:JDK1.7后新增,用于压制泛,堆内存污染。
5. @FunctionalInterface:JDK1.8后增加,指定是函数式编程接口

三、元注解

1. @Retention:保留期

RetentionPolicy.SOURCE:源码
RetentionPolicy.CLASS:class文件
RetentionPolicy.RUNTIME:运行时

2. @Target:目标

ElementType.ANNOTATION_TYPE:类型成员(方法、构造方法、成员变量、枚举值)
ElementType.CONSTRUCTOR:类型成员(方法、构造方法、成员变量、枚举值)
ElementType.FIELD:类型成员(方法、构造方法、成员变量、枚举值)
ElementType.LOCAL_VARIBALE:方法参数、本地变量
ElementType.METHOD:类型成员(方法、构造方法、成员变量、枚举值)
ElementType.PACKAGE:包
ElementType.PARAMETER:方法参数、本地变量
ElementType.TYPE:类、接口、枚举、Annotation

3. @Documented
4. @Inherited

Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。 说的比较抽象。代码来解释。
注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A,类 B 也拥有 Test 这个注解。

/* * @Inherited测试*/
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {
    
}
@Test
public class A {
    
}
public class B extends A {
    
}
5. @Repeatable:JDK1.8新增元注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Persons {
    Person[] value();
}

@Repeatable(Persons.class)
public @interface Person {
    String role() default "";
}

/**
 * 测试多重角色,JDK1.8后新特性
 */
@Person(role = "coder")
@Person(role = "artist")
@Person(role = "singging")
public class SuperMan {

}

/**
 *  测试JDK1.8后的新增元注解
 */
public class RetentionTest {
    public static void main(String[] args) throws ClassNotFoundException {
        //获取class对象,下获取注解
        Class<?> clazz = Class.forName("com.dayDayUp.annotation.retentionAnno.SuperMan");
        System.out.println("=====================是否是注解========================");
        boolean flag1 = clazz.isAnnotationPresent(Person.class);//是否是注解
        boolean flag2 = clazz.isAnnotationPresent(Persons.class);
        System.out.println(flag1);
        System.out.println(flag2);
        System.out.println("=====================是否是注解========================");
        boolean c1 = clazz.isAnnotation();
        boolean c2 = Person.class.isAnnotation();
        System.out.println(c1);
        System.out.println(c2);
        System.out.println("=====================clazz.getAnnotation()========================");
        Person person = clazz.getAnnotation(Person.class);
        Persons persons = clazz.getAnnotation(Persons.class);
        //String role = person.role();
        //System.out.println("person:" + role);
        //Class<? extends Annotation> ca1 = person.annotationType();
        //System.out.println("person:" + ca1);
        //Person[] personArr = persons.value();
        //System.out.println("persons:" + personArr);
        //for (Person p1 : personArr) {
        //    System.out.println(p1.role());
        //    System.out.println(p1.annotationType());
        //}
        //System.out.println("persons:" +persons.annotationType());
        System.out.println(person);
        System.out.println(persons);
        System.out.println("=====================clazz.getAnnotations()========================");
        Annotation[] annotations = clazz.getAnnotations();
        for (Annotation annotation1 : annotations) {
            System.out.println(annotation1.annotationType());
        }
    }
}

四. 注解的分类

根据注解参数的个数,我们可以将注解分为三类:
  1. 标记注解:一个没有成员定义的Annotation类型被称为标记注解。这种Annotation类型仅使用自身的存在与否来为我们提供信息。比如后面的系统注解@Override;
  2. 单值注解
  3. 完整注解
根据注解使用方法和用途,我们可以将Annotation分为三类:
  1. JDK内置系统注解
  2. 元注解
  3. 自定义注解

五. 注解与反射

获取Class对象:Class<?> clazz = Class.forName("com.dayDayUp.annotation.retentionAnno.SuperMan");
判断Class对象是否是注解:boolean flag2 = clazz.isAnnotationPresent(Persons.class);
判断Class对象是否是注解:boolean c2 = Person.class.isAnnotation();
获取指定注解:**``Person person = clazz.getAnnotation(Person.class);
获取所有注解:Annotation[] annotations = clazz.getAnnotations();
获取注解类型:annotation1.annotationType();

六. 自定义注解

@Target(value =ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface StuFiled {
    String cloumnName();
    String type();
    int length();
}

@StuTable("t_student")
public class Student {
    @StuFiled(cloumnName="id" ,type = "int" ,length = 6)
    private int id;
    @StuFiled(cloumnName="id" ,type = "String" ,length = 18)
    private String name;
    @StuFiled(cloumnName="id" ,type = "String" ,length = 2)
    private int age;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    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;
    }
}

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
/**
 * @Description: 使用反射读取注解的信息,模拟处理注解信息的流程
 */
public class Demo1 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class<?> clazz = Class.forName("tf56.partyManage.study.annotation.Student");
        //获取这个类所有的有效注解注解(获得了类上的注解)
        //@tf56.partyManage.study.annotation.StuTable(value=t_student)
        Annotation[] annotations = clazz.getAnnotations();
        for (Annotation annotation : annotations){
            System.out.println(annotation);
        }
        //获取类的指定的注解
        StuTable st = clazz.getAnnotation(StuTable.class);
        System.out.println(st);
        System.out.println(st.value());

        /**
         * 获取类的属性的注解
         *  1、首先通过反射获取file,属性
         *  2、通过file获取对应属性上的注解
         *  2、获取注解的值
         *  反射
         */
        Field f = clazz.getDeclaredField("name");
        System.out.println(f);
        StuFiled sf = f.getAnnotation(StuFiled.class);
        System.out.println(sf.cloumnName());
        System.out.println(sf.type());
        System.out.println(sf.length());
    }
}
#案例二
public class NoBug {
    @Jiecha
    public void suanShu(){
        System.out.println("1234567890");
    }
    @Jiecha
    public void jiafa(){
        System.out.println("1+1="+1+1);
    }
    @Jiecha
    public void jiefa(){
        System.out.println("1-1="+(1-1));
    }
    @Jiecha
    public void chengfa(){
        System.out.println("3 x 5="+ 3*5);
    }
    @Jiecha
    public void chufa(){
        System.out.println("6 / 0="+ 6 / 0);
    }
    public void ziwojieshao(){
        System.out.println("我写的程序没有 bug!");
    }
}

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {

}

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
public class TestTool {
   public static void main(String[] args) {
        // TODO Auto-generated method stub
        NoBug testobj = new NoBug();
        Class clazz = testobj.getClass();
        Method[] method = clazz.getDeclaredMethods();
        //用来记录测试产生的 log 信息
        StringBuilder log = new StringBuilder();
        // 记录异常的次数
        int errornum = 0;
        for ( Method m: method ) {
            // 只有被 @Jiecha 标注过的方法才进行测试
            if ( m.isAnnotationPresent( Jiecha.class )) {
                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);
                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    log.append(m.getName());
                    log.append(" ");
                    log.append("has error:");
                    log.append("\n\r  caused by ");
                    //记录测试过程中,发生的异常的名称
                    log.append(e.getCause().getClass().getSimpleName());
                    log.append("\n\r");
                    //记录测试过程中,发生的异常的具体信息
                    log.append(e.getCause().getMessage());
                    log.append("\n\r");
                } 
            }
        }
        log.append(clazz.getSimpleName());
        log.append(" has  ");
        log.append(errornum);
        log.append(" error.");
        // 生成测试报告
        System.out.println(log.toString());

    }

}

测试的结果是:

1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:
caused by ArithmeticException
/ by zero
NoBug has 1 error.

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

推荐阅读更多精彩内容