大幅提高Android開發(fā)效率之Android項目模板化(下)

大家好,我是光源。

《大幅提高Android開發(fā)效率之Android項目模板化(上)》中我們了解了如何用 Android Studio Template 大幅減少寫業(yè)務代碼前的工作量,同時也稍微提了下用 Live Template 減少寫業(yè)務代碼過程中的“樣板式代碼”。

可能有朋友會問,我們這么緊張這點效率真的必要么?

這個問題我先不回答,我們先來看看一個場景:寫一個單例。

單例模式應該是開發(fā)過程中最常見的設(shè)計模式之一了。寫單例前總得先糾結(jié)一下吧,單例模式這么多種實現(xiàn)方式該用哪種好呢?選定了實現(xiàn)方式后,老老實實寫一堆代碼,然后你會突然發(fā)現(xiàn)除了類名不一樣外,其他代碼都是一模一樣,這時你心里會不會隱隱約約覺得這是可以優(yōu)化的?

我不知道你完成單例模式的實現(xiàn)需要多長時間,但我告訴你,我們可以用一秒來搞定,你會不會覺得老老實實寫代碼的自己很傻?

這就是 Live Template 的第一個作用,提高編碼效率。

再接著上面的話題,又有人吐槽另一個細節(jié)了,一般有點年頭的程序員對于單例模式都有自己的一個默認實現(xiàn)方式,不需要花時間去糾結(jié)吧?

這話不假,像我就默認使用內(nèi)部靜態(tài)類的方式實現(xiàn)單例。但是你有沒有想過,項目開發(fā)是一個團隊協(xié)作的過程,就算個人不糾結(jié),但多人開發(fā)情況下,要么每個人用自己的一套實現(xiàn)方式造成代碼風格不統(tǒng)一,要么同事還是得事先通氣、詢問用哪種好。(編碼規(guī)范文檔也不會事無巨細把這類問題也事先規(guī)定好的)

再思考一下,很多有多方案且不屬于編碼規(guī)范的場景,我們又要怎么去統(tǒng)一呢?

答案還是用 Live Template。例如,Android 開發(fā)中,我們應該使 Message.obtain() 來獲取一個 Message 實例,而不是去 new 一個,那么我們完全可以定一個 getMsg 的 Live Template,大家只要是用 getMsg 的,可以嚴格保證統(tǒng)一性——這就是 Live Template 的另一個作用了,保持項目中非編碼性質(zhì)的代碼風格統(tǒng)一。(編碼性質(zhì)的代碼風格統(tǒng)一果斷用編碼規(guī)范文檔來實現(xiàn)了)

大家看到這里一定已經(jīng)對 Live Template 有了一定的重視與好奇了吧,別著急,下面上正餐。

一、Live Template 簡介

何為 Live template ?直譯是“實時模板”,它的機制簡單地說就是提前定義好一些通用的代碼片段在編寫代碼時插入編輯器,使用方法類似代碼補全,默認快捷方式是 Tab 鍵(不同平臺不同版本可能有差異)。本文將根據(jù) Android Studio 1.5+ 版本介紹 Live template 相關(guān)內(nèi)容。

進入 Settings/Preferences -> Editor -> Live Templates,可以看到當前已經(jīng)有的的模板組。

圖一

可以看到,默認情況下已經(jīng)有一些模板存在。

打開分組的某個具體模板,可以看到一個模板包含了縮寫、描述、內(nèi)容三塊。

圖二

在編寫代碼的過程中輸入模板縮寫,按下 Tab 鍵,對應的代碼片段就插入到當前位置。

以上就是 Live Template 的簡單使用,基本與普通代碼補全沒啥差別,特別簡單實用。

當然,默認的模板雖然不少,但我們不會止步于使用默認的模板,下面說一說如何自定義模板。

二、自定義 template

第一步 創(chuàng)建新模板

進入 Settings/Preferences -> Editor -> Live Templates,選擇某個分組,點擊右上角的 “+” 號,選擇 Live Template。

第二步 選擇模板適用范圍

點擊下方的 “Define”,選擇適用范圍。如適用于 class 文件就選 java ,適用于 xml 文件就 xml。

選定了范圍后,在范圍之外的文件則無法使用該模板。例如 Android XML 分組的“l(fā)h”模板選定了 xml,則在 class 文件中是無法使用的。

第三步 填寫內(nèi)容

如圖二所示,一個模板包括模板縮寫、描述、內(nèi)容三塊。

  • 模板縮寫一方面是模板的名稱,另一方面是 Live Template 的觸發(fā)標識,命名上建議盡量簡潔,同時不要與普通類名、方法名等相同。

  • 描述是模板的詳細描述,在提示中會顯示給用戶。

  • 內(nèi)容是模板的具體定義,由普通代碼和變量組成。

模板內(nèi)容除了寫死的內(nèi)容外,還可以聲明和使用變量。變量形式為 $<variable_name>$ 。通過點擊下圖中的“Edit variables”按鈕打開變量定義窗口我們就可以開始創(chuàng)建當前模板的變量。

