一、前言

你還在對(duì)著枯燥的重復(fù)代碼一味復(fù)制粘貼嗎?這樣跟搬磚有何區(qū)別?你是否曾想過(guò)：你用代碼編寫出一個(gè)自動(dòng)化的APP，但為何代碼本身卻缺少了活力?掌握Android-apt，杜絕重復(fù)代碼，讓你寫代碼如寫詩(shī)般優(yōu)雅。

二、何為apt?

apt意為：annotation processing tool(注解處理工具)，這家伙可神奇了，它能通過(guò)注解，在編譯期自動(dòng)生成特定的Java文件，實(shí)現(xiàn)自動(dòng)編寫代碼。

問(wèn)：有什么用?憑我自己本事能寫出來(lái)的代碼，為什么要自動(dòng)化?

大哥，你這是又想施展你的復(fù)制粘貼大法了嗎?稍安勿躁，細(xì)看完這篇文章，你會(huì)愛(ài)上這家伙的。

鼎鼎大名的ButterKnife、Dagger2這兩個(gè)開源庫(kù)，相信你一定有聽(tīng)過(guò)，你應(yīng)該知道我為什么提到它們了吧。沒(méi)錯(cuò)!這兩個(gè)開源庫(kù)都是基于apt的。

三、說(shuō)了這么多，要怎么用啊?別急，我們先搭建環(huán)境(基于gradle插件2.2.0以上版本)

1.在android studio中新建一個(gè)Java module，用于存裝注解處理邏輯，名字隨便啦，反正我一般都取名：apt。很重要的事：在app module中添加注解處理依賴：annotationProcessor project(‘:apt’)

(解釋原因：由于android的module中不包含有apt相關(guān)類，因此需要新建一個(gè)java module來(lái)編寫apt邏輯。什么?你不信?不信你寫個(gè)類繼承AbstractProcessor試試)

2.再次新建一個(gè)module(android、java都可以)，用于存裝注解，名字也隨便，反正我這里取名為：anno，并且在app、apt的build.gradle文件下，添加依賴compile project(‘:anno’)

(為什么要新建module去盛裝注解類，而不放到app module或者apt module中去：最主要的原因就是app module與apt module不能直接相互依賴，至于為什么不能直接依賴，我就不細(xì)說(shuō)了，總之一句話：不信你試試看就知道嘍!)

3.在apt的build.gradle里，添加如下依賴。到此，我們的環(huán)境配置工作就告一段落了。

(其中：1.auto-service是用于注解后自動(dòng)在特定路徑下生成配置文件;2.javapoet是用于配合apt便捷生成java文件的工具。相信這樣解釋大家還云里霧里，不要著急，繼續(xù)往下看)

四、環(huán)境搭建好了，接下來(lái)就是秀操作時(shí)間

1.首先，在anno module里新建一個(gè)注解類

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

2.在apt module里新建一個(gè)注解處理類，繼承于AbstractProcessor

public class TestProcessor extends AbstractProcessor{ 
    @Override 
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { 
        return false; 
    } 
}  

3.既然說(shuō)apt是要自動(dòng)生成java文件，那我們就需要擬構(gòu)出一個(gè)目標(biāo)類。假設(shè)我們要生成這樣一個(gè)類

public class TestClass { 
 
    public static void main(String[] args){ 
        System.out.println("Hallo world!"); 
    } 
 
}  

4.操作注解處理類，生成目標(biāo)java文件

@AutoService(Processor.class) 
@SupportedAnnotationTypes({ 
        "com.aop.anno.Test" 
}) 
public class TestProcessor extends AbstractProcessor{ 
 
    @Override 
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) { 
 
        //生成TestClass類 
        TypeSpec.Builder tb = TypeSpec.classBuilder("TestClass") 
                .addModifiers(Modifier.PUBLIC); 
 
        //生成main方法 
        MethodSpec.Builder mb = MethodSpec.methodBuilder("main") 
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC) 
                .returns(void.class) 
                .addParameter(String[].class, "args"); 
 
        //生成代碼塊，并添加到main方法中 
        for(TypeElement e : ElementFilter.typesIn(roundEnv.getElementsAnnotatedWith(Test.class))){ 
            CodeBlock cb = CodeBlock.builder() 
                    .addStatement("$T.out.println(\"$L + $L\")", System.class,  
                    e.getAnnotation(Test.class).value(), e.getSimpleName()) 
                    .build(); 
            mb.addCode(cb); 
        } 
 
        tb.addMethod(mb.build()); 
 
        JavaFile jf = JavaFile.builder("com.example.apt", tb.build()).build(); 
        //將代碼寫入java文件中 
        try { 
            jf.writeTo(processingEnv.getFiler()); 
        } catch (IOException e) { 
            e.printStackTrace(); 
        } 
 
        return true; 
    } 
}  

大致說(shuō)下步驟：

(1)添加@AutoService(Processor.class)注解，這個(gè)注解會(huì)自動(dòng)在指定路徑下生成一個(gè)配置文件：

apt/build/classes/main/META-INF/services/javax.annotation.processing.Processor;

(2)添加@SupportedAnnotationTypes注解，配置這個(gè)類所要處理的注解類型。(傳入String類型參數(shù)，格式為：包名+類名);

(3)采用javapoet書寫代碼構(gòu)建邏輯，具體用法去這里看看;

(4)生成代碼塊的主要邏輯是：遍歷所有被@Test注解過(guò)的類，取出注解內(nèi)容及類名打印出來(lái)。

5.在類上添加@Test注解，這里就用MainActivity來(lái)試試

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

6.rebuild工程，在app/build/generated/source/apt/debug路徑下找到目標(biāo)java文件。至此，大功告成   

TestClass代碼如下：

public class TestClass { 
  public static void main(String[] args) { 
    System.out.println("abc + MainActivity"); 
  } 
}  

五、然而并沒(méi)什么卵用?

確實(shí)，到此為止，我們確實(shí)是用了幾十行代碼去生成了一個(gè)5行代碼的TestClass，這種操作來(lái)說(shuō)看起來(lái)可以用4個(gè)字來(lái)形容：閑得蛋疼。

然而，接下來(lái)的操作，會(huì)讓你耳目一新。首先我們新建幾個(gè)測(cè)試類，假如我們新建了這樣4個(gè)測(cè)試類：ActivityA,ActivityB,ActivityC,ActivityD，并且都給他們加上注解@Test。然后rebuild一下，你會(huì)發(fā)現(xiàn)，我們的TestClass變了樣：

public class TestClass { 
  public static void main(String[] args) { 
    System.out.println("A + ActivityA"); 
    System.out.println("B + ActivityB"); 
    System.out.println("C + ActivityC"); 
    System.out.println("D + ActivityD"); 
    System.out.println("abc + MainActivity"); 
  } 
} 

恍然大悟!原來(lái)，是這么玩的!這時(shí)候，你是否已經(jīng)感覺(jué)到apt的魅力了呢?是的，它能幫你干掉重復(fù)代碼，讓你杜絕掉復(fù)制粘貼。