注解 Java.Annotation

—— 讲师 : 秦疆 西安西部开源教育科技有限公司

注意:

  • 注解和注释很相似,注释是给人阅读的,而注解不仅仅是给人阅读,还可以给程序看,甚至还能被其他程序读取。
  • Spring、SpringBoot 等技术框架的底层实现机制就是注解和反射。

1、注解入门

1. 什么是注解

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

注意: 注解具有检查和约束的作用,@Overried 注解用在方法之上,就是用来告诉编译器,这个方法是用来覆写来自父类的同名方法的,如果父类没有这个所谓的“同名”方法,就会发出警告信息。所以上述代码段中的 toString() 就不可以写成 tostring() 等其他名称,否则报错。

  • Annotation 是从 JDK1.5 开始引入的技术。
  • Annotation 的作用:

    • 不是程序本身,可以对程序作出解释。(这一点和注释(comment)没什么区别);
    • 可以被其他程序(比如:编译器等)读取。
  • Annotation 的格式:

    • 注解是以 "@注释名" 在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")。
  • Annotation 在哪里使用?

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

2、内置注解

  • @Overried : 定义在 java.lang.Override 中,此注解只适用于修饰方法,表示一个方法声明打算重写超类中的另一个方法声明。
  • @Deprecated: 定义在 java.lang.Deprecated 中,此注解可以用于修饰方法,属性,类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或者存在更好的选择。
// 什么是注解
public class Test01 extends Object {
    
    // @Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
    
    // @Deprecated 不推荐使用,但是可以使用,或者存在更好的替代方式
    @Deprecated
    public static void test() {
        System.out.println("Deprecated");
    }
    
    public static void main(Strring[] args) {
        test();
    }
}
  • @SuppressWarnings: 定义在 java.lang.SuppressWarnings 中,用来抑制编译时的警告信息。

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

      • @SuppressWarnings("all")
      • @SuppressWarnings("unchecked")
      • @SuppressWarnings(value={"unchecked", "deprecation"})
      • 等等.......
// 什么是注解
public class Test01 extends Object {
    
    // @Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
    
    // @Deprecated 不推荐使用,但是可以使用,或者存在更好的替代方式
    @Deprecated
    public static void test() {
        System.out.println("Deprecated");
    }
    
    // @SuppressWarnings("all")  镇压警告功能
    @SuppressWarnings("all")
    public void test02() {
        List list = new ArrayList();  // 未使用警告消失
    }
    
    public static void main(Strring[] args) {
        test();
    }
}

3、自定义注解,元注解

元注解

  • 元注解的作用就是负责注解其他注解, Java 定义了 4 个标准的 meta-annotation 类型,他们被用来提供对其他 annotation 类型作说明。
  • 这些类型和他们所支持的类在 java.lang.annotation 包中可以找到。(@Target, @Retention, @Documented, @Inherited)

    • @Target : 用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
    • @Retention : 表示需要在什么级别保存该注解信息,用于描述注解的生命周期

      • (SOURCE < CLASS < RUNTIME)
    • @Document: 说明该注解将包含在 javadoc 中
    • @Inherited: 说明子类可以继承父类中的该注解
// 测试元注解
public class Test02 {
    
    @MyAnnotation
    public void test(){
        
    }
}

// 定义一个注解
// @Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD, ElementType.TYPE})
// @Retention 表示我们的注解在什么时候还有效
// RUNTIME > CLASS > SOURCE
@Retention(value = RetentionPolicy.RUNTIME)
// @Documented 表示是否将我们的注解生成在 JAVADOC 中
@Documented

//@Inherited 表示子类可以继承父类的注解
@Inherited
@interface MyAnnotation {
    
}

自定义注解

  • 使用 @interface 自定义注解时,自动继承了 java.lang.annotation.Annotation 接口
  • 分析:

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

// 自定义注解
public class Test03 {
    // 注解可以显式赋值,如果没有默认值,我们就必须给注解赋值,否则报错
    @MyAnnotation2(name = "秦疆", schools = {"BUCT", "HUST"})
    public void test(){}
    
    @MyAnnotation3("秦疆") //如果注解只有一个值,并且参数名为 value,就可以省略 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 ,代表不存在;
    
    String[] schools();
}

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    String value();
}
Last modification:March 7th, 2020 at 09:36 pm
如果觉得我的文章对你有用,请随意赞赏