背景
我們知道骆姐,在Android開發(fā)中笔呀,官方提供了很多模板幢踏,可以直接創(chuàng)建成套的代碼,很是方便開發(fā)
這種代碼模板其實不是什么新鮮的技術(shù)许师,Google其實就是把Freemarker模板引擎整合到了Android Studio中房蝉。
下面我們研究一下Android Studio的模板僚匆,并自定義兩個代碼模板。
模板文件淺析
我們打開Android Studio的模板文件搭幻,分析一下這種文件的構(gòu)成咧擂,文件地址為..\Android Studio\plugins\android\lib\templates\,我們在AS中使用的模板都在這里出現(xiàn)檀蹋。
我們以..\Android Studio\plugins\android\lib\templates\activities\LoginActivity為例松申,分析一下模板文件是怎么運(yùn)作的
文件夾中的文件及各文件的作用如下:
在上圖中,出現(xiàn)了三種文件俯逾,ftl贸桶、xml和png
ftl是freemarker文件,跟模板文件操作相關(guān)的操作都在ftl文件中定義
xml有兩個桌肴,根目錄下的template.xml定義了我們在使用模板時顯示的界面皇筛;另一個res文件夾下的xml文件沒有邏輯功能,將直接被復(fù)制到我們的工程中
png只有根目錄下的那個文件坠七,其實就顯示在我們使用模板時顯示的界面里水醋,作為該模板的logo使用
我們再看看根目錄下的三個文件的文件內(nèi)容
·template.xml
template.xml定義了使用模板時的界面,我們先看LoginActivity的模板界面
我們看看template.xml如何定義這個界面
定義模板類別
定義輸入項
容易看到彪置,每個輸入框的默認(rèn)值拄踪、提示、類型等都是在xml中定義的拳魁。
需要注意的是惶桐,我們更改Activity Name時,Layout Name也會隨之更改的猛,這是通過“suggest="${activityToLayout(activityClass)}"”實現(xiàn)的耀盗,其中${activityToLayout()是個函數(shù)想虎,用于把Activity的類名XXXActivity轉(zhuǎn)換成Layout名activity_XXX卦尊;而這個函數(shù)的入?yún)ⅰ癮ctivityClass”就是“Activity Name”這個輸入框?qū)?yīng)的id“activityClass”。
最后是定義logo和包名
template的作用不止是定義模板的界面舌厨,事實上岂却,通過在template里定義的id,其他ftl文件就可以獲取我們在界面上輸入的類名和文件名等裙椭,為自動生成文件和代碼提供輸入?yún)?shù)躏哩。
例如,在LoginActivity.java.ftl中揉燃,生成XXXActivity.java文件時扫尺,文件的名字,類的名字炊汤,都會根據(jù)template文件中activityClass的值進(jìn)行賦值
·globals.xml.ftl
定義一些全局變量
如上圖所示正驻,在globals里定義了一個與API版本有關(guān)的boolean值弊攘,這個值將在生成LoginActivity的代碼時,用來判斷是否要添加部分代碼
·recipe.xml.ftl
recipe.xml.ftl用來定義如何生成代碼和文件
·其他模板代碼文件
除了根目錄下的globals.xml.ftl姑曙、recipe.xml.ftl襟交、template.xml三個文件,其他模板都可以根據(jù)需要自由配置伤靠。
制作自定義MVPActivity模板
模板文件結(jié)構(gòu)如下
核心就在于代碼文件夾里的三個文件捣域,分別是MVP的接口、Presenter和Activity宴合,文件內(nèi)容分別如下:
Contract的模板文件:
Presenter的模板文件:
Activity的模板文件:
在recipe.xml.ftl文件中把這幾個文件初始化并復(fù)制到工程中
最后焕梅,把整個文件夾復(fù)制到..\Android Studio\plugins\android\lib\templates\activities\下,
重啟Android Studio
卦洽,就可以應(yīng)用了
在Activity類別的模板中丘侠,多了一個Empty MVP Activity
打開后,界面如下
我們注意到逐样,最前面有個Biz Name的輸入?yún)?shù)蜗字,這個參數(shù)的作用不是生成文件,而是為后面的文件統(tǒng)一命名脂新,因為Activity Name只能影響到Layout Name挪捕,我希望能一起設(shè)置接口和Presenter的名字,但是Freemarker沒有和${activityToLayout()這個函數(shù)對應(yīng)的生成接口和Presenter名字的函數(shù)争便,所以我在最前面增加了這樣一個變量级零,專門用于統(tǒng)一命名。
具體在template.xml文件中滞乙,增加了一個id為“activityName”的變量奏纪,并為后續(xù)的變量賦值,如在“activityClass”中斩启,把suggest的值設(shè)定為"${activityName}Activity"序调,讓它自己拼出XXXActivity的名字。
生成的文件結(jié)構(gòu)如下
生成的Activity文件
生成的Presenter
生成的Contract
至此兔簇,我們完成了自定義代碼模板的編寫和使用