526互联

JavaSE--注解

发布时间 2023-09-09 19:59:47作者: 洛小依ovo

一、注解

1、注解概述

  注解，又叫叫做注释类型，Annotation

  注解Annotation是一种引用数据类型。编译之后也是生成xxx.class文件。

2、语法格式

// 定义语法格式
[修饰符列表] @interface 注解类型名{

}

// 使用时语法格式
@注解类型名
public @interface MyAnnotation{
    
}

3、注解使用地方

 注解可以出现在类上、属性上、方法上、变量上等....注解还可以出现在注解类型上。

默认情况下，注解可以出现在任何位置

@MyAnnotation
public class AnnotationTest01 {

    @MyAnnotation
    private int no;

    @MyAnnotation
    public AnnotationTest01(){}

    @MyAnnotation
    public static void m1(){
        @MyAnnotation
        int i = 100;
    }

    @MyAnnotation
    public void m2(@MyAnnotation
                    String name,
                   @MyAnnotation
                    int k){

    }
}
@MyAnnotation
interface MyInterface {

}
@MyAnnotation
enum Season {
    SPRING,SUMMER,AUTUMN,WINTER
}

4、jdk内置的注解

jdk的java.lang包下的

  Deprecated 用 @Deprecated 注释的程序元素，不鼓励程序员使用这样的元素，通常是因为它很危险或存在更好的选择（也就是一般用这个的话，就是这个元素已经淘汰了，有更好的代替元素来使用）

  Override 表示一个方法声明打算重写超类中的另一个方法声明。

  SuppressWarnings 指示应该在注释元素（以及包含在该注释元素中的所有程序元素）中取消显示指定的编译器警告（不用掌握）

  1）@Override

    @Override这个注解是一个标识性注解，给编译器做参考的。编译器看到方法上有这个注解的时候，编译器会自动检查该方法是否重写了父类的方法。如果没有重写，报错。和运行阶段没有关系

    @Override只能注解方法

// 源代码
public @interface Override {
}
public class AnnotationTest02 {

    private int no;

    @Override
    public String toString() {
        return "toString方法重写";
    }

}

  2）@Deprecated 

    Deprecated这个注解标注的元素已过时。

    这个注解主要是向其它程序员传达一个信息，告知已过时，有更好的解决方案存在

@Deprecated
public static void doOther(){
System.out.println("do other...");
}
// 类上也可以

5、元注解

  1）元注解概述

    用来标注“注解类型”的“注解”，称为元注解

  2）常见的元注解

    Target、Retention

  3）Target注解

    Target注解用来标注“被标注的注解”可以出现在哪些位置上

// 表示“被标注的注解”只能出现在方法上。
@Target(ElementType.METHOD)

// 表示该注解可以出现在：构造方法上、字段上、局部变量上、方法上、包上、......类上...
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, MODULE, PARAMETER, TYPE})

  4）Retention注解

    Retention注解用来标注“被标注的注解”最终保存在哪里

// 表示该注解只被保留在java源文件中
@Retention(RetentionPolicy.SOURCE)
// 表示该注解被保存在class文件中
@Retention(RetentionPolicy.CLASS)
// 表示该注解被保存在class文件中，并且可以被反射机制所读取
@Retention(RetentionPolicy.RUNTIME)

 

二、自定义注解

1、定义属性

public @interface MyAnnotation {

    /**
     * 我们通常在注解当中可以定义属性，以下这个是MyAnnotation的name属性
     * 看着像1个方法，但实际上我们称之为属性name。
     * @return
     */
    String name();

    /*
    颜色属性
     */
    String color();

    /*
    年龄属性
     */
    int age() default 25; //属性指定默认值，指定默认值，使用的时候可以不写
    
    /*
        数组String  邮箱地址属性
    */
    String[] email();
}
public class MyAnnotationTest {

    //如果一个注解当中有属性，那么必须给属性赋值。（除非该属性使用default指定了默认值）
    //@MyAnnotation(属性名=属性值,属性名=属性值,属性名=属性值)
    @MyAnnotation(name = "zhangsan", color = "红色", email = {"lsdk","ddf"})
    public void doSome(){

    }
    
    // 数组中元素只有一个的话，可以不写{ }大括号
    @MyAnnotation(name = "zhangsan", color = "红色", email = "lsdk")
    public void doOther(){

    }

}

 2、定义value属性

  如果一个注解的属性的名字时value的话，并且只有这一个属性，在使用的时候value属性名可以省略不写

public @interface MyAnnotation {
    /*
    value属性
     */
    String value();
}
public class MyAnnotationTest {
    @MyAnnotation("hh")
    public void doSome(){

    }
}

 3、注解中属性的数据类型

byte short int long float double boolean char String Class 枚举类型 以及他们每一种的数组形式

public @interface MyAnnotation {
    
    int value1();

    String value2();

    int[] value3();

    String[] value4();
    // 枚举
    Season value5();
    // 枚举数组
    Season[] value6();

    Class parameterType();

    Class[] parameterTypes();
}

 三、反射注解

通过反射机制获取注解，并且获取注解中的属性值

// 自定义注解
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MyAnnotation {

    /*
    username属性
     */
    String username();

    /*
    password属性
     */
    String password();
}
public class MyAnnotationTest {

    @MyAnnotation(username = "admin", password = "123123")
    public void doSome(){

    }

    public static void main(String[] args) throws Exception{
        // 获取MyAnnotationTest的doSome()方法上面的注解信息
        
        // 先获取类
        Class c = Class.forName("com.bjpowernode.java.annotation6.MyAnnotationTest");
        // 再获取doSome()方法
        Method doSomeMethod = c.getDeclaredMethod("doSome");
        // 判断该方法上是否存在这个注解isAnnotationPresent(MyAnnotation.class)
        if(doSomeMethod.isAnnotationPresent(MyAnnotation.class)) {
            // 获取注解
            MyAnnotation myAnnotation = doSomeMethod.getAnnotation(MyAnnotation.class);
            // 通过注解.点的方式 获取注解的属性值
            System.out.println(myAnnotation.username());
            System.out.println(myAnnotation.password());
        }
    }

}