Java基础02-自定义注解详解

注解

概念

注解（也被成为元数据）为我们在代码中添加信息提供了一种形式化的方式，使我们可以在稍后的某个时刻更容易的使用这些数据。

注解是 Java 5 所引入的众多语言变化之一：

• 注解使得我们可以以编译器验证的格式存储程序的额外信息
• 注解可以生成描述符文件，甚至是新的类定义，并且有助于减轻编写“样板”代码的负担
• 通过使用注解，你可以将元数据保存在 Java 源代码中
• 简单易读的代码，编译器类型检查，使用 annotation API 为自己的注解构造处理工具

Java 5 引入了前三种定义在 java.lang 包中的注解：

• @Override：表示当前的方法定义将覆盖基类的方法。如果你不小心拼写错误，或者方法签名被错误拼写的时候，编译器就会发出错误提示。
• @Deprecated：如果使用该注解的元素被调用，编译器就会发出警告信息。
• @SuppressWarnings：关闭不当的编译器警告信息。
• @SafeVarargs：在 Java 7 中加入用于禁止对具有泛型varargs参数的方法或构造函数的调用方发出警告。
• @FunctionalInterface：Java 8 中加入用于表示类型声明为函数式接口

基本语法

定义注解

下面是注解的定义。注解的定义看起来很像接口的定义。事实上，它们和其他 Java 接口一样，也会被编译成 class 文件

package com.abc.annotation;

import java.lang.annotation.*;

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface PermInfo {
    String pval() default "";
    String value() default "";
}

其中 @Target 、Documented和 @Retention为元注解，Java语言目前有 5 种标准注解，以及 5 种元注解：

注解	解释
@Target	表示注解可以用于哪些地方。可能的 ElementType 参数包括： CONSTRUCTOR：构造器的声明 FIELD：字段声明（包括 enum 实例） LOCAL_VARIABLE：局部变量声明 METHOD：方法声明 PACKAGE：包声明 PARAMETER：参数声明 TYPE：类、接口（包括注解类型）或者 enum 声明
@Retention	表示注解信息保存的时长。可选的 RetentionPolicy 参数包括： SOURCE：注解将被编译器丢弃 CLASS：注解在 class 文件中可用，但是会被 VM 丢弃。 RUNTIME：VM 将在运行期也保留注解，因此可以通过反射机制读取注解的信息
@Documented	将此注解保存在 Javadoc 中
@Interited	允许子类继承父类的注解
@Repeatable	允许一个注解可以被使用一次或者多次（Java 8）

注解通常会包含一些表示特定值的元素。当分析处理注解的时候，程序或工具可以利用这些值。注解的元素看起来就像接口的方法，但是可以为其指定默认值。

如果不包含任何元素，那么该注解称为标记注解（marker annotation）

@PermInfo注解的属性与方法定义类似。注解的元素在使用时表现为 名-值 对的形式，并且需要放置在 @PermInfo 声明之后的括号内

@PermInfo(value = "测试模块模块", pval = "a:test")
@RestController
@RequestMapping("/test")
public class TestController {

    // 由于ShiroConfig中配置了该路径可以匿名访问，所以这接口不需要登录就能访问
    @GetMapping("/hello")
    public String hello() {
        return "hello spring boot";
    }
}

注解处理器

Java 拓展了反射机制的 API 用于帮助你创造这类工具。同时他还提供了 javac 编译器钩子在编译时使用注解。