Android APT及基于APT的簡(jiǎn)單應(yīng)用

前言:隨著一些如ButterKnife狞换,dagger等的開(kāi)源注解框架的流行蒜绽,APT的概念也越來(lái)越被熟知歧胁。這篇文章將介紹APT的概念滋饲,以及我們?cè)趺蠢肁PT來(lái)自定義一個(gè)注解。

一喊巍,APT的介紹
  APT英文全稱(chēng):Android annotation process tool是一種處理注釋的工具屠缭,它對(duì)源代碼文件進(jìn)行檢測(cè)找出其中的Annotation,使用Annotation進(jìn)行額外的處理崭参。
  Annotation處理器在處理Annotation時(shí)可以根據(jù)源文件中的Annotation生成額外的源文件和其它的文件(文件具體內(nèi)容由Annotation處理器的編寫(xiě)者決定)呵曹,APT還會(huì)編譯生成源文件和原來(lái)的源文件,將它們一起生成class文件何暮。簡(jiǎn)言之:APT可以把注解奄喂,在編譯時(shí)生成代碼。
二海洼,APT的處理要素
  注解處理器(AbstractProcess)+代碼處理(javaPoet)+處理器注冊(cè)(AutoService)+apt
三跨新,使用APT來(lái)處理annotation的流程
  1.定義注解(如@automain)
  2.定義注解處理器
  3.在處理器里面完成處理方式,通常是生成java代碼坏逢。
  4.注冊(cè)處理器
  5.利用APT完成如下圖的工作內(nèi)容域帐。


APT流程.png

四,使用APT的簡(jiǎn)單項(xiàng)目
  1.新建項(xiàng)目APTProject
  2.在項(xiàng)目對(duì)應(yīng)的build.gradle文件中添加APT工具依賴(lài)词疼。位置如下所示:

dependencies {
    classpath 'com.android.tools.build:gradle:2.2.3'
    //添加APT依賴(lài)
    classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
 }

3.在對(duì)應(yīng)的module的build.gradle文件中添加下面的依賴(lài):

apply plugin: 'com.android.application'
//添加APT plugin
apply plugin: 'com.neenbedankt.android-apt'

4.創(chuàng)建java Library Module俯树,命名為apt-lib,并把這個(gè)module引入到app中贰盗。

apt-lib.png

編寫(xiě)如下的類(lèi):

@Target(ElementType.TYPE)  //作用在類(lèi)上
@Retention(RetentionPolicy.RUNTIME)//存活時(shí)間
public @interface AutoCreate {

}

5.再創(chuàng)建一個(gè)java Library Module,命名為apt-process阳欲,并把這個(gè)module引入到app中舵盈。

apt-process.png

  6.編寫(xiě)下面的類(lèi)來(lái)處理注解

package com.wjstudio;
import com.example.AutoCreat;
import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
/**
 * 注解處理器
 * 完成注解的處理
 * 1.處理哪個(gè)注解
 * 2.如何處理
 */
//注冊(cè)處理器陋率,告知APT,AutoCrate是由TestProcess處理@AutoService(Processor.class)public class TestProcess extends AbstractProcessor {
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        //定義需要處理的注解
        return Collections.singleton(AutoCreat.class.getCanonicalName());
    }

   @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        //如何處理該注解
        /*
         * hello.java
          public final class HelloWorld {
             public static void main(String[] args) {
            System.out.println("Hello, JavaPoet!"); 
           }
            }
         */
        //文件
        //文件內(nèi)容--java代碼生成工具javapoet
        //MethodSpec:定義方法
        //TypeSec:定義類(lèi)
        //JavaFile:生成.java文件
        MethodSpec main = MethodSpec.methodBuilder("main")
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                .returns(void.class)
                .addParameter(String[].class, "args")
                .addStatement("$T.out.println($S)",System.class, "Hello, JavaPoet!")
                .build();
        TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
                .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                .addMethod(main)
                .build();
       JavaFile javaFile = JavaFile.builder("com.songwenju.aptproject", helloWorld)
        .build();
       try {
            javaFile.writeTo(processingEnv.getFiler());
       } catch (IOException e) {
            e.printStackTrace();}
            return false;
     }
}

