Java——注解(Annotation)入门学习

学习资料:

注解(Annotation)也被称为元数据,提供一种在代码中添加信息的形式化方法,在之后某个时刻可以方便地使用这些数据

元数据是描述数据的数据

注解是在Java SE5中添加,可以完整地描述程序所需要而Java代码无法来表达的信息。注解仅仅是元数据,与逻辑代码没有任何关系


1.基本语法 <p>

没有元素的注解称为标记注解
Java中有4种元注解

元注解的作用就是负责注解其他注解 :(

元注解 作用
@Target 表示该注解可以用在什么地方
ElementType包括:
CONSTRUCTOR --> 构造器的声明
FIELD --> 域声明
LOCAL_VARLABLE --> 局部变量声明
METHOD --> 方法声明
PACKGE --> 包声明
PARAMETER --> 参数声明
@Retention 表示需要在什么级别保存该注解信息
可选的RetentionPolicy参数包括:
SOURCE --> 注解被编译丢弃
CALSS --> 注解在class文件中可以用,但会被VM丢弃
RUNtIME --> VM将在运行时期保留注解,可以通过反射机制读取注解的信息
@Documented 将此注解包含在Javadoc中
@Inherited 允许子类继承父类中的注解,默认为false

需要注意CLass,RUNTIME


1.1 RUNTIME,运行时注解

运行时注解,简单案例:

//定义注解
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
    public int id();
    public String description() default "no description";
}

//使用
public class PasswordUtils {
    @UseCase(id=47,description = "Password must contain at least one numeric")
    public static boolean validatePassword(String password){
        return (password.matches("\\w*\\d\\w*"));
    }
    @UseCase(id = 48)
    public static String encryptPassword(String password){
       return new StringBuilder(password).toString();
    }
    @UseCase(id= 49,description = "New passwords can't equals previously used ones")
    public static boolean checkForNewPassword(List<String>list,String password){
        return !list.contains(password);
    }
}


编写注解处理器:

public class UseCaseTracker {
    public static void trackUseCases(List<Integer>lsit,Class<?>cl){
        for (Method m : cl.getDeclaredMethods()){
            UseCase uc = m.getAnnotation(UseCase.class);
            if (null != uc){
                System.out.println("Found use case-"+uc.id() +" "+uc.description());
                lsit.remove(new Integer(uc.id()));
            }

        }
        for (int i:lsit){
            System.out.println("Warning : Missing use case - "+i);
        }
    }
    public static void main(String[]args){
        List<Integer>list = new ArrayList<>();
        Collections.addAll(list,47,48,49,50);
        trackUseCases(list,PasswordUtils.class);
    }
}

利用两个反射方法:getDeclaredMethods()getAnnotation()

getAnnotation()方法返回的结果就是注解对象,这里就是UseCase。如果被注解的方法上没有该类型的的注解,返回null

运行结果:

Found use case-47 Password must contain at least one numeric
Found use case-48 no description
Found use case-49 New passwords can't equals previously used ones
Warning : Missing use case - 50

1.2 CLASS,编译时注解 <p>

挖坑 ,等会用了再,来填坑


1.3 注解元素 <p>

在上面的例子中,@UseCase是由UseCase.java定义的,在里面有int元素id,以及String元素description

在注解中,注解元素可以使用的类型:

  • 所有的的基本数据类型(int,float,boolean等)
  • String
  • enum
  • Annotation

使用其他的类型,编译器会报错。注意:不允许使用任何包装类型,由于存在自动打包,这并不是限制。

注解也可以作为元素的类型,也就是说注解可以嵌套


1.4 默认值限制 <p>

编译器对注解元素的默认值很挑剔:

  1. 元素不能有不确定的值。元素要么有默认值,要么在使用注解时提供了值
  2. 非基本类型的元素,无论是在代码中声明时,还是在注解接口中定义默认值时,都不能为null

约束:
这些限制导致无法直接表现一个元素的存在和确实状态

因为在每个注解的声明中,所有的元素的都存在,并且又确定的值

为避开这个约束,可以自己定义一些特殊的值来标示元素存在或者缺失,例如:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SimulatingNull{
    public int id() default -1;
    public String description() default "";
}

在定义注解时,这是一个习惯用法


2.最后 <p>

编译时注解还要再次进行学习,感觉比运行时注解要难,回头进行学习

本人很菜,有错误请指出

共勉 :)

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

推荐阅读更多精彩内容