java注解

概念解释

注解(也被称为元数据)为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后某个时刻非常方便的使用这些数据。

实例解释

• 定义注解

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

• 注解使用样例

public class PasswordUtils {
    @UserCase(id = 47, description = "Passwords must contain at least one numeric")
    public boolean validatePassword(String password) {
        return (password.matches("\\w*\\d\\w*"));
    }

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

    @UserCase(id = 49, description = "New passwords can't equal previously used ones")
    public boolean checkForNewPassword(List prevPasswords, String password) {
        return !prevPasswords.contains(password);
    }
}

• 注解处理器

public class UserCaseTrack {
    public static void trackUserCases(List userCases, Class cl) {
        for (Method m : cl.getDeclaredMethods()) {
            UserCase uc = m.getAnnotation(UserCase.class);
            if (uc != null) {
                System.out.println("Found Use Case:" + uc.id() + " " + uc.description());
                userCases.remove(new Integer(uc.id()));
            }
        }
        for (int i : userCases) {
            System.out.println("Warning: Missing use Case-" + i);
        }
    }

    public static void main(String[] args) {
        List useCases = new ArrayList();
        Collections.addAll(useCases, 47, 48, 49);
        trackUserCases(useCases, PasswordUtils.class);
    }
}

元注解类型说明

java目前只内置了三种标准注解@Override,@Deprecated,@SuppressWarnings,以及四种元注解。元注解专职负责注解其他的注解。

• @Target 表示该注解可以用于什么地方，参数说明：
  1. CONSTRUCTOR:构造器的声明
  2. FIELD:域声明
  3. LOCAL_VARIABLE:局部声明
  4. METHOD:方法声明
  5. PACKAGE:包声明
  6. PARAMETER:参数说明
  7. TYPE:类、接口（包括注解类型）或enum生命
• @Retention 表示需要在什么级别保存该注解信息，可选的RetentionPolicy参数包括：
  1. SOURCE:注解将被编译器丢弃
  2. CLASS:注解在class文件可用，但会被JVM丢弃
  3. RUNTIME:VM将在运行期也保留注解，因此可以通过反射机制读取注解信息。
• @Documented 将此注解包含在Javadoc中
• @Inherited 允许子类继承父类中的注解

注解元素类型

注解元素可用的类型如下所示：

• 所有的基本类型（int, float, boolean等）
• String
• Class
• Annotation
• 以上类型的数组

注意事项

注解元素不能有不确定的值，也就是说，元素要么具有默认值，要么在使用注解时提供元素的值。如UserCase必须在使用注解时必须使用指定id，而description可以不用指定。