1 注解

Java.Annotation

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

1.1 内置注解

• @Override：定义在java.lang.Override中，此注释只适用于修饰方法，表示一个方法声明打算重写超类中的另一个方法声明
• @Deprecated：定义在java.lang.Deprecated中，此注释可以用于修饰方法，属性，类，表示不鼓励程序员使用这样的元素，通常是因为他很危险或者存在更好的选择
• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。与前两个注释不同，需要添加一个参数才能正常使用
  • @SuppressWarnings(“all”)
  • @SuppressWarnings(“unchecked”)
  • @SuppressWarnings(value={“unchecked”, “deprecation”})

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

    //已过时的，不建议使用
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }
    
    //抑制警告信息
    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList();
    }

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

1.2 元注解

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

//测试元注解
//放在类上
@MyAnnotation
public class Test02 {
    //放在方法上
    @MyAnnotation
    public void test(){
    }
}

//定义一个注解
//Target：表示我们的注解可以放在那些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})

//Retention：表示我们的注解在什么地方有效
@Retention(value = RetentionPolicy.RUNTIME)

@Documented
@Inherited
@interface MyAnnotation{

}

1.3 自定义注解

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

//自定义注解
public class Test03 {
    //注解可以显式赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation2(age = 18, name = "秦将", schools = {"西北大学"})
    public void test(){}

    @MyAnnotation3("秦将") //省略value
    public void test2(){}
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数：参数类型 + 参数名();
    String name() default "";
    int age() default 0;
    int id() default -1; //如果默认值为-1，代表不存在；indexof：如果找不到就返回-1

    String[] schools() default {"西部开源"};
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();
}

PS：学习自狂神说java