Java注解

介绍

注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。
java.lang中内置注解：

• @Override：表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误，或者方法签名对不上覆盖的方法，编译器就会发出错误提示。
• @Deprecated：如果程序员使用了注解为它的元素，那么编译器会发出警告信息
• @SuppressWarnings：关闭不当的编译器警告信息。

元注解：
（1）@Target：表示该注解可以用于什么地方，可能的参数包括：

• CONSTRUCTOR:构造器的声明
• FIELD：域声明（包括enum实例）
• LOCAL_VARIABLE：局部变量声明
• METHOD：方法声明
• PACKAGE：包声明
• PARAMETER：参数声明
• TYPE：类、接口（包括注解类型）或enum声明

（2）Retention：表示需要在什么级别保存该注解信息，可选的参数包括：

• SOURCE：注解将被编译器丢弃
• CLASS：注解在class文件中可用，但被jvm丢弃
• RUNTIME：JVM将在运行期也保留注解，因此可以通过反射机制读取注解的信息

（3）Documented：将此注解包含在Javadoc中
（4）Inherited：允许子类继承父类中的注解

定义注解

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

使用注解

public class PasswordUtils {
    @UseCase(id=47,description = "Passwords must contain at least one numeric")
    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 = "New passwords can't equal previously used ones")
    public boolean checkForNewPassword(List<String> prevPasswords, String password){
        return !prevPasswords.contains(password);
    }
}

注解处理器

public class UseCaseTracker {
    public static void trackUseCases(List<Integer> useCases,Class<?> cl){
        for(Method m:cl.getDeclaredMethods()){
            UseCase uc = m.getAnnotation(UseCase.class);
            if(uc != null){
                System.out.println("Found Use Case:"+uc.id()+" "+uc.description());
            }
        }
        for (int i:useCases){
            System.out.println("Warning: Missing use case-"+i);
        }
    }
    public static void main(String[] args) {
        List<Integer> useCases = new ArrayList<Integer>();
        Collections.addAll(useCases,47,48,49,50);
        trackUseCases(useCases,PasswordUtils.class);
    }
}

• getAnnotation()方法返回指定类型的注解对象，如果没有，则返回null
• getDeclaredMethods()类中所有方法，包括私有的方法

默认值：
（1）元素不能有不确定的值，要么具有默认值，要么使用注解时提供元素的值。
（2）对于非基本类型的元素，无论是定义默认值还是使用时都不能以null作为其值。
（3）可以定义特殊值，比如空字符串""或者负数绕过，表示某元素不存在。