JavaSE基础：注解

JavaSE基础：注解

前言

以下知识点讲解注解

1、注解的定义和作用

注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。

如果要对于注解的作用进行分类，我们可以根据它所起的作用，大致可分为三类：

1. 编写文档：通过代码里标识的元数据生成文档。
2. 代码分析：通过代码里标识的元数据对代码进行分析。
3. 编译检查：通过代码里标识的元数据让编译器能实现基本的编译检查。

2、基本内置注解

@Override

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

@Deprecated

作用是对不应该再使用的方法添加注释，
不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择。
当编程人员使用这些方法时，将会在编译时显示提示信息，
它与 javadoc 里的 @deprecated 标记有相同的功能。

@SuppressWarnings()

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

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

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

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

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

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

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

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

3、自定义注解类型

 [修饰符列表] @interface 注解类型名{

 }

4、自定义注解类型添加变量

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

public @interface NewAnnotation {
//在写注解的时候value参数中value=可以省略，其它参数名不能省
String value();
}
//使用该注释的代码如下，该注释的使用有两种写法。
public class AnnotationTest {
	@NewAnnotation("Just A Test")
	public static void main(String[] args) {
		sayHello();
	}
	@NewAnnotation(value="sayHello")
	public static void sayHello(){
	}
}

为变量赋默认值

public @interface Greeting {
	public enum FontColor{
	RED,GREEN,BLUE
	}
	String title();
	String content();
	FontColor fontColor() default FontColor.RED;
}
// 使用
@Greeting(title="健康",content="你最近身体好吗
",fontColor=FontColor.BLUE)
public static void sayHello(String name){
} 

5、元注解

5.1 什么是元注解？

用来标注“注解类型”的“注解”，称为元注解。

5.2 常见的元注解有哪些？

• Target
• Retention

5.3 Target注解：

	这是一个元注解，用来标注“注解类型”的“注解”
	这个Target注解用来标注“被标注的注解”可以出现在哪些位置上。

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

// Java 定义的ElementType 枚举
package java.lang.annotation;

public enum ElementType {
    TYPE,
    FIELD,
    METHOD,
    PARAMETER,
    CONSTRUCTOR,
    LOCAL_VARIABLE,
    ANNOTATION_TYPE,
    PACKAGE,
    TYPE_PARAMETER,
    TYPE_USE,
    MODULE;

    private ElementType() {
    }
}

@Target源码

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Target {
    ElementType[] value();
}

@Target(ElementType.METHOD)：表示“被标注的注解”只能出现在方法上。
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})
			表示该注解可以出现在：
				构造方法上
				字段上
				局部变量上
				方法上
				....
				类上...

5.4 Retention注解：

这是一个元注解，用来标注“注解类型”的“注解”
这个Retention注解用来标注“被标注的注解”最终保存在哪里。

// 枚举类型
package java.lang.annotation;

public enum RetentionPolicy {
    SOURCE,
    CLASS,
    RUNTIME;

    private RetentionPolicy() {
    }
}
//@Retention(RetentionPolicy.SOURCE)：表示该注解只被保留在java源文件中。
//@Retention(RetentionPolicy.CLASS)：表示该注解被保存在class文件中。
//@Retention(RetentionPolicy.RUNTIME)：表示该注解被保存在class文件中，并且可以被反射机制所读取。

@Retention源码

package java.lang.annotation;

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Retention {
    RetentionPolicy value();
}

5.5 文档化功能

Java 提供的Documented 元注释跟 Javadoc 的作用是差不多的，它存在的好处是开发人员可以定制 Javadoc 不支持的文档属性，并在开发中应用。它的使用跟前两个也是一样的
在制作Java Doc 文件时，并不会默认将 Annotation 的数据加入到文件中.Annnotation 用于标示程序代码以便分析工具
使用相关信息，有时 Annotation 包括了重要的信息，您也许会想要在用户制作 Java Doc 文件的同时,也一并将 Annotation
的信息加入到 API 文件中。所以在定义 Annotation 类型时，可以使用java.lang.annotation.Documented。

@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface TwoAnnotation{}

使用java.lang.annotation.Documented为定义的Annotation类型加上Annotation时，必须同时使用Retention来指定编译器将信息加入.class文件，并可以由JVM读取，也就是要设置RetentionPolicy为RUNTIME。接着可以使用这个Annotation，并产生JavaDoc文件,这样可以看到文件中包括了@TwoAnnotation的信息.

5.6 Inherited注解

在定义Annotation类型并使用于程序代码上后，默认父类中的Annotation并不会被继承到子类中。可以在定义Annotation类型时加上java.lang.annotation.Inherited类型的Annotation，这让您定义的Annotation 类型在被继承后仍可以保留至子类中。