Java注解

1.注解

Java注解又称为java标注,是在JDK5.0引入的一种注释机制。在Java程序中,无论是类,方法,变量还是包等都可以通过注解进行标注,然后可以通过反射获取标注的内容;
注解在编译器编译时被嵌入到字节码文件中,Java虚拟机将其保留下来,在运行时可以获取到对应的内容,同时支持开发人员自定义注解进行辅助开发;
Java 中自带的注解有:@Override、@ Deprecated 等;
Spring 框架中定义的注解有:@Repository、@Component、@Controller 等;
这些注解均是基于元注解来定义的;

2.元注解

元注解是用于修饰注解的注解,所有的自定义注解均由元注解来辅助定义,可以类比为Java的保留字,自定义注解类似用户定义的Function;
元注解有以下几种:
@Retention - 可以简单理解为设置注解的生命周期,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
@Documented - 标记这些注解是否包含在用户文档中。
@Target - 表示这个注解可以修饰哪些地方(比如方法、还是成员变量、还是包等等)
@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

元注解及其他注解均继承于Annotation接口(其UML图如下):


元注解.png

其接口定义如下:

package java.lang.annotation;
public interface Annotation {

    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

同时Annotation 包中提供了两个关键枚举类,用于声明注解的生命周期及作用范围:ElementType枚举类 及 RetentionPolicy枚举类

RetentionPolicy枚举类,作用于@Retention,表示注解的生命周期范围

package java.lang.annotation;
public enum RetentionPolicy {
    SOURCE,            /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了  */

    CLASS,             /* 编译器将Annotation存储于类对应的.class文件中,即在 class 文件中有效。默认行为  */

    RUNTIME            /* 编译器将Annotation存储于class文件中,并且可由JVM读入,即在运行时有效 */
}

ElementType枚举类:作用于@Target,表示该注解申明的目标作用位置

package java.lang.annotation;

public enum ElementType {
    TYPE,               /* 类、接口(包括注释类型)或枚举声明  */

    FIELD,              /* 字段声明(包括枚举常量)  */

    METHOD,             /* 方法声明  */

    PARAMETER,          /* 参数声明  */

    CONSTRUCTOR,        /* 构造方法声明  */

    LOCAL_VARIABLE,     /* 局部变量声明  */

    ANNOTATION_TYPE,    /* 注释类型声明  */

    PACKAGE             /* 包声明  */
}

2.1 自定义注解

通过元注解,我们可以自定义注解来实现一些功能,例如我们需要监控方法的耗时情况,可以自定义一个Monitor注解,被该注解标注的方法均是需要监控的:

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Monitor {

    String getClassName() default  "";

    String getFunctionName() default "";
}

@Target(ElementType.METHOD) 表明注解是作用于方法的,如果用在字段或类上会报错;
@Retention(RetentionPolicy.RUNTIME) 表明注解会在运行时生效,编译期间及生成的字节码文件中均包含该注解信息;
@Inherited 表明注解会被子类继承, 父类中被Monitor修饰的方法,其子类继承的方法也会包含该注解,但如果子类对父类方法进行重写则不再生效;
@Documented 表明注解类会被 JavaDoc 工具提取成文档

2.2 AOP

AOP是Aspect Oriented Programming的缩写,意思是:面向切面编程,它是通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术,其中常见的术语有:

Target(目标对象): 即要增强的对象
Proxy(代理对象): 增强以后的对象
JoinPoint(连接点): 可以被增强的方法
PointCut(切入点): 要被增强的方法
Weaving(织入): 切入点集成到切面形成代理类的过程
Aspect(切面): 切入点+通知/增强 = 切面(即里面有要被增强的方法,以及增强方法具体的增强代码程序)
Advice(通知/增强): 切面功能的具体实现,即增强的功能定义

以上概念之间的关系可以用下图来表示:


关系图.png

2.3 AOP与自定义注解的结合

在将AOP应用到业务场景时,需要定义具体的切入点,仍然以记录监控耗时场景为例,我们需要声明是对哪些方法进行耗时统计,在Java中提供了相应的表达式来对切入点进行定义:

@Aspect
@Component
public class MonitorAspect {

    @Pointcut("execution(* entity.Student.selfIntroduction())")
    private void studentPointCut() {
    }

    @Around("studentPointCut()")
    public Object around(ProceedingJoinPoint pjp) throws Throwable{
        System.out.println("统计指定方法耗时的具体逻辑实现");
        Object o = null;
        try{
            o = pjp.proceed();
        } catch (Exception ex) {
            throw ex;
        }
        return o;
    }

    @Pointcut("@annotation(annotation.Monitor)")
    private void monitorAnnotationAspect() {
    }

    @Around("monitorAnnotationAspect()")
    public Object aroundV2(ProceedingJoinPoint pjp) throws Throwable{
        System.out.println("统计指定方法耗时的具体逻辑实现");
        Object o = null;
        try{
            o = pjp.proceed();
        } catch (Exception ex) {
            throw ex;
        }
        return o;
    }
}

MonitorAspect 切面定义了两个切入点,首先看第一个切入点studentPointCut:该声明是对实体类Student. selfIntroduction方法进行增强,统计该方法的耗时,当要统计耗时的方法较多时,使用该方式的切面表达式会比较繁琐且每增加一个方法的统计均需要在此进行注册;如果结合自定义注解,我们可以很简洁的来实现该功能,通过第二个切入点monitorAnnotationAspect的定义,只要被@Monitor注解修饰的方法,均为切入点,如果后续出现新方法需要统计耗时,仅需使用@Monitor修饰方法变可以达到;

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

推荐阅读更多精彩内容

  • 一、什么是注解 Java 注解是在 JDK5 时引入的新特性,注解(也被称为元数据)为我们在代码中添加信息提供了一...
    Good龙辉阅读 765评论 0 0
  • @Aspect注解就是常说的面向切面编程方面的一个注解,被这个注解标记的类会被容器当做一个切面读取。 这里顺带解释...
    爆米花烫嘴阅读 2,510评论 0 1
  • 对于注解不了解的,可以看一下这篇文章:IOC依赖注入[https://blog.csdn.net/qq_22090...
    wuchao226阅读 488评论 0 0
  • 前序: 很开心下了班以后坐在电脑前面写这篇文章。注解Annotation我们常常见到jdk中的@override、...
    hello_coke阅读 1,435评论 1 16
  • 概要 这篇文章将会带领你了解Java注解,注解的使用,注解的解析,利用反射解析运行时注解,相信有一定Java基础的...
    jackcooper阅读 1,184评论 1 3