第二十章:注解

注解(元數(shù)據(jù))為我們在代碼中添加信息提供了一種形式化的方法,使我們能在以后方便使用這些數(shù)據(jù)宝惰。
java.lang中的注解:
· @Override
· @Deprecated
· @SuppressWarning
特點(diǎn):

  1. 語言級(jí)概念掌测,一旦構(gòu)造出來,就享有編譯器的類型檢查保護(hù)
  2. 在實(shí)際的源代碼級(jí)別保存所有的信息汞斧,而不是某種注釋性的文字粘勒。使程序員擁有對(duì)源代碼以及字節(jié)碼強(qiáng)大的檢查與操作能力

基本語法

與接口一樣,注解也會(huì)編譯成class文件庙睡。

//定義注解
@Target(ElementType.METHOD) //應(yīng)用地方
@Retention(Retention.Policy.RUNTIME) //應(yīng)用級(jí)別
public @interface UseCase {
  public int id();
  public String description() default "no descritpion";
}

//eg
@UseCase(id = 47, description =
  "Passwords must contain at least one numeric")
  public boolean validatePassword(String password) {
    return (password.matches("\\w*\\d\\w*"));
  }

元注解:

元注解 -
@Target ElementType參數(shù):

CONSTRUCTOR:構(gòu)造器的聲明

FIELD:域聲明(包括enum實(shí)例)

LOCAL_VARIABLE:局部變量聲明

METHOD:方法聲明

PACAKAGE:包聲明

PARAMETER:參數(shù)聲明

TYPE:類乘陪、接口(包括注解類型)或enum聲明
@Retention 注解的生命時(shí)間

RetentionPolicy參數(shù)包括:

SOURCE:源碼注解,      RetentionPolicy.SOURCE :

CLASS:編譯時(shí)注解啡邑,默認(rèn)值谤逼,注解在class文件中可用,但被類加載器加載字節(jié)碼到內(nèi)存時(shí)被VM丟棄流部,注解處理器

RUNTIME:運(yùn)行時(shí)注解VM將在運(yùn)行期也保留注解,因此可以通過反射讀取注解信息舞丛。
@Ducumented 此注解包含在Javadoc中
@Inherited 允許子類繼承父類的注解

注解元素:
注解包含的元素宾茂,可用類型:

  1. 所有基本類型
  2. String
  3. Class
  4. enum
  5. Annotation
  6. 以上類型的數(shù)組

默認(rèn)值限制:
注解元素不能有不確定的值跨晴,要么有默認(rèn)值片林,要么在使用注解是提供元素的值怀骤。而對(duì)于非基本類型的元素焕妙,不能使用null作為默認(rèn)值。為了繞開這個(gè)約束痕届,可以自己定義特殊的值表示某個(gè)元素不存在末患,比如空字符串或負(fù)數(shù)。
注解不支持繼承
不能使用關(guān)鍵字extends來繼承某個(gè)@interface璧针。

繼承的注解

- 編寫自定義注解時(shí)未寫@Inherited的運(yùn)行結(jié)果: 編寫自定義注解時(shí)寫了@Inherited的運(yùn)行結(jié)果:
子類的類上能否繼承到父類的類上的注解探橱?
子類方法,實(shí)現(xiàn)了父類上的抽象方法隧膏,這個(gè)方法能否繼承到注解?
子類方法忌栅,繼承了父類上的方法曲稼,這個(gè)方法能否繼承到注解?
子類方法瑞驱,覆蓋了父類上的方法窄坦,這個(gè)方法能否繼承到注解?

PS: @Inherited只能注解class的注解
子類可以繼承到父類上的注解嗎--有結(jié)論了

編寫注解處理器

public class UseCaseTracker {
  public static void
  trackUseCases(List<Integer> useCases, Class<?> cl) {
    for(Method m : cl.getDeclaredMethods()) {//獲取該類聲明的方法
      UseCase uc = m.getAnnotation(UseCase.class);//返回指定類型的注解對(duì)象
      if(uc != null) {
        System.out.println("Found Use Case:" + uc.id() +
          " " + uc.description());
        useCases.remove(new Integer(uc.id()));
      }
    }
    for(int i : useCases) {
      System.out.println("Warning: Missing use case-" + i);
    }
  }
  public static void main(String[] args) {
    List<Integer> useCases = new ArrayList<Integer>();
    Collections.addAll(useCases, 47, 48, 49, 50);
    trackUseCases(useCases, PasswordUtils.class);
  }
}

