自定義Android Studio代碼模板

背景

我們知道骆姐,在Android開發(fā)中笔呀,官方提供了很多模板幢踏,可以直接創(chuàng)建成套的代碼,很是方便開發(fā)

Android Studio默認(rèn)提供的模板

這種代碼模板其實不是什么新鮮的技術(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用來定義如何生成代碼和文件

recipe的作用

·其他模板代碼文件

除了根目錄下的globals.xml.ftl姑曙、recipe.xml.ftl襟交、template.xml三個文件,其他模板都可以根據(jù)需要自由配置伤靠。

制作自定義MVPActivity模板

模板文件結(jié)構(gòu)如下

文件結(jié)構(gòu)

核心就在于代碼文件夾里的三個文件捣域,分別是MVP的接口、Presenter和Activity宴合,文件內(nèi)容分別如下:

Contract的模板文件:

contract模板

Presenter的模板文件:

presenter模板

Activity的模板文件:

activity的模板

在recipe.xml.ftl文件中把這幾個文件初始化并復(fù)制到工程中

recipe的定義

最后焕梅,把整個文件夾復(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的名字。

自定義模板的template

生成的文件結(jié)構(gòu)如下

文件結(jié)構(gòu)

生成的Activity文件

Activity

生成的Presenter

Presenter

生成的Contract

Contract

至此兔簇,我們完成了自定義代碼模板的編寫和使用

結(jié)束

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末发绢,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子垄琐,更是在濱河造成了極大的恐慌边酒,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,482評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件狸窘,死亡現(xiàn)場離奇詭異,居然都是意外死亡翻擒,警方通過查閱死者的電腦和手機(jī)氓涣,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,377評論 2 382
  • 文/潘曉璐 我一進(jìn)店門鹃操,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人春哨,你說我怎么就攤上這事荆隘。” “怎么了赴背?”我有些...
    開封第一講書人閱讀 152,762評論 0 342
  • 文/不壞的土叔 我叫張陵椰拒,是天一觀的道長。 經(jīng)常有香客問我凰荚,道長燃观,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,273評論 1 279
  • 正文 為了忘掉前任便瑟,我火速辦了婚禮缆毁,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘到涂。我一直安慰自己脊框,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,289評論 5 373
  • 文/花漫 我一把揭開白布践啄。 她就那樣靜靜地躺著浇雹,像睡著了一般。 火紅的嫁衣襯著肌膚如雪屿讽。 梳的紋絲不亂的頭發(fā)上昭灵,一...
    開封第一講書人閱讀 49,046評論 1 285
  • 那天,我揣著相機(jī)與錄音伐谈,去河邊找鬼烂完。 笑死,一個胖子當(dāng)著我的面吹牛诵棵,可吹牛的內(nèi)容都是我干的抠蚣。 我是一名探鬼主播,決...
    沈念sama閱讀 38,351評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼非春,長吁一口氣:“原來是場噩夢啊……” “哼柱徙!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起奇昙,我...
    開封第一講書人閱讀 36,988評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎敌完,沒想到半個月后储耐,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,476評論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡滨溉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,948評論 2 324
  • 正文 我和宋清朗相戀三年什湘,在試婚紗的時候發(fā)現(xiàn)自己被綠了长赞。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,064評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡闽撤,死狀恐怖得哆,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情哟旗,我是刑警寧澤贩据,帶...
    沈念sama閱讀 33,712評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站闸餐,受9級特大地震影響饱亮,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜舍沙,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,261評論 3 307
  • 文/蒙蒙 一近上、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧拂铡,春花似錦壹无、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,264評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至留瞳,卻和暖如春拒迅,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背她倘。 一陣腳步聲響...
    開封第一講書人閱讀 31,486評論 1 262
  • 我被黑心中介騙來泰國打工璧微, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人硬梁。 一個月前我還...
    沈念sama閱讀 45,511評論 2 354
  • 正文 我出身青樓前硫,卻偏偏與公主長得像,于是被迫代替她去往敵國和親荧止。 傳聞我的和親對象是個殘疾皇子屹电,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,802評論 2 345

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