Go语言视频零基础入门到精通

零度空间

元数据的作用

如果要对于元数据的作用进行分类，目前还没有明确的定义，不过我们可以根据它所起的作用，大致可分为三类：

Ø  编写文档：通过代码里标识的元数据生成文档。

Ø  代码分析：通过代码里标识的元数据对代码进行分析。

Ø  编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。

基本内置注释

（1）@Override 注释能实现编译时检查，你可以为你的方法添加该注释，以声明该方法是用于覆盖父类中的方法。如果该方法不是覆盖父类的方法，将会在编译时报错。例如我们为某类重写toString() 方法却写成了tostring() ，并且我们为该方法添加了@Override 注释；

（2）@Deprecated 的作用是对不应该在使用的方法添加注释，当编程人员使用这些方法时，将会在编译时显示提示信息，它与javadoc 里的 @deprecated 标记有相同的功能，准确的说，它还不如javadoc @deprecated ，因为它不支持参数，

注意：要了解详细信息，请使用 -Xlint:deprecation 重新编译。

（3）@SuppressWarnings 与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数值都是已经定义好了的，我们选择性的使用就好了，参数如下：

²  deprecation   使用了过时的类或方法时的警告

²  unchecked  执行了未检查的转换时的警告，例如当使用集合时没有用泛型 (Generics)来指定集合保存的类型

²  fallthrough   当 Switch 程序块直接通往下一种情况而没有 Break 时的警告

²  path   在类路径、源文件路径等中有不存在的路径时的警告

²  serial 当在可序列化的类上缺少 serialVersionUID 定义时的警告

²  finally    任何 finally 子句不能正常完成时的警告

²  all 关于以上所有情况的警告

注意：要了解详细信息，请使用 -Xlint:unchecked 重新编译。

  

定制注释类型

    好的，让我们创建一个自己的注释类型（annotation type ）吧。它类似于新创建一个接口类文件，但为了区分，我们需要将它声明为@interface, 如下例：

public @interface NewAnnotation {   }



限定注释使用范围

  当我们的自定义注释不断的增多也比较复杂时，就会导致有些开发人员使用错误，主要表现在不该使用该注释的地方使用。为此，Java 提供了一个ElementType 枚举类型来控制每个注释的使用范围，比如说某些注释只能用于普通方法，而不能用于构造函数等。下面是Java 定义的ElementType 枚举：

package java.lang.annotation;

public enum ElementType {

     TYPE,         // Class, interface, or enum (but not annotation)

     FIELD,        // Field (including enumerated values)

    METHOD,       // Method (does not include constructors)

     PARAMETER,        // Method parameter

     CONSTRUCTOR,      // Constructor

     LOCAL_VARIABLE,   // Local variable or catch clause

     ANNOTATION_TYPE,  // Annotation Types (meta-annotations)

     PACKAGE       // Java package

}

   下面我们来修改Greeting 注释，为之添加限定范围的语句，这里我们称它为目标（Target ）使用方法也很简单，如下：

  @Target( { ElementType.METHOD, ElementType.CONSTRUCTOR })

public @interface Greeting {    }  使用在包申明、类名等时，会提示错误信息。

  

注释保持性策略

public enum RetentionPolicy {

    SOURCE,// Annotation is discarded by the compiler

    CLASS,// Annotation is stored in the class file, but ignored by the VM

    RUNTIME// Annotation is stored in the class file and read by the VM

}

  RetentionPolicy 的使用方法与ElementType 类似，简单代码示例如下：

@Retention(RetentionPolicy.RUNTIME)

@Target( { ElementType.METHOD, ElementType.CONSTRUCTOR })



使用定制的注释类型

   我们已经成功地创建好一个注释类型NewAnnotation ，现在让我们来尝试使用它吧，如果你还记得本文的第一部分，那你应该知道他是一个标记注释，使用也很容易，如下例：

public class AnnotationTest {

    @NewAnnotation

    public static void main(String[] args) {   }

}



添加变量

    J2SE 5.0 里，我们了解到内置注释@SuppressWarnings() 是可以使用参数的，那么自定义注释能不能定义参数个数和类型呢？答案是当然可以，但参数类型只允许为基本类型、String 、Class 、枚举类型等，并且参数不能为空。我们来扩展NewAnnotation ，为之添加一个String 类型的参数，示例代码如下：

public @interface NewAnnotation {   String value();   }

  使用该注释的代码如下：正如你所看到的，该注释的使用有两种写法，这也是在之前的文章里所提到过的。如果你忘了这是怎么回事，那就再去翻翻吧。

public class AnnotationTest {

    @NewAnnotation("Just a Test.")

    public static void main(String[] args) {   sayHello();  }

    @NewAnnotation(value="Hello NUMEN.")

    public static void sayHello() {   // do something   }

}

  

为变量赋默认值

  我们对Java 自定义注释的了解正在不断的增多，不过我们还需要更过，在该条目里我们将了解到如何为变量设置默认值，我们再对NewAnnotaion 进行修改，看看它会变成什么样子，不仅参数多了几个，连类名也变了。但还是很容易理解的，我们先定义一个枚举类型，然后将参数设置为该枚举类型，并赋予默认值。

public @interface Greeting {

    public enum FontColor {RED, GREEN, BLUE};

    String name();

    String content();

    FontColor fontColor() default FontColor.BLUE;

}

  

  

文档化功能

  Java 提供的Documented 元注释跟Javadoc 的作用是差不多的，其实它存在的好处是开发人员可以定制Javadoc 不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的，简单代码示例如下：

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target( { ElementType.METHOD, ElementType.CONSTRUCTOR })

public @interface Greeting {   }

    值得大家注意的是，如果你要使用@Documented 元注释，你就得为该注释设置RetentionPolicy.RUNTIME 保持性策略。为什么这样做，应该比较容易理解，这里就不提了。

标注继承

继承应该是Java 提供的最复杂的一个元注释了，它的作用是控制注释是否会影响到子类，简单代码示例如下：

@Inherited

@Documented

@Retention(RetentionPolicy.RUNTIME)

@Target( { ElementType.METHOD, ElementType.CONSTRUCTOR })

public @interface Greeting {   }

  

读取注释信息

  当我们想读取某个注释信息时，我们是在运行时通过反射来实现的，如果你对元注释还有点印象，那你应该记得我们需要将保持性策略设置为RUNTIME ，也就是说只有注释标记了@Retention(RetentionPolicy.RUNTIME) 的，我们才能通过反射来获得相关信息，下面的例子我们将沿用前面几篇文章中出现的代码，并实现读取AnnotationTest 类所有方法标记的注释并打印到控制台。好了，我们来看看是如何实现的吧：

public class AnnotationIntro {

    public static void main(String[] args) throws Exception {

        Method[] methods = Class.forName( "com.gelc.annotation.demo.customize

.AnnotationTest") .getDeclaredMethods();  //获取指定类的所有方法

        Annotation[] annotations;

        for (Method method : methods) {

            annotations = method.getAnnotations();

            for (Annotation annotation : annotations) {

                System.out.println(method.getName() + " : "

                        + annotation.annotationType().getName());

            }

还可以使用如下方法直接读取相关的注解信息:

public <T extends Annotation> T getAnnotation(Class<T> annotationClass)

如果该元素的指定注释类型的注释存在于此对象上，则返回这些注释，

否则返回 null

接下来就可以对注解中的属性进行取值操作了