Java的注解

什么是注解

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

  • Annotation的作用：

    • 不是程序本身，可以对程序作出解释（这一点和注释（comment）没什么区别），它有检查和规范的作用。

    • 可以被其他程序（比如 编译器）读取

  • Annotation的格式：

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

  • Annotation在哪里使用？

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

package com.kuang.annotation;
//什么是注解
public class Test01{
    //@Override 是重写的注解
    @Override
    public String toString(){
        return super.toString();
    }
    //@Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的方式。
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }
    @SuppressWarning(all) //镇压所有警告
    public void test02(){
        List list = new ArrayList();
    }
    
    public static void main(String[] args){
        test();
    }
}

内置注解

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

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

  • @SupperessWarning：定义在 java.lang.SupperessWarning 中，用来抑制编译时的警告信息，与前两个注释有所不同的是，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就行。

    • @SuppressWarning("all")

    • @SuppressWarning("unchecked")

    • @SuppressWarning(value={"unchecked","deprecation"})

元注解

  • 元注解的作用就是 负责注解其他注解 ，Java定义了4个标准的 meta-annotation 类型，他们被用来提供对其他annotation类型作说明。

  • 这些类型和它们所支持的类在 java.lang.annotation 包中可以找到 .(@Target, @Retention, @Documented, @Inherited)

    • @Target：用来描述注解的使用范围（即：被描述的注解可以用在什么地方）

    • @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期

      • (SOURCE < CLASS < RUNTIME)

    • @Document：说明该注解将被包含在 javadoc 中

    • @Inherited：说明子类可以继承父类中的该注解

package com.kuang.annotation;
//测试元注解
public class Test02{
    @MyAnnotation
    public void test(){
        
    }
}
//定义一个注解
//Target定义我们的注解可以用在哪些地方
//Retention表示我们的注解在什么地方还有效，默认是RUNTIME。
//RUNTIME > CLASS > SOURCE
@Target(value = {ElementType.METHOD, ElementTypt.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@Documented //表示是否将我们的注解生成在javadoc文档中
@Inherited //子类可以继承父类的注解
@interface MyAnnotation{
    
}

  • 注意：一个程序里只能有一个类是public，即有一个public修饰的“入口，且该public修饰的类名必须与文件名相同”，并且一个源文件可以只有非public类。

自定义注解

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

  • 分析：

    • @interface用来声明一个注解，格式：public @interface 注释名{定义内容}

    • 其中的每一个方法实际上是声明了一个配置参数

    • 方法的名称就是参数的名称

    • 返回值类型就是参数的类型（返回值只能是基本类型，class，String，enum）

    • 可以通过 default 来声明参数的默认值

    • 如果只有一个参数成员，一般参数名为value。

    • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串或0作为默认值。

package com.kuang.annotation;
​
import java.lang.annotation.ElementTypt;
import java.lang.annotation.Target;
​
//自定义注解
public class Test03{
    //注解可以显示赋值，如果没有默认值则必须给注解赋值。
    @MyAnnotation2(name = "秦疆", schools = {"西北大学", "西交大"})
    public void test(){
        public test(){
            
        }
        @MyAnnotation3("秦疆") //注解只有一个值的时候，在方法体内给变量命名value，在调用的时候就可以省去“value =”的书写。
        public test2(){
            
        }
    }
}
​
@Target({ElementTypt.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({ElementTypt.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value(); //如果只有一个值时建议只用value命名
}

posted on 2021-11-22 21:39  愿将过往均储藏  阅读(43)  评论(0)    收藏  举报

导航