getDeclaredMethods()和getAnnotation()都屬于AnotatedElement接口,Class逆趋、Method和Field都實(shí)現(xiàn)了該接口。

@SQLString(30) //如果注解中定義了value的元素名斟,可以使用澤中快捷方式賦值

一個(gè)數(shù)據(jù)庫使用注解生成表的例子:
數(shù)據(jù)庫注解:

//表注解
@Target(ElementType.TYPE) // Applies to classes only
@Retention(RetentionPolicy.RUNTIME)
public @interface DBTable {
  public String name() default "";
} 
//列限制注解
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Constraints {
  boolean primaryKey() default false;
  boolean allowNull() default true;
  boolean unique() default false;
}
//SQL整數(shù)
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLInteger {
  String name() default "";
  Constraints constraints() default @Constraints;
} ///:~
//SQL字符串
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface SQLString {
  int value() default 0;
  String name() default "";
  Constraints constraints() default @Constraints;
} 

數(shù)據(jù)庫bean例子

@DBTable(name = "MEMBER")
public class Member {
  @SQLString(30) String firstName;
  @SQLString(50) String lastName;
  @SQLInteger Integer age;
  @SQLString(value = 30,
  constraints = @Constraints(primaryKey = true))
  String handle;
  static int memberCount;
  public String getHandle() { return handle; }
  public String getFirstName() { return firstName; }
  public String getLastName() { return lastName; }
  public String toString() { return handle; }
  public Integer getAge() { return age; }
} ///:~

數(shù)據(jù)庫注解處理器:

public static void main(String[] args) throws Exception {
    if(args.length < 1) {
      System.out.println("arguments: annotated classes");
      System.exit(0);
    }
    for(String className : args) {
      Class<?> cl = Class.forName(className);
      DBTable dbTable = cl.getAnnotation(DBTable.class);
      if(dbTable == null) {
        System.out.println(
          "No DBTable annotations in class " + className);
        continue;
      }
      String tableName = dbTable.name();
      // If the name is empty, use the Class name:
      if(tableName.length() < 1)
        tableName = cl.getName().toUpperCase();
      List<String> columnDefs = new ArrayList<String>();
      for(Field field : cl.getDeclaredFields()) {
        String columnName = null;
        Annotation[] anns = field.getDeclaredAnnotations();//返回注解數(shù)組
        if(anns.length < 1)
          continue; // Not a db table column
        if(anns[0] instanceof SQLInteger) {
          SQLInteger sInt = (SQLInteger) anns[0];
          // Use field name if name not specified
          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];
          // Use field name if name not specified.
          if(sString.name().length() < 1)
            columnName = field.getName().toUpperCase();
          else
            columnName = sString.name();
          columnDefs.add(columnName + " VARCHAR(" +
            sString.value() + ")" +
            getConstraints(sString.constraints()));
        }
        StringBuilder createCommand = new StringBuilder(
          "CREATE TABLE " + tableName + "(");
        for(String columnDef : columnDefs)
          createCommand.append("\n    " + columnDef + ",");
        // Remove trailing comma
        String tableCreate = createCommand.substring(
          0, createCommand.length() - 1) + ");";
        System.out.println("Table Creation SQL for " +
          className + " is :\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;
  }
} 

上述處理例子是很幼稚的(因?yàn)樾薷谋砻荒苤匦戮幾gjava代碼)闷袒,可以了解一下成熟的將對(duì)象映射到關(guān)系數(shù)據(jù)庫的方法岩梳。

使用apt處理注解

