Java注解

Java注解

注解和反射是很多框架的核心实现机制

注解

注解入门

什么是注解？

• Annotation是从JDK5开始引入的新技术

• Annotation的作用

  • 不是程序本身，可以对程序作出解释（这点和注释（comment）没什么区别）
  • 可以被其他程序（如：编译器）读取（通过反射去读取）

• Annotation的格式：

  • 注解是以“@注释名”在代码中存在的，还可以添加一些数值，如

    @SuppressWarning(value=“unchecked”)

• Annotation在哪里使用？

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

package com.studyAnnotation;
//什么是注解？
public class Test01 {
    //重新的注解@Override，写在方法上面，如果覆盖的方法名称对不上，会提示报错
    //注解有检查约束的功能
    @Override
    public String toString() {
        return super.toString();
    }
}

内置注解

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

package com.studyAnnotation;

import java.util.ArrayList;
import java.util.List;

//什么是注解？
public class Test01 {
    public static void main(String[] args) {
        //会有一个划线，但是可以使用，只不过有危险或有更好的选择
        test();
    }
    //重新的注解@Override，写在方法上面
    //注解有检查约束的功能
    //如果方法利用此注释类型进行注解但没有重写超类方法，则编译器会生成一条错误信息
    @Override
    public String toString() {
        return super.toString();
    }
    //用@Deprecated注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择
    //在使用不被赞成的程序元素或在不被赞成的代码中执行重写时，编译器会发出警告
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }
    //该注解会抑制报错提示，所以要谨慎使用
    @SuppressWarnings("all")
    public void test1(){
        List list = new ArrayList();
    }
}

自定义注解、元注解

元注解

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

package com.studyAnnotation;

import java.lang.annotation.*;

//测试元注解
public class Test02 {
    @MyAnnotation
    public void test(){
    }
    //定义一个注解
    //Target表示我们的注解可以用在哪些地方，如：方法，类型，类等等
    @Target(value = {ElementType.TYPE,ElementType.METHOD})
    //@Retention表示我们的注解在什么地方还有效，如源码的地方有效，编译成class就无料了
    //SOURCE<CLASS<RUNTIME
    @Retention(value = RetentionPolicy.RUNTIME)
    //Documented 表示是否将我们的注解生成在JavaDoc文档中
    @Documented
    //Inherited表示子类可以继承父类的注解
    @Inherited
    @interface MyAnnotation{
        //这里可以选择定义属性参数
    }
}

自定义注解

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

package com.studyAnnotation;

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

public class Test03 {
    //注解可以显示赋值，在定义时如果没有定义默认值，则必须给注解赋值
    @MyAnnotation2(schools = {"狂神B站","徐工大"},name = "LeoDolphin")
    public void test01(){
    }
    @MyAnnotation3("change")
    public void test02(){
    }

}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数：参数类型+参数（）；
    //default可以定义参数的默认值，在使用注解时可以不传参数，用默认值
    String name() default "Leo";
    int age() default 0;
    //如果默认值为-1，代表不存在，像indexof，如果找不到就返回-1
    int id() default -1;
    String[] schools();
}
@Target(value = {ElementType.TYPE,ElementType.METHOD})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    //只有value命名参数时，使用注解可以不去注明参数，否则就需要注明，如name="Leo"
    String value();
}