java注解基础知识整理

目录

1、注解的定义

1.1、定义一个注解

1.2、注解的使用

2、JDK内置注解

2.1、java.lang包下的注释类型

2.2、元注解

2.3、Deprecated注解

3、在注解中定义属性

3.1、获取注解类对象的属性

3.2、获取注解方法的属性

4、注解在开发中的作用

---

1、注解的定义

注解，或者叫注释类型（Annotation)，是一种引用数据类型，编译之后生成xxx.class文件。

1.1、定义一个注解

package Annotation;
public @interface MyAnnotation {
}

1.2、注解的使用

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

package Annotation;
@MyAnnotation    //注解修饰类名
public class AnnotationTest01 {
    @MyAnnotation     //注解修饰成员变量属性
    private String filed1;
    @MyAnnotation     //注解修饰方法
    public void Method1() {
    }
    public void Method2(@MyAnnotation          //注解修饰形参
                                String x,
                        @MyAnnotation
                                String y) {
    }
}

package Annotation;
@MyAnnotation_1   //注解修饰注解
public @interface MyAnnotation {
}

2、JDK内置注解

2.1、java.lang包下的注释类型

Deprecated用@Deprecated注释的程序元素

Override表示一个方法声明，重写超类中的另一个方法声明。@Override注解只在编译阶段起作用，是用来给编译器做参考的，和运行阶段无关。

2.2、元注解

元注解是用来标注“注解类型”的注解。常用的元注解有：Target   Retention

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

@Target(ElementType.METHOD)     //表示被标注的只能出现在方法上（@Override只能出现在方法上）
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

Retention注解

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

@Retention(RetentionPolicy.SOURCE); 表示该注解只被保留在java源文件中。

@Retention(RetentionPolicy.CLASS); 表示该注解只被保留在class文件中。

@Retention(RetentionPolicy.RUNTIME); 表示该注解只被保留在class文件中。并且可以被java反射机制所读取到。

源文件：源文件就是程序员们所编写出来的文件，程序员们能看懂的文件。即用java语言编写的以.java为后缀名的代码文件。

类文件：类文件则是利用java虚拟机生成的编译文件，是用来给机器看的机器语言，类文件是经过javac命令编译过后的字节码文件，以.class为后缀名。类文件通过jvm的翻译为本机能识别的机器语言，才能执行

2.3、Deprecated注解

@deprecated注解的作用是禁用一个类或者一个方法。虽然也会有输出值，但可以在Message看到Warning信息。

package Annotation;
/*
验证 @Deprecated注解的使用
 */
public class AnnotationTest02 {
    public static void main(String[] args) {
        AT at = new AT();
        AR ar = new AR();
        at.doSome();
        ar.doAny();
    }
}
@Deprecated
        //禁用一个类
class AT {
    public void doSome() {
        System.out.println("do something");
    }
}
class AR {
    @Deprecated   //禁用一个方法
    public void doAny() {
        System.out.println("do anything");
    }
}

3、在注解中定义属性

注解当中的属性类型可以是：byte，short，int，long，float，double，boolean，char，String，Class，enum类型以及每一种的数组形式

@MyAnnotation

package Annotation;
public @interface MyAnnotation {
    //在注解中定义属性
    String name();
    String sex();
    //default可以设置属性的默认值
    int age() default 22;
    String[] email();
}

@MyAnnotation_1

package Annotation;
public @interface MyAnnotation_1 {
    String value();
}

package Annotation;
public class AnnocationTest03 {
    @MyAnnotation(name = "张三", sex = "男", email = {"zhangsan@163.com", "zhangsan@126.com"})
    //age是有默认值，如果不进行设置age就是默认值为 22
    public void doA() {
    }
    @MyAnnotation_1("学生")     //注解中只有一个value属性，则可以省略value=""。
    public void doB() {
    }
}

3.1、获取注解类对象的属性

注解：@MyAnnotation_2

package Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//设置该注解可以标注类，方法，属性
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
//允许这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation_2 {
    String value();  //注解属性
}

注解注解的类：AnnotationTest04

package Annotation;
@MyAnnotation_2("2020")
public class AnnotationTest04 {
}

输出注解的类的注解属性：ReflectAnnotationTest

