什么是注解
注解（也被稱為元數(shù)據(jù)）為我們在代碼中添加信息提供了一種形式化的方法因苹，使我們可以在稍后某個(gè)時(shí)刻方便地使用這些數(shù)據(jù)赎瑰。
注解可以提供用來完整地描述程序所需的信息，而這些信息是無法用Java來表達(dá)的。
注解的作用及好處
- 使我們能夠以將由編譯器來測試和驗(yàn)證的格式设预，存儲(chǔ)有關(guān)程序的額外信息脐彩。
- 注解可以用來生成描述符文件碎乃，甚至是新的類定義，并且有助于減輕編寫“樣板”代碼的負(fù)擔(dān)惠奸。
- 通過使用注解梅誓，我們可以將這些元數(shù)據(jù)保存在 Java 源代碼中，并利用 annotation API 為自己的注解構(gòu)造處理工具佛南。
- 更加干凈易讀的代碼以及編譯期類型檢查梗掰。
注解的基本語法
注解的語法比較簡單，除了 @ 符號(hào)的使用之外嗅回，他基本與 Java 固有的語法一致及穗。
Java SE5 內(nèi)置了三種，定義在 java.lang 中的注解：@Override 绵载、@Deprecated埂陆、@SuppressWarnings苛白。
基本示例
在下面的例子中，使用 @Test 對 testExecute() 方法進(jìn)行注解焚虱。該注解本身并不做任何事情购裙，但是編譯器要確保在其構(gòu)造路徑上必須有 @Test 注解的定義。
定義注解：
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
以上代碼就是 @Test 注解的定義著摔，與接口的定義非常類似缓窜，事實(shí)上，注解與接口一樣谍咆，也會(huì)編譯成 class文件禾锤。
除了 @ 符號(hào)以外，@ Test 的定義很像一個(gè)空的接口摹察。定義注解時(shí)恩掷，會(huì)需要一些元注解（meta-annotation）,如 @Target 和 @Retention。@Target 用來定義你的注解將應(yīng)用于什么地方（例如一個(gè)方法或者是一個(gè)域）供嚎。@Rectetion 用來定義該注解在哪一個(gè)級(jí)別可用黄娘，在源代碼中（SOURCE）、類文件(CLASS)中或者運(yùn)行時(shí)(RUNTIME)克滴。
在注解中逼争，一般都會(huì)包含一些元素以表達(dá)某些值，當(dāng)分析處理注解時(shí)劝赔，程序或工具可以利用這些值誓焦。注解元素看起來就像接口的方法，唯一的區(qū)別就是你可以為其指定默認(rèn)值着帽。
沒有元素的注解稱為標(biāo)記注解(marker annotation)杂伟，例如上例中的 @Test。
給方法加注解：
public class Testable {
public void execute(){
System.out.println("Executing..");
}
@Test void testExecute(){execute();}
}
被注解的方法與其他方法沒有區(qū)別仍翰。這個(gè)例子中赫粥，注解 @Test可以與任何修飾符共同作用于方法，從語法角度看予借，注解的使用方式幾乎和修飾符的使用一模一樣越平。
元注解
Java 目前內(nèi)置了三種標(biāo)準(zhǔn)注解（@Override、@Deprecated蕾羊、@SuppressWarnings）喧笔，以及四種元注解，元注解專職負(fù)責(zé)注解其他的注解：
- @Target表示該注解可以作用于什么地方龟再∈檎ⅲ可能的 ElementType 參數(shù)包括：
- CONSTRUCTOR:構(gòu)造器的聲明
- FIELD:域（即成員變量）聲明（包括enum實(shí)例）
- LOCAL_VARIABLE:局部變量聲明
- METHOD:方法聲明
- PACKAGE:包聲明
- PARAMTETER:參數(shù)聲明
- TYPE:類、接口（包括注解類型）或enum聲明
- @Retention表示需要什么級(jí)別保存該注解信息利凑。浆劲∠邮酰可選的 RetentionPolicy 參數(shù)包括：
- SOURCE:注解將被編譯器丟棄
- CLASS:注解在 class 文件中可用，但會(huì)被 VM 丟棄
- RUNTIME:VM 將在運(yùn)行期也保留注解牌借，因此可通過反射機(jī)制讀取注解信息
- @Documented ：將此注解包含在 Javadoc中
- @Inherited：允許子類繼承父類中的注解
簡單注解處理器
我們有時(shí)需要根據(jù)注解來做一些統(tǒng)計(jì)度气，來掌控項(xiàng)目進(jìn)展。下面我們做一個(gè)小 Demo膨报，來統(tǒng)計(jì)已實(shí)現(xiàn)的需求和未實(shí)現(xiàn)的需求磷籍。
首先定義注解，用 id 來區(qū)分方法现柠，description 來存儲(chǔ)一些方法說明院领，這一項(xiàng)不填即為默認(rèn)值。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
public int id();
public String description() default "no description";
}
接下來寫一個(gè)待檢查的方法：
public class PassWordUtils {
@UseCase(id=47,description=
"密碼最起碼要有一個(gè)數(shù)字吧")
public boolean validatePassword(String password){
return (password.matches("\\w\\d\\w*"));
}
@UseCase(id=48)
public String encryptPassword(String password){
return new StringBuilder(password).reverse().toString();
}
@UseCase(id=49,description=
"新密碼不能和老密碼這么像吧")
public boolean checkForNewPassword(
List<String> prevPasswords,String password){
return !prevPasswords.contains(password);
}
}
最后編寫注解處理器够吩，用來統(tǒng)計(jì)我們已經(jīng)實(shí)現(xiàn)的方法和還未實(shí)現(xiàn)的方法比然。
public class UseCaseTracker {
public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
//遍歷該類的所有方法
for(Method m:cl.getDeclaredMethods()){
//獲取加在方法上的UseCase注解
UseCase uc=m.getAnnotation(UseCase.class);
if(uc!=null){//如果方法上確實(shí)有UseCase注解
System.out.println("找到了用例:"+uc.id()+" "+uc.description());
useCases.remove(new Integer(uc.id()));
}
}
for(int i:useCases){
System.out.println("警告：丟失用例:"+i);
}
}
public static void main(String[] args) {
List<Integer> useCases=new ArrayList<>();
Collections.addAll(useCases, 47,48,49,50,51);
trackUseCases(useCases, PassWordUtils.class);
}
}
最后輸出結(jié)果如下：
注解處理器最佳實(shí)踐
下面我們通過注解要實(shí)現(xiàn)的需求是：通過在 JavaBean 上加注解，生成對應(yīng)的 SQL 語句周循。這類似于 JavaWeb 的某些框架强法，雖然是個(gè)十分簡單的功能，但是卻是這些框架的基本原理湾笛。
下面先定義一個(gè)注解饮怯，這個(gè)注解用來告訴注解處理器，你需要為我生成的數(shù)據(jù)庫表名叫什么：
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
public String name() default "";
}
接下來是數(shù)據(jù)庫中的各個(gè)字段嚎研，你需要告訴處理器你的字段名硕淑、類型、是否為主鍵嘉赎、是否唯一等等。
首先定義一個(gè)注解于樟，用來告訴處理器你的字段約束公条。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Constraints {
boolean primaryKey() default false;
boolean allowNull() default true;
boolean unique() default false;
}
接下來是字段類型，我們只選兩個(gè)代表迂曲，String 和 Int靶橱。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLString {
int value() default 0;
String name() default "";
Constraints constraints() default @Constraints;
}
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLInteger {
String name() default "";
Constraints constraints() default @Constraints;
}
下面是一個(gè)簡單 Bean 的定義,用到了以上的注解：
@DBTable(name = "STUDENT")
public class Student {
@SQLString(value = 30, name = "studentname", constraints = @Constraints(allowNull = false))
String name;
@SQLString(value = 50, constraints = @Constraints(unique = true))
String enjoy;
@SQLInteger(constraints = @Constraints(allowNull = false))
Integer age;
@SQLString(value = 30, constraints = @Constraints(primaryKey = true))
String teacherName;
}
最后是注解處理器，它將讀取一個(gè)類文件路捧，檢查其上的數(shù)據(jù)庫注解关霸，并生成用來創(chuàng)建數(shù)據(jù)庫的 SQL 命令：
public class TableCreator {
public static void main(String[] args) throws Exception {
Class cl=Student.class;
DBTable dbTable = (DBTable) cl.getAnnotation(DBTable.class);
if (dbTable == null) {
System.out.println(cl.getSimpleName() + "類不能生成一個(gè)數(shù)據(jù)庫表格");
return;
}
String tableName = dbTable.name();
if (tableName.length() < 1) {
tableName = cl.getSimpleName().toUpperCase();
}
List<String> columnDefs = new ArrayList<>();
for (Field field : cl.getDeclaredFields()) {
Annotation[] ans = field.getDeclaredAnnotations();
if (ans.length < 1) continue;
String columnName = null;
if (ans[0] instanceof SQLInteger) {
SQLInteger sInt = (SQLInteger) ans[0];
if (sInt.name().length() < 1) {
columnName = field.getName().toUpperCase();
} else {
columnName = sInt.name().toUpperCase();
}
columnDefs.add(columnName + " INT " + getConstraints(sInt.constraints()));
} else if (ans[0] instanceof SQLString) {
SQLString sString = (SQLString) ans[0];
if (sString.name().length() < 1) {
columnName = field.getName().toUpperCase();
} else {
columnName = sString.name().toUpperCase();
}
columnDefs.add(columnName + " VARCHAR(" + sString.value() + ") " + getConstraints(sString.constraints()));
}
}
StringBuilder createCommand = new StringBuilder(
"CREATE TABLE " + tableName + "("
);
for (String columnDef : columnDefs) {
createCommand.append("\n " + columnDef + ",");
}
String tableCreate=createCommand.substring(0,createCommand.length()-1)+");";
System.out.println("根據(jù)" + cl.getName() + "創(chuàng)建數(shù)據(jù)庫：\n" + tableCreate);
}
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;
}
}
我們實(shí)現(xiàn)的功能還很低級(jí)，如果你要改任何屬性或者參數(shù)杰扫，都要重新編譯 Java 代碼队寇，現(xiàn)在的很多框架都會(huì)生成 XML 文件，而不是 SQL 語句章姓，但基本原理都是這樣的佳遣。
最后
本篇文章只是 《Java 編程思想》的學(xué)習(xí)筆記识埋，看了網(wǎng)上的很多資料，覺得還是這本書講的最好零渐。
