手把手教你使用Android APT

Annotation(注解)

如果想學(xué)習(xí)APT(注解處理工具)骏令,那么就必須先了解Annotation的基礎(chǔ)蔬捷,對于不了解java注解基礎(chǔ)的朋友們,請先學(xué)習(xí)java注解榔袋,再看本文周拐。

APT

APT(Annotation Processing Tool)是一種處理注釋的工具,它對源代碼文件進(jìn)行檢測找出其中的Annotation,使用Annotation進(jìn)行額外的處理凰兑。

Annotation處理器在處理Annotation時(shí)可以根據(jù)源文件中的Annotation生成額外的源文件和其它的文件(文件具體內(nèi)容由Annotation處理器的編寫者決定),APT還會編譯生成的源文件和原來的源文件妥粟,將它們一起生成class文件。

創(chuàng)建Annotation Module

android studio 現(xiàn)在是最主流的安卓開發(fā)工具吏够,而且也是最好用的勾给,所有我這里講的是apt在studio上的使用教程滩报。

首先,我們需要新建一個(gè)Java Library,用來定義注解锦秒,所以庫名最好為annotation,見名知意喉镰。注意旅择,庫一定要為Java Library,因?yàn)閍ndroid Library不會引入javax.annotation等包侣姆,新建java Library 的方式如下圖:

image

此庫的build.gradle如下:

image

可根據(jù)自己的需求生真,修改jdk版本。

創(chuàng)建apt Module

創(chuàng)建一個(gè)名為apt的Java Library捺宗,見名知意柱蟀,此庫是用來編寫如何處理注解的代碼,同時(shí)通過注解自動生成代碼蚜厉。


配置build.gradle
apply plugin: 'java'
sourceCompatibility = 1.7
targetCompatibility = 1.7
dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.google.auto.service:auto-service:1.0-rc2'
    compile 'com.squareup:javapoet:1.7.0'
    compile project(':annotation')
}
  1. jdk同上庫

  2. AutoService 主要的作用是注解 processor 類长已,自動生成。

  3. JavaPoet 這個(gè)庫的主要作用就是幫助我們通過類調(diào)用的形式來生成代碼昼牛。

  4. 依賴上面創(chuàng)建的annotation Module术瓮。

    到這里所有的配置都完了,接下來編寫代碼贰健。

定義注解

  在annotation庫新建一個(gè)Test接口胞四,定義注解
     ```
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.CLASS) 
     public @interface Test {   }
         ```

定義Processor類

@AutoService(Processor.class)//自動生成 javax.annotation.processing.IProcessor 文件
@SupportedSourceVersion(SourceVersion.RELEASE_8)//java版本支持
@SupportedAnnotationTypes({"com.tuodao.annotation.Test"})//標(biāo)注注解處理器支持的注解類型,就是我們剛才定義的接口Test伶椿,可以寫入多個(gè)注解類型辜伟。
public class AnnotationProcessor extends AbstractProcessor {

   public Messager mMessager;
   public Elements mElements;
   public Filer mFiler;

   @Override
   public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
       mFiler = processingEnv.getFiler();//文件相關(guān)的輔助類
       mElements = processingEnv.getElementUtils();//元素相關(guān)的輔助類
       mMessager = processingEnv.getMessager();//日志相關(guān)的輔助類
     
      MethodSpec methodMain = MethodSpec.methodBuilder("main")//創(chuàng)建main方法
               .addModifiers(Modifier.PUBLIC, Modifier.STATIC)//定義修飾符為 public static
               .addJavadoc("@  此類由apt自動生成")//在生成的代碼前添加注釋
               .returns(void.class)//定義返回類型
               .addParameter(String[].class, "args")//定義方法參數(shù)
               .addStatement("$T.out.println($S)", System.class, "helloWorld")//定義方法體
               .build();
       TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")/創(chuàng)建HelloWorld類
               .addModifiers(Modifier.PUBLIC, Modifier.FINAL)//定義修飾符為 public final
               .addMethod(methodMain)//添加方法
               .addJavadoc("@  此方法由apt自動生成")//定義方法參數(shù)
               .build();
       JavaFile javaFile = JavaFile.builder("com.tuodao.apt", helloWorld).build();// 生成源   代碼
       try {
           javaFile.writeTo(mAbstractProcessor.mFiler);//// 在 app module/build/generated/source/apt 生成一份源代碼
       } catch (IOException e) {
           e.printStackTrace();
       }
       return true;
   }
}

在App中使用

   配置app的build.gradle
      

     dependencies {
             //..
             compile project(':annotation')
             annotationProcessor project(':apt')//核心,有了這個(gè)app才會處理apt的代碼
             }
 
     
           在隨意一個(gè)類添加@Test注解
         
                 @Test
                  public class MainActivity extends AppCompatActivity {
                       @Override
                       protected void onCreate(Bundle savedInstanceState) {
                                    super.onCreate(savedInstanceState);
                                    setContentView(R.layout.activity_main);
                          }
                     }
         
        
     然后編譯脊另,在app的build/generated/source/apt目錄下导狡,可看到生成的代碼

如下 :

                    /**
                     * @  此方法由apt自動生成 */
                         public final class HelloWorld {
                           /**
                           * @  此類由apt自動生成 */
                               public static void main(String[] args) {
                                    System.out.println("helloWorld");
                                }
                           }

至此,一個(gè)簡單的HelloWorld就完成了

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末偎痛,一起剝皮案震驚了整個(gè)濱河市烘豌,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌看彼,老刑警劉巖廊佩,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異靖榕,居然都是意外死亡标锄,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進(jìn)店門茁计,熙熙樓的掌柜王于貴愁眉苦臉地迎上來料皇,“玉大人谓松,你說我怎么就攤上這事〖粒” “怎么了鬼譬?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長逊脯。 經(jīng)常有香客問我优质,道長,這世上最難降的妖魔是什么军洼? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任巩螃,我火速辦了婚禮,結(jié)果婚禮上匕争,老公的妹妹穿的比我還像新娘避乏。我一直安慰自己,他們只是感情好甘桑,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布拍皮。 她就那樣靜靜地躺著,像睡著了一般跑杭。 火紅的嫁衣襯著肌膚如雪春缕。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天艘蹋,我揣著相機(jī)與錄音锄贼,去河邊找鬼。 笑死女阀,一個(gè)胖子當(dāng)著我的面吹牛宅荤,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播浸策,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼冯键,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了庸汗?” 一聲冷哼從身側(cè)響起惫确,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎蚯舱,沒想到半個(gè)月后改化,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡枉昏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年陈肛,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片兄裂。...
    茶點(diǎn)故事閱讀 39,932評論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡句旱,死狀恐怖阳藻,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情谈撒,我是刑警寧澤腥泥,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站啃匿,受9級特大地震影響蛔外,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜立宜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一冒萄、第九天 我趴在偏房一處隱蔽的房頂上張望臊岸。 院中可真熱鬧橙数,春花似錦、人聲如沸帅戒。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽逻住。三九已至钟哥,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間瞎访,已是汗流浹背腻贰。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留扒秸,地道東北人播演。 一個(gè)月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像伴奥,于是被迫代替她去往敵國和親写烤。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,884評論 2 354

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