注解

注解

一、注解入门

什么是注解

• Annotation是从JDk5.0开始引入的新技术

• Annotation的作用：

  • 不是程序本身，可以对程序做出解释。(这一点和注释comment没什么区别)
  • 可以被其他程序(比如编译器等)读取。

• Annotation的格式

  • 注解是以"@注释命"在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value = "unchecked").

• Annotation在哪里使用？

  • 可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些原数据的访问。

二、内置注解

• @Override:定义在java.lang.Override 中，此注释只适用于修饰方法，表示一个方法声明打算重写超类中的另一个声明方法

• Deprecated：定义在java.lang.Deprecated中，此注释可以用于修饰方法、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的原则。

• SuppressWarnings：定义在java.lang.SuppressWarning中，用来抑制编译时的警告信息。

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

• @SuppressWarnings(“all”)
• @SuppressWarnings(“unchecked”)
• @SuppressWarnings(value={“unchecked”,“deprecation”})
• 等等。。。。。。

package annotation.Chapter1;
/*
 *purpose：什么是注解
 *
 */

import java.awt.*;
import java.util.ArrayList;

public class Demo1 {
    //Override  重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    static public void test(){
        System.out.println("Deprecated");
    }

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

    @SuppressWarnings("all")
    public void test02(){
       List list = new List();
    }
}

三、自定义注解，元注解

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

package annotation.Chapter1;
/*
 *purpose：
 *
 */

import java.lang.annotation.*;

public class Demo2 {
    @MyAnnotation
    public void test (){

    }
}
//定义一个注解
@Target({ElementType.TYPE,ElementType.METHOD})//    作用域
@Retention(RetentionPolicy.RUNTIME) //表示代码在什么时候还有效
@Documented //表示是否将注解生产在JavaDoc中
    @Inherited  //是否可继承
@interface MyAnnotation{

}

自定义注解

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

package annotation.Chapter1;
/*
 *purpose：自定义注解
 *
 */

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

public class Demo3 {

    @MyAnnotation2(name = " ",schools = "aaa")
    public void test (){}
    @MyAnnotation3("qq")
    public void test2 (){}
}

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    String name();
    //String name() default "";
    int age() default 0;
    int id() default -1;

    String[] schools();

}

@interface MyAnnotation3{
    String value();     //value  才可以省略
}