package Annotation;
public class ReflectAnnotationTest {
    public static void main(String[] args) throws ClassNotFoundException {
        //获取加了@MyAnnotation_2注解的类的对象（AnnotationTest04）
        Class c = Class.forName("Annotation.AnnotationTest04");
        //判断类上面是否有 @MyAnnotation_2注解
        if (c.isAnnotationPresent(MyAnnotation_2.class)) {
            //获取注解对象
            MyAnnotation_2 myAnnotation_2 = (MyAnnotation_2) c.getAnnotation(MyAnnotation_2.class);
            String value = myAnnotation_2.value();  //获取注解对象属性
            System.out.println("注解的类的对象的value属性值为：" + value);
        }
    }
}

3.2、获取注解方法的属性

注解：@MyAnnotation_5

package Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
//设置该注解可以标注类，方法，属性
@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
//允许这个注解可以被反射
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation_5 {
    String username();
    String password();
}

输出注解的方法的注解属性：AnnocationTest05

package Annotation;
import java.lang.reflect.Method;
public class AnnocationTest05 {
    @MyAnnotation_5(username = "张三", password = "123456")
    public void login() {
    }
    public static void main(String[] args) throws ClassNotFoundException, NoSuchMethodException {
        //获取AnnocationTest05类的login方法上的注解信息
        Class c = Class.forName("Annotation.AnnocationTest05");
        //获取login()方法
        Method loginMethod = c.getDeclaredMethod("login");
        //判断方法上是否存在这个注释
        if (loginMethod.isAnnotationPresent(MyAnnotation_5.class)) {
            MyAnnotation_5 myAnnotation_5 = (MyAnnotation_5) loginMethod.getAnnotation(MyAnnotation_5.class);
            System.out.println(myAnnotation_5.username());
            System.out.println(myAnnotation_5.password());
        }
    }
}

4、注解在开发中的作用

一个例子：当一个类上面有@Id注解的时候，就要求该类中必须存在int类型的id属性。

注解：@Id

package Annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Id {
}

异常类：HasNotIdPropertyException（用于对注解进行补充判断即判断被注解的类是否满足条件）

package Annotation;
public class HasNotIdPropertyException extends RuntimeException {
    public HasNotIdPropertyException() {
    }
    public HasNotIdPropertyException(String message) {
        super(message);
    }
}

 User

package Annotation;
@Id
public class User {
    int id;    //注：如果这里不是int id就会抛出HasNotIdPropertyException异常
    String name;
    String sex;
}

主类：AnnocationTest06 

package Annotation;
import java.lang.reflect.Field;
public class AnnocationTest06 {
    public static void main(String[] args) throws ClassNotFoundException {
        //获取加了注解的类
        Class userClass = Class.forName("Annotation.User");
        if (userClass.isAnnotationPresent(Id.class)) {
            //当一个类上面有@Id注解的时候，就要求该类中必须存在int类型的id属性
            //如果没有int类型的id属性则报异常
            Field[] fields = userClass.getDeclaredFields(); //获取类的属性
            boolean result = false;
            for (Field field : fields) {
                if ("id".equals(field.getName()) && "int".equals(field.getType().getSimpleName())) { //用于判断被@Id注解的类中是否有 int id
                    result = true;
                    break;
                }
            }
            if (!result) {
                throw new HasNotIdPropertyException("被@Id注解的类中一定要有一个int类型的id属性");
            }
        }
    }
}

总结：注解在框架中使用的比较广泛。框架开发都是基于注解模式开发，通过反射机制去读注解。

java注解总的来说可分为三种作用：

1、提供信息给编译器，如@Override，会提示要重写父类中的方法。

2、编译阶段时的处理，如Spring的常用注解@Controller，用@Controller注解标注一个类，在编译的时候，会把该类编译成一个控制器类。这样该类就可以处理DispatcherServlet 分发的请求。

@Deprecated注解用来标识过时的方法，如果用了被标注的过时方法，那么在程序编译的时候编译器会发出警告。

3、运行阶段的处理，如Spring的常用注解@RequestMapping，@RequestMapping是一个用来处理请求地址映射的注解，用@RequestMapping注解修饰类或方法。在程序运行阶段，web容器会根据@RequestMapping标注出的路径去找到相应的类或方法。