注解可以理解為是一套必須帶有默認(rèn)值的接口方法，相比接口，注解在代碼中更像是一種描述或者標(biāo)記。
Java里有三種標(biāo)準(zhǔn)注解：
@Override -- 標(biāo)記為覆蓋超類方法。
@Deprecated -- 標(biāo)記為過(guò)期。
@SuppressWarnings -- 標(biāo)記為不提示編譯警告。
四種元注解（負(fù)責(zé)注解其他注解）：
@Target -- 標(biāo)記注解使用范圍。（FIELD-域，METHOD-方法，TYPE-類型，CONSTRUCTOR-構(gòu)造器，等等）
@Retention -- 標(biāo)記為保存該注解信息的級(jí)別。（RUNTIME-VM在運(yùn)行期也保留注解，因此可以通過(guò)反射機(jī)制讀取注解信息，SOURCE-注解會(huì)被編譯器丟棄，CLASS-注解正在class文件中可用，但會(huì)被VM丟棄）
@Documented --標(biāo)記此注解包含在Javadoc中。
@Inherited -- 允許子類繼承父類中的注解。
模擬數(shù)據(jù)庫(kù)字段約束示例
所有注解的RetentionPolicy都是RUNTIME，這樣才可以在注解處理器中用反射獲取注解信息。
//Target約束注解為TYPE，注解用于‘類’
//注解數(shù)據(jù)庫(kù)表，name()為表名
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
String name() default "";
}
//Target約束注解為FIELD，注解用于‘域’
//此注解為約束，設(shè)置字段是否主鍵，是否允許為空，是否為唯一索引等
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Constraints {
boolean primaryKey() default false;
boolean allowNull() default true;
boolean unique() default false;
}
//整數(shù)字段類型的注解，表示某個(gè)域?yàn)檎?//同時(shí)嵌套了Constraints約束注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLInteger {
String name() default "";
Constraints constraints() default @Constraints;
}
//同SQLInteger注解，這是一個(gè)VARCHAR類型的域注解
//length為設(shè)定長(zhǎng)度
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLString {
//字段長(zhǎng)度
int length() default 0;
String name() default "";
Constraints constrants() default @Constraints;
}
//Decimal類型
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLDecimal {
//字段名稱
String name() default "";
//長(zhǎng)度為10
int length() default 10;
//精度為2
int precision() default 2;
Constraints constraints() default @Constraints;
}
創(chuàng)建一張表，用注解描述表名和字段類型
//表名為MemberName
@DBTable(name = "MemberName")
public class Member {
//默認(rèn)賦值到int
@SQLString(length = 30)
private String firstName;
@SQLString(length = 50)
private String lastName;
@SQLInteger
private Integer age;
@SQLString(length = 30, constrants = @Constraints(primaryKey = true))
private String handle;
@SQLDecimal
private BigDecimal salary;
getters() and setters ..
}
讀取創(chuàng)建信息的注解處理器（反射）
public class TableCreator {
public static void main(String[] args) throws ClassNotFoundException {
String[] tables = new String[]{"chapter20_annotation.generatingExternalFiles.Member"};
for (String className : tables ) {
//反射得到類型信息
Class<?> cl = Class.forName(className);
//獲取類上指定的注解
DBTable dbTable = cl.getAnnotation(DBTable.class);
//如果參數(shù)列表的類中不存在DBTable注解，跳過(guò)
if (dbTable == null) {
System.out.println("No Table annotation in class " + className);
continue;
}
String tableName = dbTable.name();
if (tableName.length() < 1) {
tableName = cl.getName().toUpperCase();
}
//類型注解名稱
System.out.println("tableName: " + tableName);
List<String> columnDefs = new ArrayList<>();
//獲取類中的成員
for (Field field : cl.getDeclaredFields()) {
//字段名稱
String columnName = null;
//獲取成員上的注解列表
Annotation[] anns = field.getDeclaredAnnotations();
if (anns.length < 1)
continue;
//數(shù)據(jù)庫(kù)表中每個(gè)字段只會(huì)有一種數(shù)據(jù)類型，數(shù)據(jù)類型注解中嵌套了約束注解，所以只需用anns[0]
if (anns[0] instanceof SQLInteger) {
SQLInteger sInt = (SQLInteger) anns[0];
if (sInt.name().length() < 1) {
columnName = field.getName().toUpperCase();
} else {
columnName = sInt.name();
}
columnDefs.add(columnName + " INT" + getConstraints(sInt.constraints()));
}
if (anns[0] instanceof SQLString) {
SQLString sString = (SQLString) anns[0];
if (sString.name().length() < 1) {
columnName = field.getName().toUpperCase();
} else {
columnName = sString.name();
}
columnDefs.add(columnName + " VARCHAR(" + sString.length() + ")" + getConstraints(sString.constrants()));
}
if (anns[0] instanceof SQLDecimal) {
SQLDecimal sDecimal = (SQLDecimal) anns[0];
if (sDecimal.name().length() < 1) {
columnName = field.getName().toUpperCase();
} else {
columnName = sDecimal.name();
}
columnDefs.add(columnName + " Decimal(" + sDecimal.length() + ", " + sDecimal.precision() + ")" + getConstraints(sDecimal.constraints()));
}
}
StringBuilder createCommand = new StringBuilder("CREATE TABLE " + tableName + "(");
for (String columnDef : columnDefs)
createCommand.append("\n ").append(columnDef).append(".");
String tableCreate = createCommand.substring(0, createCommand.length() - 1) + ");";
System.out.println("Table Creation SQL for " + className + " is :\n" + tableCreate);
}
}
打印結(jié)果
tableName: MemberName
Table Creation SQL for chapter20_annotation.generatingExternalFiles.Member is :
CREATE TABLE MemberName(
FIRSTNAME VARCHAR(30).
LASTNAME VARCHAR(50).
AGE INT.
HANDLE VARCHAR(30) PRIMARY KEY.
SALARY Decimal(10, 2));
注解處理器解析出代碼中的注解，并根據(jù)數(shù)據(jù)庫(kù)語(yǔ)法規(guī)則打印出創(chuàng)建MemberName表的SQL語(yǔ)句。以上自定義注解的RetentionPolicy.RUNTIME設(shè)定，可以在運(yùn)行時(shí)期通過(guò)Java反射機(jī)制獲取注解在內(nèi)存模型中的信息。
下面的圖是我根據(jù)自己的理解畫(huà)的，比較簡(jiǎn)單。
Java通過(guò)反射進(jìn)入內(nèi)存模型中的方法區(qū)，方法區(qū)里包含類型信息，getAnnotation()方法可以獲得類上指定的注解，示例中是檢查了DBTable注解是否存在在這個(gè)類中，獲取DBTable注解后通過(guò) dbTable.name()就獲取到設(shè)定的表名（注解可以理解成是帶有默認(rèn)值的接口，所以這個(gè)操作就是獲取了方法的返回值）。同樣在域值上，field.getDeclaredAnnotations()方法可以獲取某個(gè)域上的注解列表，然后遍歷注解列表逐個(gè)解析。理解了內(nèi)存模型，這一點(diǎn)就不難了。
Remark
Spring里有很多在類型上的注解，比如@Service，@Controller，等都可以自定義一個(gè)類名，當(dāng)然在真實(shí)框架中不可能用這么暴力的注解處理器，每次都去做全局的遍歷，《Thinking In Java》中提到了觀察者模式下的注解處理器，還沒(méi)怎么看明白，先在此記錄一下注解本身的原理和用法吧~ 再接再厲~
