注解

  Java的注解在学习框架的时候很常见,一般配置信息都可以通过配置文件和注解两种方式进行配置,所以最近小码农就大致学习了一下注解。

注解的作用

  首先,注解是和类、接口同一层次的东西。它是那些插入到源代码中并且使用其他工具可以对其进行处理的标签。常见的注解都是@xxx的形式。那么具体的来说,注解常用来干什么呢?

  • 代码分析:对代码进行分析,可以取代xml文档,即配置信息。
  • 编译检查:让编译器实现基本的编译检查。例如:@Override
  • 编写文档:辅助生成解释文档。如HTML文件。

辅助生成解释文档

  按照小码农写文章的习惯,重要的知识写在前面,但分析的时候从后向前分析。所以我们先来看看第一个:生成解释文档。
  不知道大家在写注释的时候是否注意到一般作者前使用@author,版本号之前使用@since。乍一看,是不是这个就和注解的格式一样呢?而实际上,它们确实和注解有关联,在注释中标识注解能辅助我们生成解释文档,看一个小例子。
  为了方便,我们直接把Object类的注释拿来放在我们测试类头上。

/**
 * Class {@code Object} is the root of the class hierarchy.
 * Every class has {@code Object} as a superclass. All objects,
 * including arrays, implement the methods of this class.
 *
 * @author  unascribed
 * @see     java.lang.Class
 * @since   JDK1.0
 */
public class First {
    public static void main(String[] args) {
        
    }
}

  点击Project -> Generation,选择javadoc command为JDK中的javadoc.exe。然后一直next到最后一页(为了防止出现:编码GBK的不可映射字符的错误)在 VM options...下的空格里写入-encoding UTF-8 -charset UTF-8。然后点击Finish就可以把注释导出成HTML文件。

-encoding UTF-8 -charset UTF-8
HTML文档

  不过,它里面的注释也不是乱写的,比如你有一个@date,但这个标识不是默认的,生成HTML文档时会出现“未知标记: date”错误,这时候需要在导出时配置一下。也是在最后一页,Extra Javadoc options...下的空里加上“-tag date:a:日期”就可以了,它的语法是:-tag 注释中写的标签:a:文档中的标签 。

配置未知标记

元注解&属性

  在学注解的其他作用时,我们先来看看几个注解的注解,也就是写在注解上的注解。注解和类、接口处在同一层次,自然也可以自定义,自定义的时候对注解也可以加上注解,这些能加在注解上的注解被叫做元注解。

元注解

  以上的元注解便是这个注解是源码级别的。元注解共有四个,如下:

  • @Retention():确定被修饰的自定义注解的生命周期。
  • @Target():确定被被修饰的自定义注解的使用位置。
  • @Documented:使用javadoc生成文档需要包含此注解。
  • @Inherited:被修饰的子类继承父类的注解。

  属性就是我们在圆括号里加入的说明语句,用来说明这个注解的某些性质。

元注解 属性
@Retention() RetentionPolicy.XXX
SOURCE、CLASS、RUNTIME
@Target() ElementType.XXX
TYPE、FIELD、METHOD、PARAMETER、PACKAGE、
LOCAL_VARIABLE、ANNOTATION_TYPE、CONSTRUCTOR、TYPE_PARAMETER、TYPE_USE

编译检查

  第二点是帮助我们进行基本的编译检查,这个就很简单了,如@Override、@Deprecated、@SuppressWarnings等都是JDK提给我们的编译检查的注解,我们当然也可以自定义编译检查注解,不过不常用而且挺麻烦,所以在这省去。

代码分析

  第三点就是代码分析,这个主要用到反射的技术。接下来先看看注解的语法:

modifiers @interface AnnotationName{
    elementDeclaration1
    elementDeclaration2
    ...
}

其中元素声明必须是 type elementName(); 格式如下例:

public @interface MyAnnotation{
    boolean isTrue() defalut false;
    String[] strs();
}

  注解只是一个标签,所以我们要使用反射获取信息,必须创建一个类,在此类中使用反射获取我们想要的信息再执行。
  先定义一个注解:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyFirstAno {
    String name() default "";
}

  再写一个测试类:

public class TestMyFirstAno {
    @MyFirstAno(name="詹金浩")
    public void show(String str) {
        System.out.println("this is " + str + "...");
    }
}

  再反射执行

public class MyFirstAnoParser {
    public static void main(String[] args) throws Exception {
        Class<TestMyFirstAno> clazz = TestMyFirstAno.class;
        Method method = clazz.getMethod("show", String.class);
        MyFirstAno ano = method.getAnnotation(MyFirstAno.class);
        String name = ano.name();
        
        Constructor<TestMyFirstAno> constructor = clazz.getConstructor();
        TestMyFirstAno instance = constructor.newInstance();
        method.invoke(instance, name); //Console : this is 詹金浩...
    }
}

  对于Java EE码农来说,注解只要会用就可以了,所以本文只做浅要分析。

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

推荐阅读更多精彩内容