Java 注解

概述

注解的优点包括：更加干净易读的代码，以及编译期类型检查。

注解的语法比较简单，除了@符号的使用之外，它基本与Java固有的语法一致。Java内置了三种注解，定义在java.lang中的注解：

• @Override，表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误，或者方法签名对不上被覆盖的方法，编译器就会发出错误提示。
• @Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。
• @SuppressWarnings，关闭不当的编译器警告信息。在java SE5之前的版本中，也可以使用该注解，不过会被忽略不起作用。

Java 注解相关文章

定义注解

注解的定义看起来像接口的定义，注解也将被编译成class文件。Java除了内置了三种标准注解，还有四种元注解。

四种元注解：

@Target 表示该注解用于什么地方，可能的值在枚举类 ElemenetType 中，包括：

 ElemenetType.CONSTRUCTOR-----------------------------构造器声明 
 ElemenetType.FIELD ----------------------------------域声明（包括 enum 实例） 
 ElemenetType.LOCAL_VARIABLE------------------------- 局部变量声明 
 ElemenetType.METHOD ---------------------------------方法声明 
 ElemenetType.PACKAGE --------------------------------包声明 
 ElemenetType.PARAMETER ------------------------------参数声明 
 ElemenetType.TYPE----------------------------------- 类，接口（包括注解类型）或enum声明 

@Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中，包括：

 RetentionPolicy.SOURCE-------------注解将被编译器丢弃 
 RetentionPolicy.CLASS -------------注解在class文件中可用，但会被VM丢弃 
 RetentionPolicy.RUNTIME ---------VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。

@Documented 将此注解包含在 javadoc 中 ，它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。

@Inherited 允许子类继承父类中的注解。

实现自定义的注解

1. 定义注解

import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
    public int id();
    public String description() default "no description!";
}

2. 使用注解的类

public class PasswordUtils {
    @UseCase(id =47,description = "密码格式验证")
    public boolean validatePassword(String password) {
        return (password.matches("\\w*\\d\\w*"));
    }

    @UseCase(id = 48)
    public String encryptPassword(String password) {
        return new StringBuilder(password).reverse().toString();
    }

    @UseCase(id = 49,description = "是否存在密码库中？")
    public boolean checkForNewPassword(List<String> prevPassword, String password) {
        return !prevPassword.contains(password);
    }
}

3. 注解处理器

public class UseCaseTracker {

    public static void trackUseCase(List<Integer> useCase, Class<?> cl) {
        for (Method method : cl.getDeclaredMethods()) {
            UseCase uCase = method.getAnnotation(UseCase.class);
            if (uCase != null) {
                System.out.println("方法上的注解信息："+uCase.id()+"  "+uCase.description());
            }
        }

        for (Integer integer : useCase) {
            System.out.println("参数："+integer);
        }
    }

    public static void main(String[] args) {
        List<Integer> uList = new ArrayList<>();
        Collections.addAll(uList, 47,48,49,50);
        trackUseCase(uList, PasswordUtils.class);
    }
}