Android Studio Plugin 插件開發教程(二) —— 插件SDK中的常用對象介紹

項目源碼

https://github.com/boredream/AndroidDatabaseGeneratorPlugin

系列教程

Android Studio Plugin 插件開發教程(一) —— 開發你的第一個插件

Android Studio Plugin 插件開發教程(二) —— 插件SDK中的常用對象介紹

Android Studio Plugin 插件開發教程(三) —— 制作一個自動生成數據庫代碼的插件

Android Studio Plugin 插件開發教程(四) —— 為自動生成數據庫代碼的插件添加UI


先樹立一個概念,AS里項目的一切都可以視為對象,比如整個項目,項目里的每個文件,文件里的每個方法、每行語句等等都是一個對象。我們插件SDK的開發,主要工作就是針對這一個個的對象的分析和處理

下面開始介紹幾個主要的對象類

Virtual File

虛擬文件類。
可以當做Java開發中的File對象理解,概念比較類似

獲取方法
  • 通過Action獲取: event.getData(PlatformDataKeys.VIRTUAL_FILE).
    這個也是之前教程(一)中的獲取方法
  • 通過本地文件路徑獲取: LocalFileSystem.getInstance().findFileByIoFile()
  • 通過PSI file獲取: psiFile.getVirtualFile()
  • 通過document獲取: FileDocumentManager.getInstance().getFile()
用處

傳統的文件操作方法這個對象都支持,比如獲取文件內容,重命名,移動,刪除等


PSI File

PSI系統下的文件類。

獲取方法
  • 通過Action獲取: e.getData(LangDataKeys.PSI_FILE).
  • 通過VirtualFile獲取: PsiManager.getInstance(project).findFile()
  • 通過document獲取: PsiDocumentManager.getInstance(project).getPsiFile()
  • 通過文件中的Element元素獲取: psiElement.getContainingFile()
    如果要通過名字獲取,請使用 FilenameIndex.getFilesByName(project, name, scope)
用處

作為PSI系統中的一個元素,可以使用PSI Element的各種具體方法


看到這里肯定很多人一臉迷惑,這倆File有啥區別?PSI是啥?Element又是啥?

什么是PSI系統?

PSI 是 Program Structure Interface 的簡寫。從名字可以看出來它是一個接口,相當于把項目中的一切都封裝了起來,比如類、方法、語句等,讓他們都成為了同一個系統內的實現。封裝的對象類都統一加了個前綴比如PsiClass、PsiMethod等。

Virtual File 和 PSI File的區別?

如果學過Dom和Parse解析就很好理解了,Virtual File就是xml文件本身的一個抽象對象。而PSI File就類似于Dom下xml文件解析成的Document對象,雖然也是“文件”,但是特殊封裝過的~ 這個PsiFile是整個PSI系統下的文件對象,和PSI下的其他Element元素相通~

PSI Element是什么?

PSI Element是PSI系統下不同類型對象的一個統稱,是基類。
比如之前提到的PsiMethod、PsiClass等等都是一個個具體的PsiElement實現。


可能還會有點迷惑,下面寫個demo幫助理解。
我們通過ActionEvent的getData方法,傳入對應KEY獲取PsiFile(Action類創建參考上篇教程),然后遍歷PsiFile文件下所有的子級元素,打印出來(日志顯示在開發插件的IDE的控制臺)
注意,這個直接獲取的PsiFile默認為當前我們當前所選的文件

@Override
public void actionPerformed(AnActionEvent e) {
    PsiFile file = e.getData(PlatformDataKeys.PSI_FILE);
    for (PsiElement psiElement : file.getChildren()) {
        System.out.println(psiElement);
    }
}

代碼run起來
運行起來的IDE我們新建一個Android Project,默認主頁面代碼如下

插件測試項目

然后在菜單中 Code | Database Generate 調用我們編寫的插件
運行結果日志如下:

PsiPackageStatement:com.boredream.plugindemo
PsiWhiteSpace
PsiImportList
PsiWhiteSpace
PsiClass:MainActivity
PsiWhiteSpace

這里把MainActivity文件下所有的子級Element都列出來了(只遍歷直接子級)
看名字就能知道意思,PsiPackageStatement是包名語句,PsiClass是類。。。甚至還有PsiWhiteSpace,空白都專門有個類型啊!細致!

這里不同的Element還有自己對應的特殊方法,比如PsiClass就和Java中的Class類似,可以獲取Field、Method等。下面我們再簡單改造下Demo,獲取MainActivity文件中Class里面的元素。

@Override
public void actionPerformed(AnActionEvent e) {
    PsiFile file = e.getData(PlatformDataKeys.PSI_FILE);
    for (PsiElement psiElement : file.getChildren()) {
        if(psiElement instanceof PsiClass) {
            PsiClass clazz = (PsiClass) psiElement;
            PsiMethod method = clazz.getMethods()[0];
            System.out.println(method.getName());
            System.out.println(method.getParameterList().getText());
        }
    }
}

同樣,再次run項目,然后調用插件
運行結果日志如下:

onCreate
(Bundle savedInstanceState)

這次我們遍歷獲取了PsiClass類對象,然后獲取它內部的第一個方法,并打印方法的名字和方法參數的文字

本篇教程結束~
下一章,我們將開擼 自動生成數據庫插件代碼的實戰~
然后一邊寫插件一邊再學習新的內容

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

推薦閱讀更多精彩內容