自定義註解初步學習

lkj41110發表於2016-12-23

相信大家或多或少接觸或者使用過java的註解

比如java.lang包中的註解：
@Override ：表示該方法覆蓋父類的方法，當方法拼寫錯誤或者和父類的對應不上時，編譯器會報錯
@SuppressWarnings ：關閉編譯器的警告報錯
比如用過Spring框架的朋友肯定會熟悉很多註解。等等

基本用法

元註解：元註解的作用就是負責註解其他註解。Java5.0定義了4個標準的meta-annotation型別，它們被用來提供對其它 annotation型別作說明。Java5.0定義的元註解：
　　　　1.@Target
　　　　2.@Retention,
　　　　3.@Documented,
　　　　4.@Inherited
　　這些型別和它們所支援的類在java.lang.annotation包中可以找到。下面我們看一下每個元註解的作用和相應分引數的使用說明。
　　
@Target：
　　　@Target說明了Annotation所修飾的物件範圍：Annotation可被用於 packages、types（類、介面、列舉、Annotation型別）、型別成員（方法、構造方法、成員變數、列舉值）、方法引數和本地變數（如迴圈變數、catch引數）。在Annotation型別的宣告中使用了target可更加明晰其修飾的目標。
　　作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）
　　取值(ElementType)有：
　　　　1.CONSTRUCTOR:用於描述構造器
　　　　2.FIELD:用於描述域
　　　　3.LOCAL_VARIABLE:用於描述區域性變數
　　　　4.METHOD:用於描述方法
　　　　5.PACKAGE:用於描述包
　　　　6.PARAMETER:用於描述引數
　　　　7.TYPE:用於描述類、介面(包括註解型別) 或enum宣告

@Retention：
　　@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在原始碼中，而被編譯器丟棄；而另一些卻被編譯在class檔案中；編譯在class檔案中的Annotation可能會被虛擬機器忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因為Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對 Annotation的“生命週期”限制。
　　作用：表示需要在什麼級別儲存該註釋資訊，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）
　　取值（RetentionPoicy）有：
　　　　1.SOURCE:在原始檔中有效（即原始檔保留）
　　　　2.CLASS:在class檔案中有效（即class保留）
　　　　3.RUNTIME:在執行時有效（即執行時保留）
以上參考：http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html

自定義註解

註解的定義看起來和介面很像，只是在前面多了個@，並且在定義註解時，要用到我們上面介紹的元註解，來規定我們的註解使用的那個的地方。與java介面一樣，註解會編譯成class檔案

下面是一個自定義註解，用來建立sql建表語句。

package zhujie;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 自定義標籤
 * @author lk
 */
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
    public String name() default "";
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface Constraints{
    boolean primaryKey() default false;
    boolean allowNull() default true;
    boolean unique() default false;
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface SQLInteger{
    String name() default "";
    Constraints constraints() default @Constraints; 
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface SQLString{
    int value() default 0;
    String name() default "";
    Constraints constraints() default @Constraints; 
}

這樣我們可以在類中使用我們的自定義註解

package zhujie;

@DBTable(name = "MEMBER")
public class Member {
    @SQLString(30)
    private String firstName;
    @SQLString(50)
    private String lastName;
    @SQLInteger
    private Integer age;
    @SQLString(value = 30, constraints = @Constraints(primaryKey = true))
    private String handle;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public Integer getAge() {
        return age;
    }

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

    public String getHandle() {
        return handle;
    }

    public void setHandle(String handle) {
        this.handle = handle;
    }

}

但是這樣的註解和註釋其實沒有很大的區別，當註解和註解處理器一起使用時才能顯示他的作用。

package zhujie;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

public class TableCreator {
    public static void main(String[] args) throws ClassNotFoundException {
        System.out.println(creator("zhujie.Member"));
    }

    private static String creator(String string) throws ClassNotFoundException {
        Class<?> cl = Class.forName(string);
        DBTable dbTable = cl.getAnnotation(DBTable.class);
        if (dbTable == null) {
            System.out.println("無效類名");
        }
        // 獲取表名
        String tableName = dbTable.name();
        // 如果沒有設定表名預設用類名大寫
        if (tableName.length() < 1) {
            tableName = cl.getName().toUpperCase();
        }
        List<String> columnDefs = new ArrayList<>();
        //遍歷屬性
        for (Field field : cl.getDeclaredFields()) {
            // 獲取屬性註解
            Annotation[] anns = field.getAnnotations();
            String columnName = null;
            for (Annotation annotation : anns) {
                if (annotation instanceof SQLString) {
                    SQLString sString = (SQLString) annotation;
                    if (sString.name().length() < 1) {
                        columnName = field.getName().toUpperCase();
                    } else {
                        columnName = sString.name();
                    }
                    columnDefs.add(
                            columnName + " VARCHAR(" + sString.value() + ")" + getConstraints(sString.constraints()));
                    break;
                } else if (annotation instanceof SQLInteger) {
                    SQLInteger sInt = (SQLInteger) annotation;
                    if (sInt.name().length() < 1) {
                        columnName = field.getName().toUpperCase();
                    } else {
                        columnName = sInt.name();
                    }
                    columnDefs.add(columnName + " INT" + getConstraints(sInt.constraints()));
                    break;
                } else {
                    continue;
                }
            }
        }
        //建立語句
        StringBuilder createSql=new StringBuilder("CREATE TABLE "+tableName+"(");
        for(String columnDef:columnDefs){
            createSql.append("\r\n\t"+columnDef+",");
        }
        return createSql.substring(0,createSql.length()-1)+"\r\n);";
    }

    /*
     * 屬性後面的約束（唯一，主鍵，是否為空）
     */
    private static String getConstraints(Constraints con) {
        String constraints = "";
        if (!con.allowNull()) {
            constraints += " NOT NULL";
        }
        if (con.primaryKey()) {
            constraints += " PRIMARY KEY";
        }
        if (con.unique()) {
            constraints += " UNIQUE";
        }
        return constraints;
    }
}

結果

CREATE TABLE MEMBER(
    FIRSTNAME VARCHAR(30),
    LASTNAME VARCHAR(50),
    AGE INT,
    HANDLE VARCHAR(30) PRIMARY KEY
);

通過上述的例子（來自java程式設計思想）我們大致可以瞭解到註解的作用和使用方法，當然這只是初步學習，我們用的例子對於真實的物件/關係對映而言（ORM資料庫，比如hibernate），是很幼稚的。

相關文章