Java注解简单理解以及使用

Java注解，Annotation，中文翻译注解、标注。Java中很常用的一个知识点。

首先，什么是Annotation呢?

注解是Java5后引入的一种代码辅助工具，一种注释机制，作用：对类、方法、变量、参数和包进行标注，然后通过反射来访问这些标注信息，以此在运行时改变被标注对象的行为。

换种个人理解的思路就是，把代码想象为实物，注解就是为这些实物或实物的一部分贴上一张便利贴，写上在使用时候要怎么处理。

注意，注解不支持继承。

Java中常常见到的注解有

@Override    检查该方法是否是重写方法。如果发现其父类，或者是引用的接口中并没有该方法时，会报编译错误。

@Deprecated   标记过时方法。如果使用该方法，会报编译警告。

@SuppressWarnings   指示编译器去忽略注解中声明的警告。

......等等......

自定义注解的创建：

public @interface AnnotationStudy {
}

与接口非常类似。只是在接口关键字前加了一个@符号。这段代码就是创建了一个名字为AnnotationStudy的注解。

元注解

还有，注解学习中需要了解一个 元注解 的概念

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面

元注解有@Retention、@Documented、@Target、@Inherited、@Repeatable 5种。

@Retention 定义注解的生命周期(source->class>runtime)

• RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视
• RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中
• RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取

@Documented 文档注解，会被javadoc工具文档化

@Inherited  是否让子类集成该注解

@Target  注解应用范围

• ElementType.TYPE    标识可以用来修饰类、接口、注解类型或枚举类型

• ElementType.PACKAGE    可修饰包

• ElementType.ANNOTATION_TYPE   可修饰注解类型

• ElementType.METHOD    可修饰方法

• ElementType.FIELD    可修饰属性

• ElementType.CONSTRUCTOR    可修饰构造器

• ElementType.LOCAL_VARIABLE    可修饰局部变量

• ElementType.TYPE_PARAMETER  标注类型参数 Java8新增

• ElementType.TYPE_USE  类型注解用来支持在Java的程序中做强类型检查。Java8新增

@Repeatable   是 Java 1.8 才加进来的，所以算是一个新的特性。 通常是注解的值可以同时取多个，也就是说使用Repeatable注解了自定义注解，那么这个接口中的value()必须是一个数组。

//被改注解标注的类，其子类也自动继承本注解
@Inherited
//运行时
@Retention(RetentionPolicy.RUNTIME)
//当前注解标注在类、接口、枚举类上，也可以标记在属性上，也可标记在方法上
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
public @interface AnnotationStudy {
    Tags[] value();
}


@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Repeatable(AnnotationStudy.class)
public @interface Tags {
    String tag() default "";
}

 

注解的属性

注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

//被改注解标注的类，其子类也自动继承本注解
@Inherited
//运行时
@Retention(RetentionPolicy.RUNTIME)
//当前注解标注在类、接口、枚举类上，也可以标记在属性上，也可标记在方法上
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
public @interface AnnotationStudy {
    String value()  ;
    String msg() ;
}

如果注解中有属性，我们在使用注解时候，需要在注解后括号内对注解属性进行赋值

public class TestDemo {
    private String name;
    @AnnotationStudy(value = "abc",msg = "见过的最糟糕的工作")
    private String job;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @AnnotationStudy(value = "++plus",msg="理想的工作")
    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }
}

 

注解属性可以拥有默认值，使用default指定。如果有默认值，那么我们在使用注解时，可以不用在注解括号内对注解属性进行赋值操作。

//被改注解标注的类，其子类也自动继承本注解
@Inherited
//运行时
@Retention(RetentionPolicy.RUNTIME)
//当前注解标注在类、接口、枚举类上，也可以标记在属性上，也可标记在方法上
@Target({ElementType.TYPE,ElementType.FIELD,ElementType.METHOD})
public @interface AnnotationStudy {
    String value() default "" ;
    String msg() default  "";
}

public class TestDemo {
    private String name;
    @AnnotationStudy()
    private String job;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    @AnnotationStudy()
    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }
}

注解的提取

注解通过反射获取。首先可以通过 Class 对象、方法对象或属性对象的 isAnnotationPresent() 方法判断它是否应用了某个注解，然后通过getAnnotations()或getAnnotation(Class<T> annotationClass)获取注解对象集合或对象。如果获取到的注解不为空。那么我们可以获得到注解属性里面的值了。

public class Main {
    public static void main(String[] args) {
        Class clazz = TestDemo.class;
        Method[] methods = clazz.getDeclaredMethods();
        for (Method method : methods) {
            if (method.isAnnotationPresent(AnnotationStudy.class)){
                AnnotationStudy annotationStudy = method.getAnnotation(AnnotationStudy.class);
                System.out.println("----------------------------------------");
                System.out.println(method.getName()+"方法被"+AnnotationStudy.class.getSimpleName()+"进行注解");
                System.out.println("----------------------------------------");
                if (annotationStudy!=null){
                    System.out.println(annotationStudy.value()+":::::"+annotationStudy.msg());
                }else{
                    System.out.println("获取注解失败了，嘤嘤嘤");
                }
                System.out.println("----------------------------------------");
            }
        }
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(AnnotationStudy.class)){
                AnnotationStudy annotationStudy = field.getAnnotation(AnnotationStudy.class);
                System.out.println("****************************************");
                System.out.println(field.getName()+"属性被"+AnnotationStudy.class.getSimpleName()+"进行注解");
                System.out.println("****************************************");
                if (annotationStudy!=null){
                    System.out.println(annotationStudy.value()+":::::"+annotationStudy.msg());
                }else{
                    System.out.println("获取注解失败了，嘤嘤嘤");
                }
                System.out.println("****************************************");
            }
        }

    }
}

程序运行结果：

----------------------------------------
getJob方法被AnnotationStudy进行注解
----------------------------------------
++plus:::::理想的工作
----------------------------------------
****************************************
job属性被AnnotationStudy进行注解
****************************************
abc:::::见过的最糟糕的工作
****************************************