如何自定義注解處理器

簡介

注解處理器(Annotation Processor)是javac的一個工具漾橙,不管是運(yùn)行時注解還是編譯時注解边锁,都會通過處理器在編譯時進(jìn)行掃描和處理注解。

自定義處理器

1、在Androidstudio中創(chuàng)建一個Java Library Module(注解處理器需要javax包的支持,Android環(huán)境下是訪問不到j(luò)avax包的,同時注解處理器要被打包進(jìn)jar包里面才能被系統(tǒng)識別渺杉,這就是選用ava Library的原因,目前注解注解框架均是如此挪钓。)

2是越、定義一個注解


image.png

3、 繼承虛處理器AbstractProcessor


image.png
  • init(ProcessingEnvironment processingEnvironment):
    每一個注解處理器類都必須有一個空的構(gòu)造函數(shù)诵原。然而英妓,這里有一個特殊的init()方法挽放,它會被注解處理工具調(diào)用绍赛,并輸入ProcessingEnviroment參數(shù)蔓纠。ProcessingEnviroment提供很多有用的工具類Elements, Types和Filer。后面我們將看到詳細(xì)的內(nèi)容吗蚌。
  • process(Set<? extends TypeElement> annotations, RoundEnvironment env):
    這相當(dāng)于每個處理器的主函數(shù)main()腿倚。掃描、評估和處理注解的代碼蚯妇,以及生成Java文件敷燎。輸入?yún)?shù)RoundEnviroment,可以讓你查詢出包含特定注解的被注解元素箩言。后面我們將看到詳細(xì)的內(nèi)容硬贯。
  • getSupportedAnnotationTypes():
    這里你必須指定,這個注解處理器是注冊給哪個注解的陨收。注意饭豹,它的返回值是一個字符串的集合,包含本處理器想要處理的注解類型的合法全稱务漩。換句話說拄衰,你在這里定義你的注解處理器注冊到哪些注解上。
  • getSupportedSourceVersion():
    用來指定你使用的Java版本饵骨。通常這里返回SourceVersion.latestSupported()翘悉。然而,如果你有足夠的理由只支持Java 6的話居触,你也可以返回SourceVersion.RELEASE_6妖混。我推薦你使用前者。
image.png

上圖為在process方法中使用javapoet自動生成java類

4轮洋、注冊處理器

  • 注冊方式一:手動注冊
    在使用注解處理器需要先聲明制市,步驟:
    • 需要在 processors 庫的 main 目錄下新建 resources 資源文件夾;
    • 在 resources文件夾下建立 META-INF/services 目錄文件


      image.png

在文件java.lang.Process中增加注冊器路徑名:
com.lsm.processor.JsonProcessor

  • 方式二:自動注冊
    google提供了一個注冊處理器的庫AutoService砖瞧。幫助將要編譯的處理器進(jìn)行編譯息堂。
    compile ‘com.google.auto.service:auto-service:1.0-rc4’


    image.png

    image.png

至此自定義注解處理器完成。

5块促、使用自定義注解處理器
將processor編譯出的jar包拷貝到項目中


image.png
image.png

在工程的build.gradle中增加使用的處理器:


image.png
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末荣堰,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子竭翠,更是在濱河造成了極大的恐慌振坚,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,427評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件斋扰,死亡現(xiàn)場離奇詭異渡八,居然都是意外死亡啃洋,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,551評論 3 395
  • 文/潘曉璐 我一進(jìn)店門屎鳍,熙熙樓的掌柜王于貴愁眉苦臉地迎上來宏娄,“玉大人,你說我怎么就攤上這事逮壁》跫幔” “怎么了?”我有些...
    開封第一講書人閱讀 165,747評論 0 356
  • 文/不壞的土叔 我叫張陵窥淆,是天一觀的道長卖宠。 經(jīng)常有香客問我,道長忧饭,這世上最難降的妖魔是什么扛伍? 我笑而不...
    開封第一講書人閱讀 58,939評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮词裤,結(jié)果婚禮上刺洒,老公的妹妹穿的比我還像新娘。我一直安慰自己亚斋,他們只是感情好作媚,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,955評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著帅刊,像睡著了一般纸泡。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上赖瞒,一...
    開封第一講書人閱讀 51,737評論 1 305
  • 那天女揭,我揣著相機(jī)與錄音,去河邊找鬼栏饮。 笑死吧兔,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的袍嬉。 我是一名探鬼主播境蔼,決...
    沈念sama閱讀 40,448評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼伺通!你這毒婦竟也來了箍土?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,352評論 0 276
  • 序言:老撾萬榮一對情侶失蹤罐监,失蹤者是張志新(化名)和其女友劉穎吴藻,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體弓柱,經(jīng)...
    沈念sama閱讀 45,834評論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡沟堡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,992評論 3 338
  • 正文 我和宋清朗相戀三年侧但,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片航罗。...
    茶點(diǎn)故事閱讀 40,133評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡禀横,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出伤哺,到底是詐尸還是另有隱情燕侠,我是刑警寧澤者祖,帶...
    沈念sama閱讀 35,815評論 5 346
  • 正文 年R本政府宣布立莉,位于F島的核電站,受9級特大地震影響七问,放射性物質(zhì)發(fā)生泄漏蜓耻。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,477評論 3 331
  • 文/蒙蒙 一械巡、第九天 我趴在偏房一處隱蔽的房頂上張望刹淌。 院中可真熱鬧,春花似錦讥耗、人聲如沸有勾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,022評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽蔼卡。三九已至,卻和暖如春挣磨,著一層夾襖步出監(jiān)牢的瞬間雇逞,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,147評論 1 272
  • 我被黑心中介騙來泰國打工茁裙, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留塘砸,地道東北人。 一個月前我還...
    沈念sama閱讀 48,398評論 3 373
  • 正文 我出身青樓晤锥,卻偏偏與公主長得像掉蔬,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子矾瘾,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,077評論 2 355

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