android APT 切換 annotationProcessor使用

Android Gradle插件2.2版本發(fā)布后,Android 官方提供了annotationProcessor來(lái)代替android-apt筐赔,annotationProcessor同時(shí)支持 javac 和 jack 編譯方式铣猩,而android-apt只支持 javac 方式。同時(shí)android-apt作者宣布不在維護(hù)茴丰,當(dāng)然目前android-apt仍然可以正常運(yùn)行达皿,如果你沒有想支持 jack 編譯方式的話,可以繼續(xù)使用android-apt贿肩。
android-apt切換annotationProcessor步驟
1.Android Gradle 插件版本升級(jí)到 2.2 及以上
當(dāng)前Android Studio已經(jīng)升級(jí)到2.2版本

repositories {
jcenter()
}
dependencies {
classpath'com.android.tools.build:gradle:2.2.2'
classpath'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.7'
classpath'com.github.dcendents:android-maven-gradle-plugin:1.5'
classpath'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:1.0.10'
}
}```
2.刪除build.gradle文件中android-apt的相關(guān)配置

buildscript{repositories{ jcenter() }dependencies{classpath'com.neenbedankt.gradle.plugins:android-apt:1.8'} } apply plugin:'com.neenbedankt.android-apt'

3.改成新的依賴峦椰,build.gradle文件中使用android-apt引入的依賴修改為使用annotationProcessor,修改前配置如下:

dependencies{compile'com.google.dagger:dagger:2.0'apt'com.google.dagger:dagger-compiler:2.0'}

修改后配置如下:

dependencies{compile'com.google.dagger:dagger:2.0'annotationProcessor'com.google.dagger:dagger-compiler:2.0'}

配置完成后annotationProcessor的使用:
1.自定義注解
public @interface 注解名{注解體}汰规。注解體中注解元素可以被public修飾汤功,也可以什么也不寫,元素類型可以是:
所有基本數(shù)據(jù)類型(int,float,boolean等)
String類型
Class類型
enum類型
Annotation類型(說明注解可以嵌套)
以上所有類型的數(shù)組
沒有元素的標(biāo)記注解

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.CLASS)
public@interfaceRequestCode{
}

單值注解:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.CLASS)
public @interface Uri {
String value();
}

2.使用注解:

@Uri("gank://androidwing.net/about/")
voidstartAbout();

3.自定義注解處理類庫(kù):
如果沒有用來(lái)讀取注解的工具溜哮,那注解也不會(huì)比注釋更有用滔金。使用注解的過程中很重要的一個(gè)部分就是創(chuàng)建與使用注解處理器:

public final class ServiceElement {
ClassName serviceClassName;
String packageName;
ClassName providerClassName;
List enclosedElements;
Element element;
public ServiceElement(Element serviceElement) {
element = serviceElement;
//獲取類名
String className = serviceElement.getSimpleName().toString();
//獲取包
PackageElement packageElement = (PackageElement) serviceElement.getEnclosingElement();
packageName = packageElement.getQualifiedName().toString();
serviceClassName = ClassName.get(packageName, className);
enclosedElements = serviceElement.getEnclosedElements();
String serviceProviderName = className +"$$Provider";
providerClassName = ClassName.get(packageName, serviceProviderName);
}
public String getPackageName() {
return packageName;
}
public ClassName getProviderClassName() {
return providerClassName;
}
public ClassName getClassName() {
return serviceClassName;
}
public List getEnclosedElements() {
return enclosedElements;
}
public Element getElement() {
return element;
}
}

該類用來(lái)儲(chǔ)存注解類的信息,包括類茂嗓,構(gòu)造方法餐茵,成員變量,方法等
接下來(lái)就是注解生成類(注解處理器):

@Override
public booleanprocess(Set annotations, RoundEnvironment roundEnv) {
//數(shù)據(jù)處理
List addressElements = generateAddressElements(roundEnv);
//非空判斷
if(ElementUtils.isEmpty(addressElements)) {
return false;
}
Map> serviceElements = findServiceElements(addressElements);
if(ElementUtils.isEmpty(serviceElements)) {
return false;
}
for(Map.Entry> serviceElementEntrySet : serviceElements.entrySet()) {
TypeElement serviceElement = serviceElementEntrySet.getKey();
ListserviceAddressElements= serviceElementEntrySet.getValue();
if(ElementUtils.isEmpty(serviceAddressElements)) {
break;
}
try{
//處理生成類
generateDeepLinkService(serviceElement,serviceAddressElements);
}catch(IOException e) {
logger.error("Error creating matcher file", serviceElement);
}
}
return true;
}
數(shù)據(jù)處理方法:
generateAddressElements(roundEnv)
privateList generateAddressElements(RoundEnvironment roundEnv) {
List annotationElements =newArrayList<>();
//注解類型數(shù)據(jù)處理
for(String annotationType : getSupportedAnnotationTypes()) {
TypeElement typeElement =processingEnv.getElementUtils().getTypeElement(annotationType);
Set annotatedElements = roundEnv.getElementsAnnotatedWith(typeElement);
for(Element annotatedElement : annotatedElements) {
if(!annotationElements.contains(annotatedElement)) {
annotationElements.add(annotatedElement);
}
}
}
List serviceElements =newArrayList<>();
for(Element element : annotationElements) {
ElementKind kind = element.getKind();
if(kind != ElementKind.METHOD) {
logger.error("Only classes and methods can be with "+ getSupportedAnnotationTypes(), element);
}
if(!isSupportReturnType((ExecutableElement) element)) {
logger.error("method only support return type is "+SUPPORT_RETURN_TYPE.toString(), element);
}
Element enclosingElement = element.getEnclosingElement();
String name = enclosingElement.getSimpleName().toString();
if(!name.endsWith("Service")) {
logger.error(name +"this class must be in end with Service", enclosingElement);
}
if(enclosingElement.getKind() != ElementKind.INTERFACE) {
logger.error(name +"this class must be interface", enclosingElement);
}
serviceElements.add(newAddressElement(element));
}
returnserviceElements;
}

數(shù)據(jù)處理好之后就是代碼生成:

private voidgenerateDeepLinkService(TypeElement serviceElements,
List deepLinkMatchElements)
throwsIOException {
ClassName providerClassName = getServiceProviderClassName(serviceElements);
MethodSpec initMethod = generateInitMethod(deepLinkMatchElements);
//成員變量
FieldSpec activity = FieldSpec
.builder(DEEP_LINK_CLIENT,"deepLinkClient",
Modifier.PUBLIC)
.build();
//構(gòu)造器定義
MethodSpec activityConstructor = MethodSpec.constructorBuilder()
.addModifiers(Modifier.PUBLIC)
.addParameter(DEEP_LINK_CLIENT,"deepLinkClient")
.addCode("this.deepLinkClient= deepLinkClient;\n")
.build();
//類定義
TypeSpec.Builder serviceProviderBuilder = TypeSpec.classBuilder(providerClassName)
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addAnnotation(AnnotationSpec.builder(Aspect.class).build())
.addSuperinterface(ClassName.get(serviceElements))
.addField(activity)
.addMethod(activityConstructor)
.addMethod(initMethod);
//函數(shù)定義
for(AddressElement matchElement : deepLinkMatchElements) {
ExecutableElement element = (ExecutableElement) matchElement.getElement();
serviceProviderBuilder.addMethod(geneOverServiceMethod(element));
}
//構(gòu)造注冊(cè)
MethodSpec buildMethodSpec = generateBuildMethod(serviceElements);
serviceProviderBuilder.addMethod(buildMethodSpec);
//完成APT類的注解生成
JavaFile.builder(ClassName.get(serviceElements).packageName(), serviceProviderBuilder.build())
.build()
.writeTo(filer);
}

最后得到生成的類:

@Aspect
public final classSampleService$$ProviderimplementsSampleService {
publicDeepLinkClient deepLinkClient;
publicSampleService$$Provider(DeepLinkClient deepLinkClient) {
this.deepLinkClient = deepLinkClient;
}
public voidstartSecondActivity(String value1,intvalue2) {
Intent intent =newIntent();
intent.putExtra("key1", value1);
intent.putExtra("key2", value2);
intent.setData(Uri.parse("app://deeplink/second"));
Request request =this.deepLinkClient.buildRequest(intent);
if(request !=null) {
request.start();
}
}
}

總結(jié):使用注解標(biāo)簽是非常方便一勞永逸述吸,尤其是做些重復(fù)性且類似的處理忿族,比如使用ButterKnife就不用重復(fù)寫太多的控件find,雖然注解處理器處理起來(lái)比較麻煩蝌矛,但想想接下來(lái)一大堆蛋疼的重復(fù)代碼道批,所以還是值得一試。
本文借用了sunshine8大神的android組件化-路由器OkDeepLink代碼入撒。從中抽取了其中注解標(biāo)簽使用部分隆豹。
**參考文獻(xiàn):**
****
**[http://www.reibang.com/p/8a3eeeaf01e8](http://www.reibang.com/p/8a3eeeaf01e8)Android 組件化 —— 路由設(shè)計(jì)最佳實(shí)踐**
[http://www.reibang.com/p/c1666a947692](http://www.reibang.com/p/c1666a947692)android-apt切換為官方annotationProcessor
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市衅金,隨后出現(xiàn)的幾起案子噪伊,更是在濱河造成了極大的恐慌,老刑警劉巖氮唯,帶你破解...
    沈念sama閱讀 218,122評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異姨伟,居然都是意外死亡惩琉,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,070評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門夺荒,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)瞒渠,“玉大人良蒸,你說我怎么就攤上這事∥榫粒” “怎么了嫩痰?”我有些...
    開封第一講書人閱讀 164,491評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)窍箍。 經(jīng)常有香客問我串纺,道長(zhǎng),這世上最難降的妖魔是什么椰棘? 我笑而不...
    開封第一講書人閱讀 58,636評(píng)論 1 293
  • 正文 為了忘掉前任纺棺,我火速辦了婚禮,結(jié)果婚禮上邪狞,老公的妹妹穿的比我還像新娘祷蝌。我一直安慰自己,他們只是感情好帆卓,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,676評(píng)論 6 392
  • 文/花漫 我一把揭開白布巨朦。 她就那樣靜靜地躺著,像睡著了一般剑令。 火紅的嫁衣襯著肌膚如雪罪郊。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,541評(píng)論 1 305
  • 那天尚洽,我揣著相機(jī)與錄音悔橄,去河邊找鬼。 笑死腺毫,一個(gè)胖子當(dāng)著我的面吹牛癣疟,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播潮酒,決...
    沈念sama閱讀 40,292評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼睛挚,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了急黎?” 一聲冷哼從身側(cè)響起扎狱,我...
    開封第一講書人閱讀 39,211評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎勃教,沒想到半個(gè)月后淤击,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,655評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡故源,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,846評(píng)論 3 336
  • 正文 我和宋清朗相戀三年污抬,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了酗宋。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片挚瘟。...
    茶點(diǎn)故事閱讀 39,965評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡彰导,死狀恐怖鞭衩,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情射赛,我是刑警寧澤多柑,帶...
    沈念sama閱讀 35,684評(píng)論 5 347
  • 正文 年R本政府宣布,位于F島的核電站楣责,受9級(jí)特大地震影響竣灌,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜腐魂,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,295評(píng)論 3 329
  • 文/蒙蒙 一帐偎、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧蛔屹,春花似錦削樊、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,894評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至育叁,卻和暖如春迅脐,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背豪嗽。 一陣腳步聲響...
    開封第一講書人閱讀 33,012評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工谴蔑, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人龟梦。 一個(gè)月前我還...
    沈念sama閱讀 48,126評(píng)論 3 370
  • 正文 我出身青樓隐锭,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親计贰。 傳聞我的和親對(duì)象是個(gè)殘疾皇子钦睡,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,914評(píng)論 2 355

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

  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,133評(píng)論 25 707
  • 框架:提供一定能力的小段程序 http://www.cnblogs.com/jincheng-yangchaofa...
    姑娘請(qǐng)別為難小僧閱讀 7,231評(píng)論 0 132
  • 一.榜單介紹 排行榜包括四大類: 單一框架:僅提供路由躁倒、網(wǎng)絡(luò)層荞怒、UI層、通信層或其他單一功能的框架 混合開發(fā)框架:...
    偉子男閱讀 5,243評(píng)論 0 161
  • 心靈雞湯類作品不知道什么時(shí)候鋪天蓋地的包裹了暢銷榜秧秉,今與友一起逛書店褐桌,她對(duì)這些書名浮夸沒有深度的書目嗤之以鼻,我卻...
    念冬1314閱讀 434評(píng)論 0 1
  • 思緒浮在大海里 記憶似海里的魚 放浪無(wú)所依 海浪襲來(lái) 撲騰著 妄想抓住一個(gè)漸行漸遠(yuǎn)的你 我的手沒有力氣 我有深焊U辏恐...
    莫笑yh閱讀 269評(píng)論 0 0