Java—注解

注解

一、注解和注释的区别

• Java中的注释
    Java注释可以帮助我们去理解代码，javac 不会去编译注释，java运行也不会去管我们注释的内容，注释的作用就是让我们可以给代码添加自己理解的意思，这样方便我们以后再次去看代码的时候以防止遗忘不知道该处代码的意义作用。
  a.单行注释： //
  单行肯定只能注释一行的内容，这个用在注释信息内容少的地方
  b.多行注释： /* /
  多行就是可以注释很多行的内容，一般首行和尾行不写注释信息
  注意：多行注释能嵌套单行注释，但不能嵌套多行注释和文档注释
  c.文档注释： /** */
  注释多行内容，一般用在类、方法、和变量上面，用来描述其作用
  JavaDoc 标 记
  
  注意:
  1.javadoc针对public类生成注释文档
  2 javadoc只能在public、protected修饰的方法或者属性之上
• 注解
    注解（Annotation），也叫元数据。是标记,一种代码级别的说明。也可以理解成是一种应用在类、方法、参数、属性、构造器上的特殊修饰符。它是JDK5.0及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。
  1.作用:
  注解作用有以下三种：
  第一种：生成文档，常用的有@param@return等。【生成文档doc文档】
  第二种：替代配置文件的作用，尤其是在spring等一些框架中，使用注解可以大量的减少配置文件的数量【使用反射】。
  第三种：检查代码的格式，如@Override，标识某一个方法是否覆盖了它的父类的方法。【Override】
  2.注解的底层实现原理：
    注解的底层也是使用反射实现的，我们可以自定义一个注解来体会下。注解和接口有点类似，不过申明注解类需要加上@interface，注解类里面，只支持基本类型、String及枚举类型，里面所有属性被定义成方法，并允许提供默认值。
  3.实现
  java 5.0开始，在java.lang.annotations中提供了四种元注解，专门注解其他的注解：

二、注解

Annotation的作用 : 不是程序本身 , 可以对程序作出解释.(这一点和注释(comment)没什么区别) 可以被其他程序(比如:编译器等)读取.
Annotation的格式 : 注解是以"@注释名"在代码中存在的 , 还可以添加一些参数值 , 例如:@SuppressWarnings(value=“unchecked”).
Annotation在哪里使用? ：可以附加在package , class , method , field 等上面 , 相当于给他们添加了额外的辅助信息, 我们可以通过反射机制编程实现对这些元数据的访问。

• 内置注解
  @Override : 定义在 java.lang.Override 中 , 此注释只适用于修辞方法 , 表示一个方法声明打算 重写超类中的另一个方法声明.
  @Deprecated : 定义在java.lang.Deprecated中 , 此注释可以用于修辞方法 , 属性 , 类 , 表示不 鼓励程序员使用这样的元素 , 通常是因为它很危险或者存在更好的选择 .
  @SuppressWarnings : 定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息. p 与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的, 我们选择性的使用就好了 .
  @SuppressWarnings(“all”）
  @SuppressWarnings(“unchecked”)
  @SuppressWarnings(value={“unchecked”,“deprecation”})
  代码：

public class Test1{

   public static void main(String[] args) {
       // new Thread().start();
       // private native void start0();  本地方法，java已经没办法做了，调用了底层的C的类库！
       int year = new Date().getYear();
       System.out.println(year);
   }

   //标注这个方法，过时的，或者危险的，不建议使用，但是可以使用！
   @Deprecated
   public int test(){  //不建议使用
       System.out.println("aaaaaa");
       return 1;
   }

   public String hello(){ //没有被使用
      List list = new ArrayList<>();
      return "hello,world!";
   }

   @Override //标注了这个注解，就代表子类重写了父类的方法，而且必须保持一致
   public String toString() {
       return "Test1{}";
   }
}

• 元注解
  元注解的作用就是负责注解其他注解 , Java定义了4个标准的meta-annotation类型,他们被用来 提供对其他annotation类型作说明 .
  这些类型和它们所支持的类在java.lang.annotation包中可以找到 .( @Target , @Retention , @Documented , @Inherited )
  @Target : 用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
  @Retention : 表示需要在什么级别保存该注释信息 , 用于描述注解的生命周期 (SOURCE < CLASS < RUNTIME)
  @Document：说明该注解将被包含在javadoc中
  @Inherited：说明子类可以继承父类中的该注解
  代码：

public class Test2 {

    private int age;

    @MyAnnotation
    public int getAge() {
        return age;
    }

}
//如何自定义注解呢？  @interface 注解名，注意和 interface的区别

//除了这四个注解之外的所有注解，都叫做自定义注解！

@Target(ElementType.METHOD) //表示我这个注解，能够注解谁！  方法，字段，类
@Retention(RetentionPolicy.RUNTIME) //自定义注解我们都会使用 RetentionPolicy.RUNTIME 在运行时生效
@Documented //表示L可以在Javadoc中生成信息，没什么用！
@Inherited //表示子类可以继承父类的注解，一般也不用！
@interface MyAnnotation{



}

• 自定义注解
  @interface自定义注解时 ,继承java.lang.annotation.Annotation接口 。
  分析 : @ interface用来声明一个注解 , 格式 : public @ interface 注解名 { 定义内容 } 其中的每一个方法实际上是声明了一个配置参数.
  方法的名称就是参数的名称.
  返回值类型就是参数的类型 ( 返回值只能是基本类型,Class , String , enum ).
  可以通过default来声明参数的默认值
  如果只有一个参数成员 , 一般参数名为value
  注解元素必须要有值 , 我们定义注解元素时 , 经常使用空字符串,0作为默认值 .

代码：

public class Test3 {

   private int age;

   @MyAnnotation3("aaa")
   public int getAge() {
       return age;
   }

}


@Target(value={ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3{

   String[] value(); //只有一个参数的一般名字叫做value， 可以省略！

}

@Target(value={ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{

   String name() default "";
   int age() default 0;
   int id() default -1; // String indexOf("abc")   -1, 找不到，不存在

   String[] schools();

}