android studio的自定义工程模板详解---让你开发神

作者: 五谷观精分道长 | 来源:发表于2016-10-26 14:17 被阅读6219次

前言

最近看到有关技术博客，发现了关于androidstudio的模板的有关文章，表示感兴趣。
参考资料:Android Studio自定义模板写页面竟然可以如此轻松
包括文中的引用部分。

关于自定义模板

在新建Activity的时候都有许多的模板供我们选择，大牛可以自定义模板，减少开发时候的重复工作。
比如这样:

图片来自鸿洋的csdn博客

其实模板不仅限于activity 包括图片自由布局文件 fragment service 以及一个类都可以制作成模板。

这里只想看下Activity模板:

模板制作学习

分为三个步骤:

分析系统模板
改写系统模板
自己创造模板

分析和改写系统模板

Activity的模板地址在AS的plugins\android\lib\templates\activities目录下:
比如我的电脑在
C:\Program Files\Android\Android Studio\plugins\android\lib\templates\activities

Login界面用的比较多，就从他开始吧。

点开文件夹，看到以下目录:

模板LoginActivity.png

下面来一一分析这些文件:

template.xml

这个是模板配置文件，打开可以看到:

<?xml version="1.0"?>
<template
    format="5"
    revision="6"
    name="Login Activity"
    description="Creates a new login activity, allowing users to optionally sign in with Google+ or enter an email address and password to log in to or register with your application."
    requireAppTheme="true"
    minApi="8"
    minBuildApi="14">

    <dependency name="android-support-v4" revision="8" />

    <category value="Activity" />
    <formfactor value="Mobile" />

    <parameter
        id="activityClass"
        name="Activity Name"
        type="string"
        constraints="class|unique|nonempty"
        default="LoginActivity"
        help="The name of the activity class to create" />

    <parameter
        id="layoutName"
        name="Layout Name"
        type="string"
        constraints="layout|unique|nonempty"
        suggest="${activityToLayout(activityClass)}"
        default="activity_login"
        help="The name of the layout to create for the activity" />

    <parameter
        id="activityTitle"
        name="Title"
        type="string"
        constraints="nonempty"
        default="Sign in"
        help="The name of the activity." />

    <parameter
        id="parentActivityClass"
        name="Hierarchical Parent"
        type="string"
        constraints="activity|exists|empty"
        default=""
        help="The hierarchical parent activity, used to provide a default implementation for the 'Up' button" />

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

    <thumbs>
        <thumb>template_login_activity.png</thumb>
    </thumbs>

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

</template>

最外面的template标签写的是基本的配置：包括模板名，描述，是否请求系统主题等等。我们可以将其修改为中文。

<template
    format="5"
    revision="6"
    name="登陆界面"
    description="创建一个新的登陆界面"
    requireAppTheme="true"
    minApi="8"
    minBuildApi="14">

parameter标签
参数，也就是要在创建的时候自己设置的东西。每一个 parameter标签对应一个参数。这些参数会显示在创建页面上。也修改为中文。

. id ：唯一标识，最终通过该属性的值，获取用户输入值（文本框内容，是否选中）
. name：界面上的类似label的提示语
. type : 输入值类型
. constraints：填写值的约束
. suggest：建议值，比如填写ActivityName的时候，会给出一个布局文件的建议值。
. default:默认值
. help:底部显示的提升语

<parameter
        id="activityClass"
        name="活动类名"
        type="string"
        constraints="class|unique|nonempty"
        default="LoginActivity"
        help="填写所创建的活动类的名称" />

    <parameter
        id="layoutName"
        name="布局文件名"
        type="string"
        constraints="layout|unique|nonempty"
        suggest="${activityToLayout(activityClass)}"
        default="activity_login"
        help="填写所创建的布局文件的名称" />

    <parameter
        id="activityTitle"
        name="标题栏标题"
        type="string"
        constraints="nonempty"
        default="Sign in"
        help="The name of the activity." />

    <parameter
        id="parentActivityClass"
        name="父活动类"
        type="string"
        constraints="activity|exists|empty"
        default=""
        help="配置父活动类，用于返回上一级按钮" />

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

3.thumbs
里面放置了样例图,可以尝试更换。
4.最后指定了两个引用文件

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

可以测试一下修改的效果:

my.gif

globals.xml.ftl和recipe.xml.ftl

在这之前先了解一下ftl结尾的文件是什么:

freemarker的文件一般以后缀ftl.
　　freemarker确实是不错的模版语言引擎，尤其是处理对象图很方便，处理xml也很方便，还支持xpath
　　FreeMarker 是一个模版引擎，一个基于文本的模板输出工具（生成任意的HTML表单代码）。它是一个Java package，面向Java程序员的class library。它本身并不是针对最终用户的应用，而是允许程序员将其嵌入到他们的产品中。
　　FreeMarker被设计用来生成HTML Web页面，特别是基于MVC（Model View Controller）模式的应用程序。使用 MVC 模式作为动态的WEB页面的想法，是为了分隔页面设计者 (HTML 设计者) 和程序员。.每个人做自己擅长的那一部分。设计者可以不通过程序员的改变或修改代码来改变网页的样子，因为应用逻辑(Java程序)和页面设计（FreeMarker 模版）是分开的。模板不会被复杂繁琐的程序框架所破坏。即使当一个项目的程序员和HIMTL页面的制作者是同一个人时，这种分隔也是很有用，因为这样有助于保持应用的清晰并易于维护。

不知道大家写过网页没有，不管是jsp还是asp还是asp.net
都会有这种在标签语言里面插入编程语言的方式，大概类似。

关于ftl的语法:

组成部分
一、整体结构
1、注释：<#--注释内容-->，不会输出。
2、文本：直接输出。
3、interpolation:由 ${var} 或 #{var} 限定，由计算值代替输出。
4、FTL标记
二、指令：
freemarker指令有两种：
1、预定义指令：引用方式为<#指令名称>
2、用户定义指令：引用方式为<@指令名称>，引用用户定义指令时须将#换为@。
注意：如果使用不存在的指令，FreeMarker不会使用模板输出，而是产生一个错误消息。
freemarker指令由FTL标记来引用，FTL标记和HTML标记类似，名字前加#来加以区分。如HTML标记的形式为<h1></h1>则FTL标记的形式是<#list>< /#list>（此处h1标记和list指令没有任何功能上的对应关系，只是做为说明使用一下）。
有三种FTL标记：
1)、开始标记：<#指令名称>
2)、结束标记：</#指令名称>
3)、空标记：<#指令名称/>
注意：

FTL会忽略标记之中的空格，但是，<#和指令与 </#和指令之间不能有空格。
FTL标记不能够交叉，必须合理嵌套。每个开始标记对应一个结束标记，层层嵌套。如：
<#list>
<li>
${数据}
<#if 变量>
<p>game over!</p>
</#if>
</li>
</#list>
注意事项：
1)、FTL对大小写敏感。所以使用的标记及interpolation要注意大小写。name与NAME就是不同的对象。<#list>是正确的标记，而<#List>则不是。
2)、interpolation只能在文本部分使用，不能位于FTL标记内。如<#if ${var}>是错误的，正确的方法是：<#if var>,而且此处var必须为布尔值。
3)、FTL标记不能位于另一个FTL标记内部，注释例外。注释可以位于标记及interpolation内部。

其实只要知道if即可以了，这里只用if来判断。

globals.xml.ftl

还要引入的依赖和包。
定义了全局变量，并引用了一个内置的通用globals.xml.ftl

<?xml version="1.0"?>
<globals>
    <global id="hasNoActionBar" type="boolean" value="false" />
    <global id="isLauncher" type="boolean" value="${isNewProject?string}" />
    <global id="includePermissionCheck" type="boolean" value="${(targetApi gte 23)?string}" />
    <global id="GenericStringArgument" type="string" value="<#if buildApi lt 19>String</#if>" />
    <#include "../common/common_globals.xml.ftl" />
</globals>

recipe.xml.ftl
指定资源文件的路径并相应的生成到我们的项目目录去：

