JAVA註解應用之合成數據庫查詢語句

自Java5.0版本引入註解之後,它就成爲了Java平臺中非常重要的一部分。開發過程中,我們也時常在應用代碼中會看到諸如@Override,@Deprecated這樣的註解。
在使用註解之前，程序源數據只是通過java註釋和javadoc，但是註解提供的功能要遠遠超過這些。註解不僅包含了元數據，它還可以作用於程序運行過程中、註解解釋器可以通過註解決定程序的執行順序

使用註解來以及反射來實現的數據庫查詢。GreenDao即是應用了這個技術

創建一個table註解

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

Column，用於標記元素

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

和數據庫中的表格對應

@Table("user")
public class Filtter {
    @Column("id")
    private int id;
    @Column("userName")
    private String userName;
    @Column("naickName")
    private String naickName;
    private int age;
    private String city;
    @Column("Email")
    private String Email;

    public int getId() {
        return id;
    }

    public String getEmail() {
        return Email;
    }

    public void setEmail(String email) {
        Email = email;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUserName() {
        return userName;
    }

    public void setUserName(String userName) {
        this.userName = userName;
    }

    public String getNaickName() {
        return naickName;
    }

    public void setNaickName(String naickName) {
        this.naickName = naickName;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getCity() {
        return city;
    }

    public void setCity(String city) {
        this.city = city;
    }
}

用於合成查詢語句的方法

private static String query(Filtter f) {
        StringBuilder sb = new StringBuilder();
        // 1.獲取到table的名字
        Class c = f.getClass();
        // 2.獲取到table的名字
        boolean exists = c.isAnnotationPresent(Table.class);

        if (!exists) {
            return null;

        }
        Table t = (Table) c.getAnnotation(Table.class);
        String tableName = t.value();

        sb.append("select * from ").append(tableName).append(" where1=1 ");

        // 3.歷遍所有的字段
        Field[] fArray = c.getDeclaredFields();
        for (Field field : fArray) {
            // 4.處理每個字段對應的sql
            // 4.1拿到字段名
            boolean fExists = field.isAnnotationPresent(Column.class);
            if (!fExists) {
                continue;

            }
            Column column = field.getAnnotation(Column.class);
            String columnName = column.value();
            // 4.2拿到字段的值
            String filedName = field.getName();
            String getMethodName = "get" + filedName.substring(0, 1).toUpperCase() + filedName.substring(1);
            Object fieldValue = null;
            try {
                Method getMethod = c.getMethod(getMethodName);

                fieldValue = getMethod.invoke(f);

            } catch (Exception e) {
                // TODO Auto-generated catch block
                e.printStackTrace();
            }
            // 4.3拼裝sql
            if (fieldValue == null || (fieldValue instanceof Integer && (Integer) fieldValue == 0)) {
                continue;
            }
            sb.append(" and ").append(filedName);
            if (fieldValue instanceof String) {
                if (((String) fieldValue).contains(",")) {// 代表子查詢
                    String[] values = ((String) fieldValue).split(",");
                    sb.append(" in(");
                    for (String v : values) {
                        sb.append("'").append(v).append("'").append(",");
                    }
                    sb.deleteCharAt(sb.length() - 1);
                    sb.append(")");
                } else {
                    sb.append("=").append("\"").append(fieldValue).append("\"");
                }
            } else {
                sb.append("=").append(fieldValue);
            }
        }

        return sb.toString();

    }

其中利用反射查找到每一個具有Column註解的進而進行查詢

對其進行測試

    public static void main(String[] args) {
        Filtter filtter = new Filtter();
        filtter.setId(2);
        filtter.setUserName("jianguotang");
        filtter.setNaickName("jian");
        filtter.setEmail("[email protected],[email protected]");//查詢郵箱爲任意一個
        String str = query(filtter);
        System.out.println(str);
    }

結果

• 註解方法不能帶有參數；
• 註解方法返回值類型限定爲：基本類型、String、Enums、Annotation或者是這些類型的數組；
• 註解方法可以有默認值；
• 註解本身能夠包含元註解，元註解被用來註解其它註解。

這裏有四種類型的元註解：
1. @Documented —— 指明擁有這個註解的元素可以被javadoc此類的工具文檔化。這種類型應該用於註解那些影響客戶使用帶註釋的元素聲明的類型。如果一種聲明使用Documented進行註解，這種類型的註解被作爲被標註的程序成員的公共API。
2. @Target——指明該類型的註解可以註解的程序元素的範圍。該元註解的取值可以爲TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元註解沒有出現，那麼定義的註解可以應用於程序的任何元素。
3. @Inherited——指明該註解類型被自動繼承。如果用戶在當前類中查詢這個元註解類型並且當前類的聲明中不包含這個元註解類型，那麼也將自動查詢當前類的父類是否存在Inherited元註解，這個動作將被重複執行知道這個標註類型被找到，或者是查詢到頂層的父類。
4. @Retention——指明瞭該Annotation被保留的時間長短。RetentionPolicy取值爲SOURCE,CLASS,RUNTIME。

Java內建註解

Java提供了三種內建註解。

1. @Override——當我們想要複寫父類中的方法時，我們需要使用該註解去告知編譯器我們想要複寫這個方法。這樣一來當父類中的方法移除或者發生更改時編譯器將提示錯誤信息。

2. @Deprecated——當我們希望編譯器知道某一方法不建議使用時，我們應該使用這個註解。Java在javadoc 中推薦使用該註解，我們應該提供爲什麼該方法不推薦使用以及替代的方法。

3. @SuppressWarnings——這個僅僅是告訴編譯器忽略特定的警告信息，例如在泛型中使用原生數據類型。它的保留策略是SOURCE（譯者注：在源文件中有效）並且被編譯器丟棄。