AndroidStudio模版

一、描述

AndroidStudio模版可以很快捷的開發項目,增加開發效率,也能對項目的規范有一定的限制,也不用每次都寫一些重復的代碼,也能避免一些不必要的Bug出現,只需要注重具體代碼實現就好.

二、模版展示

創建一個新項目時用的模版,可以在這里選擇你需要加入的一些開源庫,項目創建后,模版會自動把已配置好的開源庫加入到項目中。

項目創建后,模版已附帶了兩個基類,BaseActivity和BaseFragment,基類的內容可自行修改。

Activity也是默認繼承了BaseActivity

build.gradle也自動添加上了我所選中的開源庫

三、模版編寫

一、模版目錄介紹

我們AndroidStudio也有自帶一些模版,比如:

模版地址在:AndroidStudio\android-studio\plugins\android\lib\templates\activities

這里的每個模版打開后就是以下的目錄。

root : 這個文件夾是存放模版需要生成的代碼以及資源

globals.xml.ftl : 這個是用于定義整個模版中的全局變量的,在其他文件中可以引用此文件夾的變量

recipe.xml.ftl : 這個文件是用于指定你需要生成的資源,代碼最終的目的地的,具體的下面說明

template.xml : 這個文件是用于定義創建這個模版的那個窗口的,之前我的窗口上不是有讓我們輸入類名,選擇要加入的庫嗎,這個文件就是定義那些多選框和編輯框的。

template_blank_activity.png : 這個就是創建模版時跟隨的那張圖片,你可以替換成其他圖片

二、文件具體說明

第一步:template.xml

此文件是用于定義創建模版的窗口的顯示樣式。

//parameter這個元素,
//id 可用于其他文件獲取此控件值時所用,
//Name 用于控件的名字
//type 用于規定此控件的輸入類型
//help 用于當點擊此控件時,給予的提示消息,其他的自己琢磨,我也不是很清楚
<?xml version="1.0"?>
<template
    format="5"
    revision="5"
    name="新建Activity"
    minApi="9"
    minBuildApi="14"
    description="新建Activity">
    <category value="Activity" />
    <formfactor value="Mobile" />

<!--類名三類: 第一類 是Activity 第二類 是Presenter 第三類 是View-->
<parameter
    id="activityClass"
    name="Activity類名"
    type="string"
    constraints="class|unique|nonempty"
    suggest="${layoutToActivity(layoutName)}"
    default="MainActivity" />

<parameter
    id="layoutName"
    name="Activity布局文件名字"
    type="string"
    constraints="layout|unique|nonempty"
    suggest="${activityToLayout(activityClass)}"
    default="activity_main"
    help="這里可以輸入布局名字" />

<parameter
    id="packageName"
    name="包名"
    type="string"
    constraints="package"
    default="com.mycompany.myapp" />

<parameter
    id="isLauncher"
    name="啟動頁"
    type="boolean"
    default="false"
    help="If true, this activity will have a CATEGORY_LAUNCHER intent filter, making it visible in the launcher" />
<!-- 128x128 thumbnails relative to template.xml -->

<thumbs>
    <!-- default thumbnail is required -->
    <thumb>template_blank_activity.png</thumb>
</thumbs>

<globals file="globals.xml.ftl" />
<execute file="recipe.xml.ftl" />

</template> ipe.xml.ftl" />

</template></code></pre>

第二步:globals.xml.ftl

這個文件定義了整個模版總需要用的變量,其他文件都可以引用此文件中的變量進行操作

<?xml version="1.0"?>
<globals>
    <global id="hasNoActionBar" type="boolean" value="false" />
    <global id="parentActivityClass" value="" />
    <global id="simpleLayoutName" value="${layoutName}" /> //此變量引用了template.xml里面的布局文件名字
    <global id="excludeMenu" type="boolean" value="true" />
    <global id="generateActivityTitle" type="boolean" value="false" />
    <global id="activity" type="string" value="${activityClass}" /> //此變量引用了template,xml里面的類名
    <#include "../common/common_globals.xml.ftl" />
</globals>

第三步:root

root下面包含了需要生成的代碼或者資源,后綴都已 .ftl 結尾。

下面是需要生成的Activity類,包名用 ${packageName}指定,${}里面可以是globals.xml里面定義的變量也可以是template.xml中定義的id

package ${packageName};
import android.os.Bundle;
import android.support.annotation.Nullable;
import android.support.v7.app.AppCompatActivity;
import android.widget.Toast;

public class ${activity} extends AppCompatActivity {

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.${simpleLayoutName});
    Toast.makeText(getApplicationContext(), "我是一個模版Activity", Toast.LENGTH_SHORT).show();
}

}</code></pre>

第四步:recipe.xml.ftl

此文件中定義了生成的類,資源都該生成到項目中的哪個位置去,在此說明一下,比如下面這個,是把Activity生成到src文件夾下,但是如果你的src下有一個UI包,然后你是在Ui包上右擊創建了這個模版,他就會生成到src/Ui這個文件夾下,是相對的。

<instantiate from="root/src/app_package/SimpleActivity.java.ftl" to="${escapeXmlAttribute(srcOut)}/${activity}.java" />
<?xml version="1.0"?>
<recipe>

<dependency mavenUrl="com.android.support:support-v4:${targetApi}.+" /> //加入V4包到build.gradle中

<dependency mavenUrl="com.android.support:appcompat-v7:${targetApi}.+"/> //加入V7包到build.gradle中

<#include "../common/recipe_manifest.xml.ftl" /> //在清單文件中注冊此Activity

<instantiate from="root/src/app_package/SimpleActivity.java.ftl"
         to="${escapeXmlAttribute(srcOut)}/${activity}.java" /> //把生成的Activity生成到當前目錄下,生成的名字是用戶輸入的,${activity}定義在全局文件中。

<instantiate from="root/res/layout/activity_main.xml.ftl"
        to="${escapeXmlAttribute(resOut)}/layout/${simpleLayoutName}.xml" /> //布局文件生成到Res的layout文件夾中,生成的名字也是由用戶輸入

<open file="${escapeXmlAttribute(resOut)}/layout/${simpleLayoutName}.xml" /> //最后打開這個布局文件

<open file="${escapeXmlAttribute(srcOut)}/${activity}.java" /> //最后打開這個Activity

</recipe></code></pre>

三、創建模版

根據窗口輸入對應的值

最后創建出了這個模版

四、參考資料

https://github.com/kanytu/Android-studio-material-template

https://github.com/a371166028/android-studio-template

https://github.com/WanAndroid/AndroidStudioTemplates

https://www.zhihu.com/question/46979171

http://robusttechhouse.com/tutorial-how-to-create-custom-android-code-templates/

五、總結

學習模版的創建后,在以后的開發肯定會快很多的,把一些復雜的東西都可以做成模版,不至于每次都要去找資料再重新寫一遍,大家有時間可以嘗試一下,有問題也可以交流。

 

來自:http://www.jianshu.com/p/6928b04d533d

 

 本文由用戶 NikGoldsmit 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
 轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!