編譯注解----實例

這個 demo 是這篇博客里的一個例子,光看沒看懂,又照著寫了一遍也還是很懵,為了更好的理解,幾乎把每一句核心代碼都打印,都注釋了,這樣才略懂了一些在編譯時生成代碼這個流程。

下面這個方法是最懵的,所以注釋寫了很多,里面的各種元素都比較抽象,看的時候,甚至是第一次寫的時候,都不知道在寫什么,通過打印把抽象的東西,還原成我們熟悉的東西就好理解多了。

/**
 *
 * @param set  包含的是所有使用的[注解的信息],例如BindView,ContentView
 * @param roundEnvironment 返回的是所有被注解的[元素],例如類,屬性等
 * @return
 */
 @Override
 public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
//        mMessager.printMessage(Diagnostic.Kind.NOTE,"process...");
?
 // 防止處理多次,要清空
 mProxyMap.clear();
?
 System.out.println("mProxyMap"+mProxyMap.toString());
 // 獲取全部的帶有 bindview 注解的 element
 Set<? extends Element> elseWithBind = roundEnvironment.getElementsAnnotatedWith(BindView.class);
 System.out.println("elseWithBind: " + elseWithBind.toString());
 //elseWithBind: [mTextView, mImageView]
?
 // 對bindview 進行循環,構建 proxyInfo 信息
 for (Element element : elseWithBind) {
 // 檢查 element 的合法性
 checkSAnnotationValid(element,BindView.class);
?
 // 強轉成屬性元素
 VariableElement variableElement = (VariableElement) element;
 System.out.println("variableElement: "+variableElement);
//            variableElement: mTextView
?
 System.out.println("-----"+ element.getEnclosingElement());
?
 // 要獲取類元素的類名,直接用 element 也可以,強轉不是必須的。
 // 屬性元素的外層一定是類元素
 TypeElement typeElement = (TypeElement) variableElement.getEnclosingElement();
 System.out.println("typeElement: "+typeElement);
 // typeElement: com.limiao.annotationdemo.MainActivity
?
 // 獲取類元素的類名(全路徑名)
 String fqClassName = typeElement.getQualifiedName().toString();
 System.out.println("fqClassName: "+fqClassName);
//            fqClassName: com.limiao.annotationdemo.MainActivity
?
 System.out.println("mProxyMap: "+mProxyMap);
?
 ProxyInfo proxyInfo = mProxyMap.get(fqClassName);
 if (proxyInfo == null){
 proxyInfo = new ProxyInfo(mElementUtils,typeElement);
 // 以 class 名稱為 key,保存到 mProxy 中
 mProxyMap.put(fqClassName,proxyInfo);
 }
?
 System.out.println("proxyInfo:"+proxyInfo);
?
 // 獲取 bindview 注解,把信息放入 proxyInfo 中
 BindView bindAnnotation = element.getAnnotation(BindView.class);
 int id = bindAnnotation.value();
 mMessager.printMessage(Diagnostic.Kind.NOTE,"proxyInfo:" + proxyInfo.toString());
 mMessager.printMessage(Diagnostic.Kind.NOTE,"variableElement:" + variableElement);
 mMessager.printMessage(Diagnostic.Kind.NOTE,"id:" + id);
 // 上面的強轉要用到這里,作為參數
 proxyInfo.injectVarialbles.put(id,variableElement);
 }
?
 // 獲取所有的 ContentView 注解,操作原理和上面的 bindview 一樣
 Set<? extends Element> contentAnnotations = roundEnvironment.getElementsAnnotatedWith(ContentView.class);
 for (Element element : contentAnnotations) {
 TypeElement typeElement = (TypeElement) element;
 String fqClassName  = typeElement.getQualifiedName().toString();
 ProxyInfo proxyInfo = mProxyMap.get(fqClassName);
 if (proxyInfo == null) {
 proxyInfo = new ProxyInfo(mElementUtils,typeElement);
 mProxyMap.put(fqClassName,proxyInfo);
 }
 ContentView contentViewAnnotation = element.getAnnotation(ContentView.class);
 proxyInfo.contentViewId = contentViewAnnotation.value();
 }
?
 // 循環生成源文件
 for (String key : mProxyMap.keySet()) {
 ProxyInfo proxyInfo = mProxyMap.get(key);
 try {
 System.out.println("ProxyClassFullName: "+proxyInfo.getProxyClassFullName());
 System.out.println("TypeElement: "+proxyInfo.getTypeElement());
 // 創建一個 javaFile 文件
 // 第一個參數:創建的文件名,包含全路徑
 // 第二個參數:與此文件的創建有因果關聯的類型或包或模塊元素,可以為null(文檔的說明)
//                JavaFileObject jfo = processingEnv.getFiler().createSourceFile(proxyInfo.getProxyClassFullName(),proxyInfo.getTypeElement());
//                試了一下,如果第二個參數為 null ,也沒有關系,還能正常編譯運行
 JavaFileObject jfo = processingEnv.getFiler().createSourceFile(proxyInfo.getProxyClassFullName(),null);
 Writer writer = jfo.openWriter();
 writer.write(proxyInfo.generateJavaCode());
 writer.flush();
 writer.close();
 } catch (IOException e) {
?
 e.printStackTrace();
 error(proxyInfo.getTypeElement(),"unable to write injector for type %s: %s",proxyInfo.getTypeElement(),e.getMessage());
 }
 }
?
 return true;
?
 }

參考的這篇博客的作者關于編譯注解寫了一個系列的文章,都很好,這里整理一下貼出來,方便查閱。

深入理解編譯注解(一)從實戰理解什么是編譯注解

深入理解編譯注解(二)annotationProcessor與android-apt

深入理解編譯注解(三)依賴關系 apt/annotationProcessor與Provided的區別

深入理解編譯注解(四)常用接口介紹

深入理解編譯注解(五)RetentionPolicy.SOURCE 和 RetentionPolicy.CLASS區別討論

深入理解編譯注解(六)Butterknife的實現原理

demo github 地址

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,546評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,570評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,505評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,017評論 1 313
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,786評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,219評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,287評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,438評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,971評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,796評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,995評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,540評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,230評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,662評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,918評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,697評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,991評論 2 374

推薦閱讀更多精彩內容