java注释

java注释

1. 概念:说明程序的。给计算机看的

（类比）注释:用文字描述程序的。给程序员看的

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

作用分类：

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】

② 代码分析：通过代码里标识的元数据对代码进行分析【使用反射】

③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

2. jdk中预定义的一些注解

• @Override 检测被注解标注的方法是否继承自父类（接口）的

• @Deprecated 将该注解标注的内容，已过时

• @SuppressWarnings 压制警告

package com.lfh.annotation;

import java.util.Date;

/**
 * - @Override 检测被注解标注的方法是否继承自父类（接口）的
 *
 * - @Deprecated 将该注解标注的内容，已过时
 *
 * - @SuppressWarnings 压制警告 一般参数使用（all）
 */
public class AnonoDemo02 {

    @Override
    public String toString() {
        return super.toString();
    }

    @Deprecated
    public void show1(){
        //有缺陷
        System.out.println("有缺陷，建议使用show2");
    }

    @SuppressWarnings("all")
    public void show2(){
        //替代show1
        System.out.println("");
    }

    public void test(){
        show1();
        Date date=new Date();

    }
}

3. 自定义注解

格式：

元注解			
public @interface 注解名称{
	属性列表;
}

本质：是一个继承Annotation 接口的接口

javap反编译后

public interface MyAnnotation extends java.lang.annotation.Annotation {}

**属性：**接口中可以定义的成员方法(接口中的抽象方法)

要求:

1. 属性的返回类型

   • 基本数据类型

   • String

   • 枚举

   • 注解

   • 以上类型的数组

     以上类型的使用，如下图

   [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iOj4Tb9q-1594533170151)(C:\Users\lfh\AppData\Roaming\Typora\typora-user-images\image-20200712104700151.png)]

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

   • 如果定义属性时，使用default关键字给属性默认初始值，则使用注解时，可以不进行属性的赋值
   • 如果只有一个属性需要赋值，并且属性名称是value，则value可以省略，直接定义值即可
   • 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略不写

package com.lfh.annotation;

public @interface MyAnnotation {
    String show();
    int show1();
}

3. 元注解：用于描述注解的注解

   • @Target：描述注解能够作用的位置

     ElementType取值：(重点在前三)

     @Target(ElementType.TYPE) //接口、类、枚举、注解

     @Target(ElementType.FIELD) //字段、枚举的常量

     @Target(ElementType.METHOD) //方法

     @Target(ElementType.PARAMETER) //方法参数

     @Target(ElementType.CONSTRUCTOR) //构造函数

     @Target(ElementType.LOCAL_VARIABLE)//局部变量

     @Target(ElementType.ANNOTATION_TYPE)//注解

     @Target(ElementType.PACKAGE) //包

     @TYPE_PARAMETER // 泛型

     @TYPE_USE //任意类类型

   • @Retention：描述注解被保留的阶段

   • 首先要明确生命周期长度 SOURCE < CLASS < RUNTIME ，所以前者能作用的地方后者一定也能作用。一般如果需要在运行时去动态获取注解信息，那只能用 RUNTIME 注解；如果要在编译时进行一些预处理操作，比如生成一些辅助代码（如 ButterKnife），就用 CLASS注解；如果只是做一些检查性的操作，比如 @Override 和 @SuppressWarnings，则可选用 SOURCE 注解。

     @SOURCE //

     连字节码都不会保存该注解

     @CLASS //

     当前被描述的注解，会保留到class字节码文件中，但jvm无法读取的

     @RUNTIME //自定义注解一般使用这个

     当前被描述的注解，会保留到class字节码文件中，并被jvm读取到

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

   • @Inherited：描述注解是否被之类继承

4.在程序中使用（解析）注解：获取注解中定义的属性值

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

2. 获取指定的注解

   getAnnotation（class）

     //1.2获取上边的注解对象
          //本质：在内存中生产了一个该注解接口的子类实现对象
          Pro an = annotationTestClass.getAnnotation(Pro.class);
          /*
              public class ProImpl implements Pro{
                  @Override
                  public String ClassName() {
                      return "com.lfh.annotation.test.Demo1";
                  }
                  @Override
                  public String MethodName() {
                      return "show";
                  }
              }
   */
   

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

小结：

1. 绝大部分时间是使用注解，而不是定义注解
2. 注解给谁用？
   • 编译器
   • 给解析程序用
3. 注解不是程序的一部分
4. 注解是一个标签