注解處理工具apt是有Sun公司提供的冀值,被設(shè)計(jì)為操作java源文件。默認(rèn)的話池摧,apt會(huì)在處理完源文件后編譯它們。如果在系統(tǒng)構(gòu)建中自動(dòng)創(chuàng)建了一些新的源文件膘魄,apt也會(huì)在新一輪檢查處理竭讳,并將所有文件一同編譯,再循環(huán)灿渴,直到?jīng)]有新源文件產(chǎn)生胰舆。使用apt時(shí)無法使用反射,因?yàn)椴僮鞯氖窃创a而不是編譯產(chǎn)生的類缚窿。
繼承AnnotationProcessor重寫process方法處理AnnotationProcessorFactory導(dǎo)出類傳進(jìn)去的AnnotationProcessorEnvironment對(duì)象倦零,該對(duì)象可以獲得注解及類信息。
補(bǔ)充:

  1. javassit處理字節(jié)碼扫茅,可以用來修改class文件
  2. 注解處理器
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末葫隙,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌钙态,老刑警劉巖菇晃,帶你破解...
    沈念sama閱讀 216,496評(píng)論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件蚓挤,死亡現(xiàn)場離奇詭異灿意,居然都是意外死亡估灿,警方通過查閱死者的電腦和手機(jī)馅袁,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門荒辕,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人弛针,你說我怎么就攤上這事李皇。” “怎么了掉房?”我有些...
    開封第一講書人閱讀 162,632評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長卓囚。 經(jīng)常有香客問我厌衔,道長,這世上最難降的妖魔是什么捍岳? 我笑而不...
    開封第一講書人閱讀 58,180評(píng)論 1 292
  • 正文 為了忘掉前任富寿,我火速辦了婚禮,結(jié)果婚禮上锣夹,老公的妹妹穿的比我還像新娘页徐。我一直安慰自己,他們只是感情好银萍,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,198評(píng)論 6 388
  • 文/花漫 我一把揭開白布变勇。 她就那樣靜靜地躺著,像睡著了一般搀绣。 火紅的嫁衣襯著肌膚如雪飞袋。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,165評(píng)論 1 299
  • 那天链患,我揣著相機(jī)與錄音巧鸭,去河邊找鬼。 笑死麻捻,一個(gè)胖子當(dāng)著我的面吹牛纲仍,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播贸毕,決...
    沈念sama閱讀 40,052評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼郑叠,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了明棍?” 一聲冷哼從身側(cè)響起乡革,我...
    開封第一講書人閱讀 38,910評(píng)論 0 274
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎摊腋,沒想到半個(gè)月后沸版,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,324評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡歌豺,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,542評(píng)論 2 332
  • 正文 我和宋清朗相戀三年推穷,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片类咧。...
    茶點(diǎn)故事閱讀 39,711評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡馒铃,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出痕惋,到底是詐尸還是另有隱情区宇,我是刑警寧澤,帶...
    沈念sama閱讀 35,424評(píng)論 5 343
  • 正文 年R本政府宣布值戳,位于F島的核電站议谷,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏堕虹。R本人自食惡果不足惜卧晓,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,017評(píng)論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望赴捞。 院中可真熱鬧逼裆,春花似錦、人聲如沸赦政。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至桐愉,卻和暖如春财破,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背从诲。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評(píng)論 1 269
  • 我被黑心中介騙來泰國打工左痢, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人盏求。 一個(gè)月前我還...
    沈念sama閱讀 47,722評(píng)論 2 368
  • 正文 我出身青樓抖锥,卻偏偏與公主長得像亿眠,于是被迫代替她去往敵國和親碎罚。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,611評(píng)論 2 353

推薦閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,075評(píng)論 25 707
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,804評(píng)論 6 342
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理纳像,服務(wù)發(fā)現(xiàn)荆烈,斷路器,智...
    卡卡羅2017閱讀 134,651評(píng)論 18 139
  • 感賞自己早起做了一碗嫩滑可口的雞蛋羹和其他飯菜竟趾,我還要繼續(xù)努力提高自己的廚藝水平憔购! 為了感謝曾經(jīng)幫助過...
    水靜我心閱讀 223評(píng)論 2 1
  • 這是一個(gè)無聊的簡書,只是為了嘗試發(fā)一個(gè)簡書
    尼克勞斯李閱讀 191評(píng)論 0 0