Java annotation入门

Contents

1. Java中常见注解
2. 注解的分类
3. 自定义注解

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

Java中常见注解

@Override ：表示当前的方法定义将覆盖超类中的方法。如果有错误，编译器将发出错误提示。
@Deprescated：被弃用的方法
@SuppressWarnings：关闭不当的编译器警告信息。

注解的分类

按照运行机制分：源码注解，编译时注解，运行时注解
按照来源分：来自JDK的注解，来着第三方的注解，我们自己定义注解

自定义注解

定义注解

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

使用#interface声明注解，成员以无参无异常方式声明，可以用default为成员指定默认值，成员类型是受限的，合法的类型包括原始类型及String，Class，Annotation，Enumeration以及以上类型的数组。如果注解只有一个成员，则成员名必须取名为value（）,在使用时可以忽略成员名和赋值号。

元注解

@Target ：表示该注解可以用于什么地方。ElementType参数包括：
CONSTRUCTOR：构造器的声明
FIELD：域声明（包括enum实例）
LOCAL_VARIABLE：局部变量声明
METHOD：方法声明
PACKAGE：包声明
PARAMETER：参数声明
TYPE：类、接口（包括注解类型）或enum声明

@Retention ：表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括
SOURCE：注解将被编译器丢弃
CLASS：注解在class文件中可用，但会被VM丢弃
RUNTIME：VM将在运行期也保留注解，因此可以通过反射机制读取注解的信息。

@Documented ：将此注解包含在Javadoc中

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

使用注解
@<注解名>(<成员名1>=<成员值1>,<成员名2>=<成员值2>,…)

@Description(desc="I am eyeColor",author="Mooc boy",age=18)
public Sring eyeColor(){
    return "red";
}

编写注解处理器
通过反射获取类、函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑。

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());
                useCases.remove(new Integer(uc.id()));
            }
        }
        for(int i : useCases){
            System.out.println("Warning: Missing use case:"+i);
        }
    }
    public static void main(String[] args){
        ArrayList<Integer> useCases = new ArrayList<Integer>();
        Collections.addAll(useCases, 47,48,49,50);
        trackUseCases(useCases, PasswordUtils.class);
    }
}

注解定义

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