今天學(xué)習(xí)十分鐘——Annotation Processor Tools入門

大家好毅否,我是走川。只有十分鐘蝇刀,沒時(shí)間廢話了螟加!我要發(fā)車了!!@μ健甸昏!

所有Android開發(fā)一定都了解或使用過 Butterknife、Dragger等編譯期生成代碼的框架徐许,今天的學(xué)習(xí)就是入門 Annotation Processor Tools(注解處理工具)施蜜,在簡(jiǎn)單的學(xué)習(xí)之后,你能有以下收獲

1. 學(xué)習(xí)代碼輔助生成的方式
2. 成功通過APT生成以下代碼

public class MainActivity_SayHi{
 public void sayHi(String content){
   System.out.println(content);
 }
}

好了雌隅,在開始之前翻默,我們先準(zhǔn)備好原材料:新建一個(gè)Android工程 (′?ω?`)

工程目錄

0x1

新建一個(gè) Java Module,并讓app工程依賴于這個(gè)lib

新建Java Module
修改依賴

0x2 在這個(gè)lib庫中新增一個(gè)自定義注解

@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface SayHi {
}

0x3 在app工程中MainActivity增加SayHi注解


@SayHi
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

0x4 在這個(gè)lib庫中新增一個(gè)自定義 注解處理器

注解處理器在使用前需要先向JVM注冊(cè),在module的META-INF目錄下新建services目錄恰起,并創(chuàng)建一個(gè)名為javax.annotation.processing.Processor的文件修械,在此文件內(nèi)逐行聲明注解處理器。同樣地检盼,此處需要聲明的也是處理器類的完全限定名肯污。
另一個(gè)簡(jiǎn)便的方法是使用Google提供的auto-services庫,在build.gradle中引入com.google.auto.service:auto-service:1.0-rc2吨枉,并在處理器類上添加注解@AutoService(Processor.class)蹦渣,auto-services也是一個(gè)注解處理器,會(huì)在編譯時(shí)為該module生成聲明文件貌亭。

@AutoService(Processor.class)
public class SayHiProcessor extends AbstractProcessor {

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> types = new HashSet<>();
        types.add(SayHi.class.getCanonicalName());
        return types;
    }

    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        /*roundEnv.getRootElements()會(huì)返回工程中所有的Class
        在實(shí)際應(yīng)用中需要對(duì)各個(gè)Class先做過濾以提高效率柬唯,避免對(duì)每個(gè)Class的內(nèi)容都進(jìn)行掃描*/
        for (Element element : roundEnvironment.getRootElements()) {
            if (element.getAnnotation(SayHi.class) == null) { //過略掉沒有添加SayHi注解的class
                return true;
            }
            String enclosingName = ((TypeElement) element).getQualifiedName().toString(); //獲取類的全限定類名
            String packageName = enclosingName.substring(0, enclosingName.lastIndexOf('.')); //獲取包名
            String clazzName = element.getSimpleName() + "_SayHi";  //生成類的名字

            try {
                JavaFileObject javaFileObject = processingEnv.getFiler().createSourceFile(clazzName); //創(chuàng)建文件
                Writer writer = javaFileObject.openWriter();
                //以下都是對(duì)文件的文件流操作,對(duì)下面的插入字符可以對(duì)照上面的生成代碼
                PrintWriter printWriter = new PrintWriter(writer);
                printWriter.println("package " + packageName + ";");
                printWriter.println("\npublic class " + clazzName + "{");
                printWriter.println("\n\tpublic void sayHi(String content){");
                printWriter.println("\n\t\tSystem.out.println(content);");
                printWriter.println("\n\t}");
                printWriter.println("\n}");
                printWriter.flush();
                printWriter.close();
                writer.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return true;
    }
}

0x5 添加APT插件

  1. 修改project的build.gradle
  1. 修改app的build.gradle
image.png

0x6 運(yùn)行結(jié)果

  1. 點(diǎn)擊 Build -> Rebuild Project


    點(diǎn)擊Rebuild
  2. 打開 build -> generated -> source -> debug 查看生成文件
查看生成文件

參考鏈接:
http://www.reibang.com/p/f85e5212be55
https://yq.aliyun.com/articles/59493
https://www.2cto.com/kf/201608/536317.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市圃庭,隨后出現(xiàn)的幾起案子锄奢,更是在濱河造成了極大的恐慌,老刑警劉巖剧腻,帶你破解...
    沈念sama閱讀 211,884評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件拘央,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡书在,警方通過查閱死者的電腦和手機(jī)灰伟,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,347評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來蕊温,“玉大人袱箱,你說我怎么就攤上這事遏乔∫迕” “怎么了?”我有些...
    開封第一講書人閱讀 157,435評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵盟萨,是天一觀的道長凉翻。 經(jīng)常有香客問我,道長捻激,這世上最難降的妖魔是什么制轰? 我笑而不...
    開封第一講書人閱讀 56,509評(píng)論 1 284
  • 正文 為了忘掉前任前计,我火速辦了婚禮,結(jié)果婚禮上垃杖,老公的妹妹穿的比我還像新娘男杈。我一直安慰自己,他們只是感情好调俘,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,611評(píng)論 6 386
  • 文/花漫 我一把揭開白布伶棒。 她就那樣靜靜地躺著,像睡著了一般彩库。 火紅的嫁衣襯著肌膚如雪肤无。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,837評(píng)論 1 290
  • 那天骇钦,我揣著相機(jī)與錄音宛渐,去河邊找鬼。 笑死眯搭,一個(gè)胖子當(dāng)著我的面吹牛窥翩,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播鳞仙,決...
    沈念sama閱讀 38,987評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼鳍烁,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了繁扎?” 一聲冷哼從身側(cè)響起幔荒,我...
    開封第一講書人閱讀 37,730評(píng)論 0 267
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎梳玫,沒想到半個(gè)月后爹梁,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,194評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡提澎,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,525評(píng)論 2 327
  • 正文 我和宋清朗相戀三年姚垃,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了执庐。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片僧凰。...
    茶點(diǎn)故事閱讀 38,664評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡承耿,死狀恐怖怕磨,靈堂內(nèi)的尸體忽然破棺而出却盘,到底是詐尸還是另有隱情窄陡,我是刑警寧澤垂睬,帶...
    沈念sama閱讀 34,334評(píng)論 4 330
  • 正文 年R本政府宣布鹏秋,位于F島的核電站跨嘉,受9級(jí)特大地震影響川慌,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,944評(píng)論 3 313
  • 文/蒙蒙 一梦重、第九天 我趴在偏房一處隱蔽的房頂上張望兑燥。 院中可真熱鬧,春花似錦琴拧、人聲如沸降瞳。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,764評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽力崇。三九已至,卻和暖如春赢织,著一層夾襖步出監(jiān)牢的瞬間亮靴,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,997評(píng)論 1 266
  • 我被黑心中介騙來泰國打工于置, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留茧吊,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,389評(píng)論 2 360
  • 正文 我出身青樓八毯,卻偏偏與公主長得像搓侄,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子话速,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,554評(píng)論 2 349

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