<recipe>
   <#if appCompat && !(hasDependency('com.android.support:appcompat-v7'))>
       <dependency mavenUrl="com.android.support:appcompat-v7:${buildApi}.+" />
    </#if>

    <#if (buildApi gte 22) && appCompat && !(hasDependency('com.android.support:design'))>
        <dependency mavenUrl="com.android.support:design:${buildApi}.+" />
    </#if>

    <merge from="root/AndroidManifest.xml.ftl"
             to="${escapeXmlAttribute(manifestOut)}/AndroidManifest.xml" />

    <merge from="root/res/values/dimens.xml"
             to="${escapeXmlAttribute(resOut)}/values/dimens.xml" />

    <merge from="root/res/values/strings.xml.ftl"
             to="${escapeXmlAttribute(resOut)}/values/strings.xml" />

    <instantiate from="root/res/layout/activity_login.xml.ftl"
                   to="${escapeXmlAttribute(resOut)}/layout/${layoutName}.xml" />

    <instantiate from="root/src/app_package/LoginActivity.java.ftl"
                   to="${escapeXmlAttribute(srcOut)}/${activityClass}.java" />

    <open file="${escapeXmlAttribute(srcOut)}/${activityClass}.java" />

</recipe>

. copy :从root中copy文件到我们的目标目录，比如我们的模板Activity需要使用一些图标，那么可能就需要使用copy标签将这些图标拷贝到我们的项目对应文件夹。
. merge : 合并的意思，比如将我们使用到的strings.xml合并到我们的项目的stirngs.xml中
. instantiate : 和copy类似，但是可以看到上例试将ftl->java文件的，也就是说中间会通过一个步骤，将ftl中的变量都换成对应的值，那么完整的流程是ftl->freemarker process -> java。
. open:在代码生成后，打开指定的文件，比如我们新建一个Activity后，默认就会将该Activity打开。

那么整体的关系类似下图：

图片来源：http://www.slideshare.net/murphonic/custom-android-code-templates-15537501

这里只是指定了生成的路径的文件名，但是如何生成呢，这就要根据前面创建的选项来设置生成的目标文件。

root文件夹

里面都是加了ftl的java文件和XML文件，所以我们用if来判断生成的方式。
两个步骤:
取值--->判断-->生成

xml文件中：

配置文件:

<manifest xmlns:android="http://schemas.android.com/apk/res/android" >

    <!-- To auto-complete the email text field in the login form with the user's emails -->
    <uses-permission android:name="android.permission.GET_ACCOUNTS" />
    <uses-permission android:name="android.permission.READ_PROFILE" />
    <uses-permission android:name="android.permission.READ_CONTACTS" />

    <application>
        <activity android:name=".${activityClass}"
            <#if isNewProject>
            android:label="@string/app_name"
            <#else>
            android:label="@string/title_${simpleName}"
            </#if>
            <#if hasNoActionBar>
            android:theme="@style/${themeNameNoActionBar}"
            </#if>
            <#if buildApi gte 16 && parentActivityClass != "">android:parentActivityName="${parentActivityClass}"</#if>>
            <#if parentActivityClass != "">
            <meta-data android:name="android.support.PARENT_ACTIVITY"
                android:value="${parentActivityClass}" />
            </#if>
            <#if isLauncher && !(isLibraryProject!false)>
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
            </#if>
        </activity>
    </application>
</manifest>

获取值，包括设定值和全局变量:

设定值:activityClass获取，${activityClass}
全局变量:isNewProject,hasNoActionBar
if判断

<#if isNewProject>
 android:label="@string/app_name"
 <#else>
 android:label="@string/title_${simpleName}"
</#if>

java文件中

代码太长不贴
也是类似的方式:
比如包名引入package ${packageName};
判断：

<#if parentActivityClass != "">
 setupActionBar();
</#if>

最后系统根据这些东西来生成最终的文件:

流程大致可用下图说明：

图片来源：http://www.slideshare.net/murphonic/custom-android-code-templates-15537501

自己创造模板

分析改写已经完成了，下面开始创造

写个自己的登录界面

不用完全从头开始。我们就拿LoginActivity模板来写。

先写一个简单的登录系统:
像这样:

QQ截图20161026144605.png

把相应的文件复制到root目录下:
包括所用的资源文件和java文件.

template修改，添加3个东西，一个是否含有记住密码选项，一个是否含有注册选项，还有一个是标题。
都是bool类型:

<parameter
        id="titleString"
        name="标题名"
        type="string"
        constraints="nonempty"
        default="默认标题" />
    <parameter
        id="isRemember"
        name="是否含有记住密码"
        type="boolean"
        default="false"
        help="为真则添加一个checkbox在登录按钮上面" />
    <parameter
        id="isRegiste"
        name="是否含有注册选项"
        type="boolean"
        default="false"
        help="为真则添加一个注册按钮在登录按钮上面" />

java文件改写，我这里没有写很多逻辑，简单的引入包名就可以了。加上布局文件。

