Annotations 1

Annotations Processing

概念

Annotation processing-javac在編譯時掃描铃在、處理Annotation的工具。對于特定的注解可以注冊對應(yīng)的annotation processor。

特定注解的注解處理器以java code作為輸入.java文件作為輸出。可以理解成在編譯時生成想要的.java文件绝淡,生成的.java文件和其他手寫的.java文件一樣會被javac編譯。

NOTE:僅僅是生成苍姜,注解處理器并不能修改已經(jīng)存在的對象牢酵,比如增加一個方法

AbstractProcessor

自定義Processor需要繼承java內(nèi)置的AbstractProcessor,比較重要的幾個方法如下

package com.wsl;
public class MyProcessor extends AbstractProcessor {
    @Override
    public synchronized void init(ProcessingEnvironment env){ }
    @Override
    public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }
    @Override
    public Set<String> getSupportedAnnotationTypes() { }
    @Override
    public SourceVersion getSupportedSourceVersion() { }
}
  • init(ProcessingEnvironment env): 每個annotation processor class必須有一個空構(gòu)造函數(shù)。init()方法被注解處理器調(diào)用衙猪,ProcessingEnvironment 參數(shù)提供了一些很有用的工具類馍乙,比如Elements、Types和Filer垫释,稍后會用到丝格。
  • process(Set<? extends TypeElement> annotations, RoundEnvironment env):每個注解處理器最主要的方法,生成java文件的邏輯就是在這里完成的棵譬。RoundEnvironment 參數(shù)可以查詢被注解過的元素显蝌。
  • getSupportedAnnotationTypes(): 注解處理器注冊對應(yīng)的Annotations
  • getSupportedSourceVersion(): 指定java version,一般情況下 return SourceVersion.latestSupported()即可,或者也可以return其他版本,比如SourceVersion.RELEASE_6.

如果java7以上版本可以用@SupportedSourceVersion订咸、@SupportedAnnotationTypes代替getSupportedAnnotationTypes() 和 getSupportedSourceVersion()

@SupportedSourceVersion(SourceVersion.latestSupported())
@SupportedAnnotationTypes({
   // Set of full qullified annotation type names
 })
public class MyProcessor extends AbstractProcessor {
    @Override
    public synchronized void init(ProcessingEnvironment env){ }
    @Override
    public boolean process(Set<? extends TypeElement> annoations, RoundEnvironment env) { }
}

NOTE: 考慮到編譯的兼容性問題(特別是Android)曼尊,推薦重載getSupportedAnnotationTypes() 和 getSupportedSourceVersion()

Annotation Processor運(yùn)行在自己的jvm里,javac會開啟一個jvm來運(yùn)行注解處理器脏嚷,這就意味著可以添加一些第三方依賴庫骆撇,比如guava

Register Processor

需要提供一個jar,jar包括MyProcessor和javax.annotation.processing.Processor,如下:

MyProcessor.jar
- com
- example
- MyProcessor.class
- META-INF
- services
- javax.annotation.processing.Processor

javax.annotation.processing.Processor的作用是告訴javac用到了哪些Processor父叙,如下

com.example.MyProcessor
com.foo.OtherProcessor
net.blabla.SpecialProcessor

可把MyProcessor.jar當(dāng)作第三方Library來使用即可

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末神郊,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子高每,更是在濱河造成了極大的恐慌屿岂,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,110評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鲸匿,死亡現(xiàn)場離奇詭異爷怀,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)带欢,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,443評論 3 395
  • 文/潘曉璐 我一進(jìn)店門运授,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人乔煞,你說我怎么就攤上這事吁朦。” “怎么了渡贾?”我有些...
    開封第一講書人閱讀 165,474評論 0 356
  • 文/不壞的土叔 我叫張陵逗宜,是天一觀的道長。 經(jīng)常有香客問我,道長纺讲,這世上最難降的妖魔是什么擂仍? 我笑而不...
    開封第一講書人閱讀 58,881評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮熬甚,結(jié)果婚禮上逢渔,老公的妹妹穿的比我還像新娘。我一直安慰自己乡括,他們只是感情好肃廓,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,902評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著诲泌,像睡著了一般盲赊。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上档礁,一...
    開封第一講書人閱讀 51,698評論 1 305
  • 那天角钩,我揣著相機(jī)與錄音,去河邊找鬼呻澜。 笑死递礼,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的羹幸。 我是一名探鬼主播脊髓,決...
    沈念sama閱讀 40,418評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼栅受!你這毒婦竟也來了将硝?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,332評論 0 276
  • 序言:老撾萬榮一對情侶失蹤屏镊,失蹤者是張志新(化名)和其女友劉穎依疼,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體而芥,經(jīng)...
    沈念sama閱讀 45,796評論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡律罢,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,968評論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了棍丐。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片误辑。...
    茶點(diǎn)故事閱讀 40,110評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖歌逢,靈堂內(nèi)的尸體忽然破棺而出巾钉,到底是詐尸還是另有隱情,我是刑警寧澤秘案,帶...
    沈念sama閱讀 35,792評論 5 346
  • 正文 年R本政府宣布砰苍,位于F島的核電站潦匈,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏赚导。R本人自食惡果不足惜历等,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,455評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望辟癌。 院中可真熱鬧,春花似錦荐捻、人聲如沸黍少。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,003評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽厂置。三九已至,卻和暖如春魂角,著一層夾襖步出監(jiān)牢的瞬間昵济,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,130評論 1 272
  • 我被黑心中介騙來泰國打工野揪, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留访忿,地道東北人。 一個月前我還...
    沈念sama閱讀 48,348評論 3 373
  • 正文 我出身青樓斯稳,卻偏偏與公主長得像海铆,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子挣惰,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,047評論 2 355

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