hexo blog分类方法

2019-09-06 2020-05-20

hexo / 写作

10 minutes read (About 1548 words)

Java 注解用于为 Java 代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。
同 classs 和 interface 一样，注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

注解的定义

注解通过@interface关键字进行定义

1 2	public @interface TestAnnotation { }

注解的应用

1
2
3

@TestAnnotation
public class Test {
}

元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention:说明了这个注解的的存活时间,取值有 RetentionPolicy.SOURCE，RetentionPolicy.CLASS，RetentionPolicy.RUNTIME，分别表示注解保留到源代码阶段，编译阶段，以及运行阶段。
@Documented:将注解中的元素包含到 Javadoc 中去。
@Target:限定运用的场景。@Target 有下面的取值
- ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
- ElementType.CONSTRUCTOR 可以给构造方法进行注解
- ElementType.FIELD 可以给属性进行注解
- ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
- ElementType.METHOD 可以给方法进行注解
- ElementType.PACKAGE 可以给一个包进行注解
- ElementType.PARAMETER 可以给一个方法内的参数进行注解
- ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举
@Inherited:Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。
@Repeatable:注解的值可以同时取多个。

代码示例：

// @Retention
@TestAnnotation
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

// @Inherited
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}

@Test
public class A {}

public class B extends A {}

// @Repeatable
@interface Persons {
Person[] value();
}

@Repeatable(Persons.class)
@interface Person{
String role default "";
}

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。注解中定义属性时它的类型必须是 8 种基本数据类型外加类、接口、注解及它们的数组。

@TestAnnotation
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
int id();
String msg();
}

// 这个注解中拥有 id 和 msg 两个属性。在使用的时候赋值
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}

// 注解中属性可以有默认值，默认值需要用 default 关键值指定
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
public int id() default -1;
public String msg() default "Hi";
}

// 使用
@TestAnnotation()
public class Test {}

如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内。

1
2
3

public @interface Check {
String value();
}

Java 预制的注解

@Deprecated:告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
@Override:复写父类中被 @Override 修饰的方法。
@SuppressWarnings:阻止警告。
@FunctionalInterface:函数式接口注解。
函数式接口可以很容易转换为 Lambda 表达式。

注解的提取

注解通过反射获取。（反射 (Reflection) 是 Java 的特征之一，它允许运行中的 Java 程序获取自身的信息，并且可以操作类或对象的内部属性。）

// 首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解
// boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

// 然后通过 getAnnotation() 方法来获取 Annotation 对象
// public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

// 或者是 getAnnotations() 方法
// public Annotation[] getAnnotations() {}

// 如果获取到的 Annotation 如果不为 null，则就可以调用它们的属性方法
import java.lang.annotation.Annotation;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.lang.annotation.Target;
import java.lang.annotation.ElementType;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TestAnnotation {
    public int id() default -1;

    public String msg() default "Hi";
}

@Retention(RetentionPolicy.RUNTIME)
@interface Check {
    String value();
}

@Retention(RetentionPolicy.RUNTIME)
@interface Perform {
}

class Hero {
    public void say() {
        System.out.println("say from hero");
    }

    public void speak() {
        System.out.println("speak from hero");
    }
}

@TestAnnotation(msg = "hello")
public class Main {

    @Check(value = "hi")
    int a;

    @Perform
    public void testMethod() {
    }

    @SuppressWarnings("deprecation")
    public void test1() {
        Hero hero = new Hero();
        hero.say();
        hero.speak();
    }

    public static void main(String[] args) {
        boolean hasAnnotation = Main.class.isAnnotationPresent(TestAnnotation.class);
        if (hasAnnotation) {
            TestAnnotation testAnnotation = Main.class.getAnnotation(TestAnnotation.class);
            // 获取类的注解
            System.out.println("id:" + testAnnotation.id());
            System.out.println("msg:" + testAnnotation.msg());
        }
        try {
            Field a = Main.class.getDeclaredField("a");
            a.setAccessible(true);
            // 获取一个成员变量上的注解
            Check check = a.getAnnotation(Check.class);

            if (check != null) {
                System.out.println("check value:" + check.value());
            }
            Method testMethod = Main.class.getDeclaredMethod("testMethod");

            if (testMethod != null) {
                // 获取方法中的注解
                Annotation[] ans = testMethod.getAnnotations();
                for (int i = 0; i < ans.length; i++) {
                    System.out.println("method testMethod annotation:" + ans[i].annotationType().getSimpleName());
                }
            }
        } catch (NoSuchFieldException e) {
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (SecurityException e) {
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
            System.out.println(e.getMessage());
        }
    }
}

需要注意的是，如果一个注解要在运行时被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

注解的使用场景

注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

注解有许多用处，主要如下：

提供信息给编译器：编译器可以利用注解来探测错误和警告信息
编译阶段时的处理：软件工具可以用来利用注解信息来生成代码、Html 文档或者做其它相应处理。
运行时的处理：某些注解可以在程序运行的时候接受代码的提取

文章参考

hexo