package ${packageName};

import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;

public class ${activityClass} extends ${superClass} {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.${layoutName});
    }
}

这里主要是layout文件要根据选项创建:

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context="com.example.administrator.demo.MainActivity"
    android:orientation="vertical"
    android:background="#cccccc"
    >


        <TextView
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:gravity="center"
            android:padding="10dp"
            android:text="${titleString}"
            android:textColor="#FF4500"
            android:textSize="40sp"
            android:typeface="monospace" />
        <EditText
            android:id="@+id/edt_name"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:background="@drawable/rounded_editview"
            android:drawableLeft="@drawable/ic_name"
            android:hint="输入用户名"
            android:textSize="30sp" />

        <View
            android:layout_width="match_parent"
            android:layout_height="20dp" />

        <EditText
            android:id="@+id/edt__"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:background="@drawable/rounded_editview"
            android:drawableLeft="@drawable/ic_pass"
            android:hint="输入密码"
            android:inputType="textPassword"
            android:textSize="30sp" />

            <#if isRemember>
        <CheckBox
            android:padding="20dp"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content"
            android:text="记住密码"
            android:textColor="#000079"
            android:textSize="20sp" />
            </#if>
            <#if isRegiste>
        <TextView
            android:textColor="#000079"
            android:padding="20dp"
            android:text="没有账号?点此注册"
            android:layout_width="wrap_content"
            android:layout_height="wrap_content" />
            </#if>
        <Button
            android:id="@+id/angry_btn"
            android:layout_width="match_parent"
            android:layout_height="wrap_content"
            android:background="@drawable/bg_edittext"
            android:shadowColor="#A89A7B"
            android:shadowDx="0"
            android:shadowDy="0"
            android:shadowRadius="5"
            android:text="登录"
            android:textColor="#ffffff"
            android:textSize="30sp" />

</LinearLayout>

最后检查recipe文件对应的名字和目录有没有问题以及生成方式。

<merge from="root/AndroidManifest.xml.ftl"
             to="${escapeXmlAttribute(manifestOut)}/AndroidManifest.xml" />


     <copy from="root/res/drawable/ic_password.png"
            to="${escapeXmlAttribute(resOut)}/drawable/ic_password.png" />
    <copy from="root/res/drawable/ic_user.png"
            to="${escapeXmlAttribute(resOut)}/drawable/ic_user.png" />
    <merge from="root/res/values/dimens.xml"
             to="${escapeXmlAttribute(resOut)}/values/dimens.xml" />

    <merge from="root/res/values/strings.xml.ftl"
             to="${escapeXmlAttribute(resOut)}/values/strings.xml" />

    <instantiate from="root/res/layout/activity_login.xml.ftl"
                   to="${escapeXmlAttribute(resOut)}/layout/${layoutName}.xml" />

    <instantiate from="root/src/app_package/MainActivity.java.ftl"
                   to="${escapeXmlAttribute(srcOut)}/${activityClass}.java" />

    <open file="${escapeXmlAttribute(srcOut)}/${activityClass}.java" />

主要是两个copy 就是复制文件到目录下，然后布局文件中就可以调用了。

测试:
这时候老板叫你开发一个登录页面，你只需要慢慢的泡一杯茶，然后点击几下鼠标。

1460513940727641.jpg

gif.gif

当然这是个简单的模板，不过各位学会了之后可以写一些符合自己需求的模板。

最后的总结

模板虽好，切勿滥用
写模板尽量写的通用一些。一些具体的东西还是要手写。
注意备份模板，重装系统的软件都会丢失模板。

我的开发工具用的是sublime2，理论上任何一个文本编辑器都可以，但是我有Notepad++会有格式上的报错。

附上本文中我写的模板，当然我也会继续开发好用的模板上传。
https://github.com/HuRuWo/Android-Studio-Template
放置到Android Studio\plugins\android\lib\templates\activities 目录下，重启as即可。

android studio的自定义工程模板详解---让你开发神

前言

关于自定义模板

模板制作学习

分析和改写系统模板

template.xml

globals.xml.ftl和recipe.xml.ftl

globals.xml.ftl

root文件夹

xml文件中：

java文件中

自己创造模板

写个自己的登录界面

推荐一些开源的模板地址

最后的总结

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android Dev

工具

Android技术知识

Android知识

程序员

Android开发经验谈

注释

android开发