圖三
  • Name 變量名,對應 variable_name
  • Expression 變量的表現(xiàn)
  • Default value 默認值
  • Skip if defined 是否跳過編輯

編輯器已經(jīng)事先定義好 Expression 的一些方法, 部分常用方法如下:

方法 描述
annotated("annotation qname") 注解
arrayVariable() 集合變量
className(sClassName) 當前類名
classNameComplete() 當前完整類名
complete() 代碼補全
componentTypeOf (<array variable or array type>) 集合內(nèi)的元素類型
date(sDate) 系統(tǒng)當前日期
expectedType() 所需結(jié)果的類型,這個在類型轉(zhuǎn)換中特別適用
fileName(sFileName) 帶擴展名的文件名
iterableComponentType(<ArrayOrIterable>) 可遍歷的集合或數(shù)組類型
lineNumber() 行號
methodName() 方法名
methodReturnType() 方法返回類型
suggestIndexName() 建議的索引名(i/j 等)
suggestVariableName() 建議的變量名
time(sSystemTime) 系統(tǒng)時間
typeOfVariable(VAR) 變量類型
user() 當前用戶名

(詳見 https://www.jetbrains.com/help/idea/2016.1/live-template-variables.html#predefined_functions

三、舉個例子

眾所周知,單例是程序開發(fā)中最常用的模式之一,雖然有多種實現(xiàn)方案,但不管選擇哪種都避免不了重復寫一些“樣板代碼”,而這種場景就可以用live template 來解決了。接下來我們用創(chuàng)建單例模式的模板來具體說明如何自定義模板。

  1. 進入 Settings/Preferences -> Editor -> Live Templates,選擇某個分組,點擊右上角的“+” 號,選擇 Live Template

  2. 選定適用范圍為 java。

  3. 填上縮寫為 singleTon,描述為單例模式。然后把以下代碼拷貝到模板內(nèi)容中:

private static class SingleTonHolder {
    private static final $class$ INSTANCE = new $class$();
}

public static $class$ getInstance() {
    return SingleTonHolder.INSTANCE;
}

private $class$() {
    
}

  1. 這里定義了 class 變量,需要點擊 edit variables 創(chuàng)建該變量,變量名為 class,Expression 選擇 className() 。點擊 OK 保存。

  2. 創(chuàng)建某個 class 后,輸入 singleTon ,按下 tab 鍵就可以看到單例模板。

四、Live Template 的導出與導入

第一種方法是,創(chuàng)建完模板后模板數(shù)據(jù)會以XML的形式存儲在 android studio config\templates 目錄下,window下為 C:\Users\\<user>\\.AndroidStudiox.x\config\templates (user為你的計算機用戶名), mac下為
~/Library/Preferences/AndroidStudiox.x/templates ,將其中的文件拷貝出即可導出;同理可知,導入時將已定義好的xml文件放到相同目錄下,即可完成導入。

第二種方案是,通過 File -> Export SettingsImport Settings,只選中 Live Templates。

五、項目實踐

對于具體的項目而言,自定義 Live Template 可以分成兩部分,一部分是相對通用的模板,作為默認模板的補充,比如上文中的單例模式模板;另一部分是跟項目邏輯深度相關(guān)的模板,比如使用項目中自定義的LogUtil而不是普通的Log來打 log 。

上文中已經(jīng)給出自定義通用模板的例子,這里再給出項目相關(guān)模板的示例。

例如,項目內(nèi)部有 toast 工具類來顯示一個 toast,定義一個名為“xxtoast”的模板(避免與普通toast沖突,加上前綴),內(nèi)容是

    ToastUtil.makeShortToast($strRes$);

最后,將這些自定義模板導出放到 gitlab 上,其他同事只需要將這些文件 clone 到對應目錄下,即可直接使用。

小工具

有一個叫做 exynap 的 Anroid Studio 插件可以很方便搜索、創(chuàng)建、使用代碼片段(與 Live Template 不共享),感興趣的朋友可以看看。

六,參考資料

https://www.jetbrains.com/help/idea/2016.2/live-templates.html

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

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

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,696評論 25 708
  • 1 背景 一個項目開發(fā)必然會涉及團隊協(xié)作,而工程質(zhì)量就需要團隊去保證。一般我們期望的代碼:無潛在風險、無重復邏輯、...
    zyl06閱讀 3,231評論 5 16
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 134,814評論 18 139
  • 出道的我不知道什么是好茶,通過學習能分辨茶的優(yōu)劣等級了,覺得“能喝”的茶就是好茶! 因為能喝說明健康!難道讓人健康...
    先生百年閱讀 766評論 1 3
  • 被動接受外力改變的叫食物,從體驗到思想到內(nèi)心,然后努力改變環(huán)境的叫生命。
    Onlyyou丶完美閱讀 291評論 0 0