package cn.annotation; /*
* 注解javadoc演示
*
* @author tangxiaocong
* @since 1.5
* */ public class AnnoDemo1 { /*
    * 注解
    * 注解来描述一些信息
    * 这些注解可以被抽取但Java doc文档中
    *
    *
    *
    * */ /**
     * 计算两数之和
     * @param a 整数
     * @param b 整数
     * @return 返回两数之和
     */ public int add(int a,int b) { return a+b;
}






}

类中注解会被抽取到doc文件中

先新建一个文件夹，把java文件粘贴进入此文件

编辑

为了方便后边的抽取，把包给注释或删除

打开命令行窗口

打开当前当前文件夹输入javadoc AnnoDemo1.java

编辑

打开之后会在“新建文件夹”下边生成大量html文件

编辑

JDK中预定义的一些注解

1.@override :检测被该注解标注的方法是否是继承自父类（接口）的

2.@Deprecated ：该注解标注的内容，表示已经过时（已经有新方法替代它）

3.@SuppressWarnings ：压制警告（需要传递参数一般为all）

eg:@SuppressWarnings("all")

package cn.annotation; @SuppressWarnings("all") public class AnnoDemo2 { @Override public String toString() { return super.toString();
    } @Deprecated public void show1() { //有缺陷 } public void show2() { //替代show1 }


}

自定义注解

格式：

元注解

public @interface 注解名称{

}

本质：

先编译（javac）生成字节码文件再反编译（javap）生成一下：

public interface cn.annotation.MyAnno extends java.lang.annotation.Annotation {
}

注解本质上就是一个接口，该接口默认继承Annotation接口

属性：

接口中可以定义的成员方法（接口中的抽象方法）

要求：

1.属性的返回值类型：

基本数据类型

String

枚举（enum）

注解

以上类型的数组

(不允许void)

2.定义了属性，在使用时需要给属性赋值

（1）如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。

（2）如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

（3）数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}省略

3.元注解

用于描述注解的注解

eg:

@Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override {
}

@Target:表示注解能够作用的位置 @Target(ElementType.METHOD)

ElementType取值：（ElementType是数组）

METHOD：表示可以作用在方法上

TYPE:表示可以作用在类上

FIELD：表示可以作用于成员变量上

package cn.annotation; import java.lang.annotation.ElementType; import java.lang.annotation.Target; //表示该注解MyAnno3只能作用于类上 @Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD}) public @interface MyAnno3 {



}

@Retention: 描述注解被保留的阶段， @Retention(RetentionPolicy.SOURCE)

RUNTIME：表示当前被描述的注解，会保留到class字节码文件中，并被JVM读取到

CLASS：表示当前被描述的注解，会保留到class字节码文件中，但是不会被读取到

SOURCE：表示当前被描述的注解，只会在源码中出现，不会保留到class文件中

package cn.annotation; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; //表示该注解MyAnno3只能作用于类上 //@Target(value={ElementType.TYPE,ElementType.METHOD,ElementType.FIELD}) @Retention(RetentionPolicy.RUNTIME) public @interface MyAnno3 {



}

@Documented:描述注解是否被抽取到api文档中

表示当前被描述的注解会被抽取到Javadoc的文档中

在不加@Documented的情况下生成的API文档：

@Inherited:描述注解是否被子类继承

4.在程序中使用（解析）注解：

获取注解中定义的属性值

1.获取注解定义的位置的对象（Class，Method,Field）

2.获取指定的注解

getAnnotation(Class)

3.调用注解中的抽象方法获取配置的属性值

前提：

不能改变该类的任何代码，可以创建任意类的对象，可以执行任意方法

步骤：

1.解析注解

        1.1 获取该类的字节码文件对象

Class<ReflectTest> reflectTestClass = ReflectTest.class;

2 .获取上边注解对象（其实就是在内存中生成一个该注解接口的子类实现对象）

pro annotation = reflectTestClass.getAnnotation(pro.class);

相当于重写注解接口中的方法因为返回值为String 重写后会return 回来

3.调用注解对象中定义的抽象方法，获取返回值

String s = annotation.className();
String s1 = annotation.methodName();

package cn.annotation; @pro(className = "cn.annotation.Demo1",methodName = "show") public class ReflectTest { public static void main(String[] args) { //1.解析注解 //1.1 获取该类的字节码文件对象 Class<ReflectTest> reflectTestClass = ReflectTest.class; //2 获取上边注解对象 //其实就是在内存中生成一个该注解接口的子类实现对象 pro annotation = reflectTestClass.getAnnotation(pro.class);// //3.调用注解对象中定义的抽象方法，获取返回值 String s = annotation.className(); String s1 = annotation.methodName();
        System.out.println(s);
        System.out.println(s1);

    }
}