[TOC]

概念

注解（Annotation）為我們在代碼中添加信息提供了一種形式化的方法，使我們可以在稍后某個時刻非常方便地使用這些數(shù)據(jù)

每當創(chuàng)建描述符性質(zhì)的類和接口時，一旦其中包含了重復(fù)性的工作，就可以考慮使用注解來簡化與自動化該過程。
注解可用來進行一些提示性、安全檢查的作用（如標記注解，@Override等），也可用來在運行時進行邏輯上的操作，簡化模板式代碼的創(chuàng)建，使代碼更加簡潔，編寫更加高效。注解常見于各種框架當中，學(xué)會注解可以對框架理解的更加深入。

注解的類型

注解的分類

按來源可以分為JDK自帶注解、第三方框架注解、自定義注解。
JDK自帶注解

按聲明周期可以分為源碼注解、編譯時注解、運行時注解（下述祥）

元注解

元注解是用來注解其他注解的注解

@Target的參數(shù)ElementType包括以下幾種：

@Retention可選的RetentionPolicy參數(shù)包括：

自定義注解

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

public class PasswordUtils {
    @UseCase(id = 47, description = "must contain at least one numeric")
    public void validatePassword(String password) {
        // TODO: 2016/12/21  
    }
}

注解可用的元素類型如下：所有基本類型（int，float等），String，Class，enum，Annotation，以上類型的數(shù)組
如果注解只有一個類型一般用value()命名，用value()命名的時候，使用注解不需要以價值對的形式給出值

注解解釋器

使用Java的反射機制編寫注解解釋器讀取注解的信息。
實例如下需求如下：使用注解創(chuàng)建數(shù)據(jù)庫查詢的過濾器。

// Table.java
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
    String value();
}

// Column.java
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    String value();
}

// Filter.java
@Table("users")
public class Filter {

    @Column("name")
    private String name;

    @Column("email")
    private String email;

    @Column("phone")
    private String phone;

    @Column("age")
    private int age;

    @Column("sex")
    private int sex;

    public String getName() {
        return name;
    }
    // 省略了其余的getter和setter方法
}

// Test.java
public class Test {

    public static void main(String[] args) {
        Filter f1 = new Filter();
        f1.setName("Akis");
        f1.setAge(22);

        Filter f2 = new Filter();
        f2.setName("xcc");
        f2.setSex(1);
        f2.setPhone("******");

        String sql1 = query(f1);
        String sql2 = query(f2);

        System.out.println(sql1);
        System.out.println(sql2);
    }


    public static String query(Filter filter) {
        StringBuilder sb = new StringBuilder();
        sb.append("SELECT * FROM ");

        Class c = filter.getClass();
        Table table = (Table) c.getAnnotation(Table.class);
        String tableName = table.value();
        sb.append(tableName).append(" WHERE 1 = 1");

        Field[] fields = c.getDeclaredFields();
        for (Field field : fields) {
            Column column = field.getDeclaredAnnotation(Column.class);
            String columnName = column.value();
            String methodName = "get" + field.getName().substring(0, 1).toUpperCase() + field.getName().substring(1);
            Object columnValue = null;
            try {
                Method method = c.getDeclaredMethod(methodName);
                columnValue = method.invoke(filter);
            } catch (NoSuchMethodException e) {
                e.printStackTrace();
            } catch (InvocationTargetException e) {
                e.printStackTrace();
            } catch (IllegalAccessException e) {
                e.printStackTrace();
            }
            if (columnValue instanceof String) {
                sb.append(" AND ").append(columnName).append("=").append("'").append(columnValue).append("'");
            } else if (columnValue instanceof Integer && (Integer)columnValue != 0) {
                sb.append(" AND ").append(columnName).append("=").append(columnValue);
            }
        }
        sb.append(";");
        return sb.toString();
    }
}

// output
SELECT * FROM users WHERE 1 = 1 AND name='Akis' AND age=22;
SELECT * FROM users WHERE 1 = 1 AND name='xcc' AND phone='******' AND sex=1;