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码农来说，注解只要会用就可以了，所以本文只做浅要分析。
网友评论