想要自己的專屬代碼模板？一文教你自定義Android Studio代碼模板！

背景

我們知道，在Android開發中，官方提供了很多模板，可以直接創建成套的代碼，很是方便開發

這種代碼模板其實不是什麼新鮮的技術，Google其實就是把Freemarker模板引擎整合到了Android Studio中。

下面我們研究一下Android Studio的模板，並自定義兩個代碼模板。

模板文件淺析

我們打開Android Studio的模板文件，分析一下這種文件的構成，文件地址爲…\Android Studio\plugins\android\lib\templates\，我們在AS中使用的模板都在這裏出現。

我們以…\Android Studio\plugins\android\lib\templates\activities\LoginActivity爲例，分析一下模板文件是怎麼運作的

文件夾中的文件及各文件的作用如下：

在上圖中，出現了三種文件，ftl、xml和png

• ftl是freemarker文件，跟模板文件操作相關的操作都在ftl文件中定義

• xml有兩個，根目錄下的template.xml定義了我們在使用模板時顯示的界面；另一個res文件夾下的xml文件沒有邏輯功能，將直接被複制到我們的工程中

• png只有根目錄下的那個文件，其實就顯示在我們使用模板時顯示的界面裏，作爲該模板的logo使用

我們再看看根目錄下的三個文件的文件內容

·template.xml

template.xml定義了使用模板時的界面，我們先看LoginActivity的模板界面

我們看看template.xml如何定義這個界面

定義模板類別

定義輸入項：

容易看到，每個輸入框的默認值、提示、類型等都是在xml中定義的。

需要注意的是，我們更改Activity Name時，Layout Name也會隨之更改，這是通過「suggest=" ${activityToLayout(activityClass)}"」實現的，其中$activityToLayout(activityClass)"」實現的，其中{activityToLayout()是個函數，用於把Activity的類名XXXActivity轉換成Layout名activity_XXX；而這個函數的入參「activityClass」就是「Activity Name」這個輸入框對應的id「activityClass」。

最後是定義logo和包名

template的作用不止是定義模板的界面，事實上，通過在template裏定義的id，其他ftl文件就可以獲取我們在界面上輸入的類名和文件名等，爲自動生成文件和代碼提供輸入參數。

例如，在LoginActivity.java.ftl中，生成XXXActivity.java文件時，文件的名字，類的名字，都會根據template文件中activityClass的值進行賦值

·globals.xml.ftl

定義一些全局變量

如上圖所示，在globals裏定義了一個與API版本有關的boolean值，這個值將在生成LoginActivity的代碼時，用來判斷是否要添加部分代碼

·recipe.xml.ftl

recipe.xml.ftl用來定義如何生成代碼和文件

·其他模板代碼文件

除了根目錄下的globals.xml.ftl、recipe.xml.ftl、template.xml三個文件，其他模板都可以根據需要自由配置。

製作自定義的MVPActivity模板

模板文件結構如下：

核心就在於代碼文件夾裏的三個文件，分別是MVP的接口、Presenter和Activity，文件內容分別如下：

Contract的模板文件：

Presenter的模板文件：

Activity的模板文件：

在recipe.xml.ftl文件中把這幾個文件初始化並複製到工程中

最後，把整個文件夾複製到…\Android Studio\plugins\android\lib\templates\activities\下，重啓Android Studio，就可以應用了。在Activity類別的模板中，多了一個Empty MVP Activity

打開後，界面如下：

我們注意到，最前面有個Biz Name的輸入參數，這個參數的作用不是生成文件，而是爲後面的文件統一命名，因爲Activity Name只能影響到Layout Name，我希望能一起設置接口和Presenter的名字，但是Freemarker沒有和${activityToLayout()這個函數對應的生成接口和Presenter名字的函數，所以我在最前面增加了這樣一個變量，專門用於統一命名。

具體在template.xml文件中，增加了一個id爲「activityName」的變量，併爲後續的變量賦值，如在「activityClass」中，把suggest的值設定爲"${activityName}Activity"，讓它自己拼出XXXActivity的名字。

生成的文件結構如下：

生成的Activity文件：

生成的Presenter：

生成的Contract：

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

最後

你把你的時間投資在學習上，就意味着你可以收穫技能，更有機會增加收入。

在這裏分享我的Android學習PDF大全來學習，這份Android學習PDF大全真的包含了方方面面了，內含Java基礎知識點、Android基礎、Android進階延伸、算法合集等等

我的這份學習合集，可以有效的幫助大家掌握知識點。

總之也是在這裏幫助大家學習提升進階，也節省大家在網上搜索資料的時間來學習，也可以分享給身邊好友一起學習

獲取方式：關注我看個人介紹，或直接 點擊我免費領取