Android-apt

android-apt是什么?

原文 https://bitbucket.org/hvisser/android-apt

android-apt 是一個Gradle插件,協(xié)助Android Studio 處理annotation processors, 它有兩個目的:

1.允許配置只在編譯時作為注解處理器的依賴,而不添加到最后的APK或library
2.設(shè)置源路徑,使注解處理器生成的代碼能被Android Studio正確的引用此插件依賴項目中配置android或android-library(version 0.9.x or up),

添加android-apt到構(gòu)建腳本中
使用該插件,添加如下到你的構(gòu)建腳本中:

//配置在Project下的build.gradle中
buildscript {
    repositories {
      mavenCentral()
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:+'
        //替換成最新android-apt版本
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
    }
}
//配置到Module下的build.gradle中
apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt'

傳遞處理器參數(shù)
有些注解處理器需要傳遞參數(shù),你能通過使用apt.arguments達到此目的,如下是一個向AndroidAnnotations傳遞參數(shù)的例子

apt {
    arguments {
            resourcePackageName android.defaultConfig.applicationId
            androidManifestFile variant.outputs[0]?.processResources?.manifestFile
    }
}

AndroidAnnotations 需要知道AndroidManifest.xml文件所在的位置,檢索variant獲取不同flavor的AndroidManifest.xml文件。然而并非所有變量都有這個屬性(例如,單元測試就沒有),因此使用groovy操作符?.區(qū)分不能屬性的不同的情況。
取參數(shù)以也通過以下定義一個函數(shù),相關(guān)Groovy語法不翻譯(暫時會Groovy)一看就明白。

def getManifestByVariant(variant) {
    // return the value based on the variant
    if (variant.name == 'release') {
        return '/my/path/to/the/manifest.xml'
    }
    return variant.outputs[0]?.processResources?.manifestFile
}

apt {
     arguments {
         if (variant.name == 'debug') {
            resourcePackageName "com.myapp.package.name.debug"
            // more options
         }             
         androidManifestFile project.getManifestByVariant(variant)             
     }
}

配置不同編譯風(fēng)格的依賴
注解處理器一般包含API和使用API生成代碼的processor。項目依賴可能分為多個部分。例如Dagger有兩個組件Dagger-compiler和dagger。dagger-commpiler僅用于編譯時,運行時必需使用dagger。配置此類組件,apt能這樣使用

dependencies {
 apt 'com.squareup.dagger:dagger-compiler:1.1.0'
 compile 'com.squareup.dagger:dagger:1.1.0'
}

如果是instrumentation test并需要在Android Studio 中顯示processor生成的代碼,使用androidTestApt

dependencies {
 androidTestApt 'com.github.frankiesardo:android-auto-value-processor:0.1'
 androidTestCompile 'com.github.frankiesardo:android-auto-value:0.1'
}

配置 unit test 使用 testApt (注:要求Android Studio 是1.4以上版本)

dependencies {
 testApt 'com.github.frankiesardo:android-auto-value-processor:0.1'
 testCompile 'com.github.frankiesardo:android-auto-value:0.1'
}

其它配置
它可以指定編譯時處理器的類名,并禁用javac默認(rèn)的發(fā)現(xiàn)機制,需要配置這些類到apt塊中:

apt {
    processor "my.class.name"
    processor "another.processor.class.name"
    // 僅運行上面的聲名的處理器類
    disableDiscovery true
}

配置其它注解處理器
添加其它注解器不需要額外的配置,你只需要使用apt添加相關(guān)組件到compile模塊中。另外,處理器所有生成資源都在代碼正常引用。

FAQ
Q:什么時候需要這個插件?
A:當(dāng)你需要引入Processors 生成的源代碼到你的代碼中時。例如,當(dāng)你使用Dagger 2 或 AndroidAnnotaition.該插件使得Android Studio可以配置生成資源的build path,避免IDE報錯。當(dāng)使用 apt添加添加依賴,它將不會被包含到最終的APK里。

Q:provided vs apt 使用注解處理器的不同?
A:provided 將會導(dǎo)入注解處理器的classes和它的依賴到IDE的類路徑下。這意味著你可以附帶的引入并使用這些classes。例如,當(dāng)注解處理器使用Guava,你可能錯誤的import其相關(guān)代碼到你的Android 代碼中。當(dāng)運行時將導(dǎo)致crash。而使用apt,注解處理器的classes將不會添加到你當(dāng)前的類路徑下,僅僅用于注解處理過程。并且會把所有注解處理器生成的source放在IDE的類路徑下,方便Android Studio引用。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,606評論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,582評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,540評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,028評論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 71,801評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,223評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,294評論 3 442
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,442評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,976評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 40,800評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,996評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,543評論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,233評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,926評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,702評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 47,991評論 2 374

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