需要再改lib中引入

compile 'com.squareup:javapoet:1.8.0'
compile 'com.google.auto.service:auto-service:1.0-rc2'

這里為了方便解釋加了漢字秽晚,在AndroidStudio中編譯的時(shí)候不能加漢字瓦糟。
  7.在使用注解的地方添加依賴(lài)

compile project(':apt-process')
apt project(':apt-process')

8.使用生成的注解
  在app Module對(duì)應(yīng)的 MainActivity上加上注解,如下赴蝇,編譯之后可以看到生成的java類(lèi)菩浙。

@AutoCreatpublic
 class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

Rebuild之后,生成如下源代碼:

apt-result.png

  至此完成了Apt的介紹和簡(jiǎn)單的應(yīng)用句伶。
例子詳見(jiàn)https://github.com/songwenju/APTProject劲蜻,如果對(duì)您有幫助,歡迎star和fork考余。

版權(quán)聲明:本文為博主原創(chuàng)文章先嬉,轉(zhuǎn)載請(qǐng)注明出處。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末楚堤,一起剝皮案震驚了整個(gè)濱河市疫蔓,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌身冬,老刑警劉巖衅胀,帶你破解...
    沈念sama閱讀 216,402評(píng)論 6 499
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異酥筝,居然都是意外死亡拗小,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,377評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門(mén)樱哼,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)哀九,“玉大人,你說(shuō)我怎么就攤上這事搅幅≡氖” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 162,483評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵茄唐,是天一觀的道長(zhǎng)息裸。 經(jīng)常有香客問(wèn)我,道長(zhǎng)沪编,這世上最難降的妖魔是什么呼盆? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,165評(píng)論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮蚁廓,結(jié)果婚禮上访圃,老公的妹妹穿的比我還像新娘。我一直安慰自己相嵌,他們只是感情好腿时,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,176評(píng)論 6 388
  • 文/花漫 我一把揭開(kāi)白布况脆。 她就那樣靜靜地躺著,像睡著了一般批糟。 火紅的嫁衣襯著肌膚如雪格了。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,146評(píng)論 1 297
  • 那天徽鼎,我揣著相機(jī)與錄音盛末,去河邊找鬼。 笑死否淤,一個(gè)胖子當(dāng)著我的面吹牛悄但,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播叹括,決...
    沈念sama閱讀 40,032評(píng)論 3 417
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼算墨,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了汁雷?” 一聲冷哼從身側(cè)響起净嘀,我...
    開(kāi)封第一講書(shū)人閱讀 38,896評(píng)論 0 274
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎侠讯,沒(méi)想到半個(gè)月后挖藏,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,311評(píng)論 1 310
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡厢漩,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,536評(píng)論 2 332
  • 正文 我和宋清朗相戀三年膜眠,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片溜嗜。...
    茶點(diǎn)故事閱讀 39,696評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡宵膨,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出炸宵,到底是詐尸還是另有隱情辟躏,我是刑警寧澤,帶...
    沈念sama閱讀 35,413評(píng)論 5 343
  • 正文 年R本政府宣布土全,位于F島的核電站捎琐,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏裹匙。R本人自食惡果不足惜瑞凑,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,008評(píng)論 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望概页。 院中可真熱鬧籽御,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,659評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)徽曲。三九已至零截,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間秃臣,已是汗流浹背涧衙。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,815評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留奥此,地道東北人弧哎。 一個(gè)月前我還...
    沈念sama閱讀 47,698評(píng)論 2 368
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像稚虎,于是被迫代替她去往敵國(guó)和親撤嫩。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,592評(píng)論 2 353

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