android studio的自定义模板详解
DUUHos
8年前
<h2><strong>前言</strong></h2> <p>最近看到有关技术博客，发现了关于androidstudio的模板的有关文章，表示感兴趣。</p> <p>包括文中的引用部分。</p> <h2><strong>关于自定义模板</strong></h2> <p>在新建Activity的时候都有许多的模板供我们选择，大牛可以自定义模板，减少开发时候的重复工作。</p> <p>比如这样:</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/e058629ae21f5014a19d54032631165e.gif"></p> <p style="text-align: center;">图片来自鸿洋的csdn博客</p> <p>其实模板不仅限于activity 包括图片自由 布局文件 fragment service 以及一个类都可以制作成模板。</p> <p>这里只想看下Activity模板:</p> <h2><strong>模板制作学习</strong></h2> <p>分为三个步骤:</p> <ol> <li> <p>分析系统模板</p> </li> <li> <p>改写系统模板</p> </li> <li> <p>自己创造模板</p> </li> </ol> <h2><strong>分析和改写系统模板</strong></h2> <p>Activity的模板地址在AS的 plugins\android\lib\templates\activities 目录下:</p> <p>比如我的电脑在</p> <p>C:\Program Files\Android\Android Studio\plugins\android\lib\templates\activities</p> <p>Login界面用的比较多，就从他开始吧。</p> <p>点开文件夹，看到以下目录:</p> <p style="text-align:center"><img src="https://simg.open-open.com/show/2de58f6c4c890adebffe9724faf49039.png"></p> <p style="text-align:center">模板LoginActivity.png</p> <p>下面来一一分析这些文件:</p> <h3><strong>template.xml</strong></h3> <p>这个是模板配置文件，打开可以看到:</p> <pre> <code class="language-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></code></pre> <ol> <li>最外面的template标签写的是基本的配置：包括模板名，描述，是否请求系统主题等等。我们可以将其修改为中文。 <pre> <code class="language-xml"><template format="5" revision="6" name="登陆界面" description="创建一个新的登陆界面" requireAppTheme="true" minApi="8" minBuildApi="14"></code></pre> </li> <li>parameter标签<br> 参数，也就是要在创建的时候自己设置的东西。每一个 parameter标签对应一个参数。这些参数会显示在创建页面上。也修改为中文。 <p>. id ：唯一标识，最终通过该属性的值，获取用户输入值（文本框内容，是否选中）</p> <p>. name：界面上的类似label的提示语</p> <p>. type : 输入值类型</p> <p>. constraints：填写值的约束</p> <p>. suggest：建议值，比如填写ActivityName的时候，会给出一个布局文件的建议值。</p> <p>. default:默认值</p> <p>. help:底部显示的提升语</p> </li> </ol> <pre> <code class="language-xml"><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" /></code></pre> <p>3.thumbs</p> <p>里面放置了样例图,可以尝试更换。</p> <p>4.最后指定了两个引用文件</p> <pre> <code class="language-xml"><globals file="globals.xml.ftl" /> <execute file="recipe.xml.ftl" /></code></pre> <p>可以测试一下修改的效果:</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/ce5c003240dc802b78977d98bafdbdd3.gif"></p> <p style="text-align:center">my.gif</p> <h2><strong>globals.xml.ftl和recipe.xml.ftl</strong></h2> <p>在这之前先了解一下ftl结尾的文件是什么:</p> <p>freemarker的文件一般以后缀ftl.</p> <p>freemarker确实是不错的模版语言引擎，尤其是处理对象图很方便，处理xml也很方便，还支持xpath</p> <p>FreeMarker 是一个模版引擎，一个基于文本的模板输出工具（生成任意的HTML表单代码）。它是一个Java package，面向Java程序员的class library。它本身并不是针对最终用户的应用，而是允许程序员将其嵌入到他们的产品中。</p> <p>FreeMarker被设计用来生成HTML Web页面，特别是基于MVC（Model View Controller）模式的应用程序。使用 MVC 模式作为动态的WEB页面的想法，是为了分隔页面设计者 (HTML 设计者) 和程序员。.每个人做自己擅长的那一部分。设计者可以不通过程序员的改变或修改代码来改变网页的样子，因为应用逻辑(Java程序)和页面设计（FreeMarker 模版）是分开的。模板不会被复杂繁琐的程序框架所破坏。即使当一个项目的程序员和HIMTL页面的制作者是同一个人时，这种分隔也是很有用，因为这样有助于保持应用的清晰并易于维护。</p> <p>不知道大家写过网页没有，不管是jsp还是asp还是asp.net</p> <p>都会有这种在标签语言里面插入编程语言的方式，大概类似。</p> <p>关于ftl的语法:</p> <p>组成部分</p> <p>一、整体结构</p> <p>1、注释：<#--注释内容-->，不会输出。</p> <p>2、文本：直接输出。</p> <p>3、interpolation:由 ${var} 或 #{var} 限定，由计算值代替输出。</p> <p>4、FTL标记</p> <p>二、指令：</p> <p>freemarker指令有两种：</p> <p>1、预定义指令：引用方式为<#指令名称></p> <p>2、用户定义指令：引用方式为<@指令名称>，引用用户定义指令时须将#换为@。</p> <p>注意：如果使用不存在的指令，FreeMarker不会使用模板输出，而是产生一个错误消息。</p> <p>freemarker指令由FTL标记来引用，FTL标记和HTML标记类似，名字前加#来加 以区分。如HTML标记的形式为</p> <p>则FTL标记的形式是<#list>< /#list>（此处h1标记和list指令没有任何功能上的对应关系，只是做为说明使用一下）。</p> <p>有三种FTL标记：</p> <p>1)、开始标记：<#指令名称></p> <p>2)、结束标记：</#指令名称></p> <p>3)、空标记：<#指令名称/></p> <p>注意：</p> <p>1) FTL会忽略标记之中的空格，但是，<#和指令 与 </#和指令 之间不能有空格。</p> <p>2) FTL标记不能够交叉，必须合理嵌套。每个开始标记对应一个结束标记，层层嵌套。 如：</p> <p><#list></p> <ul> <li>${数据} <p><#if 变量></p> <p>game over!</p> <p></#if></p> </li> </ul> <p></#list></p> <p>注意事项：</p> <p>1)、FTL对大小写敏感。 所以使用的标记及interpolation要注意大小写。name与NAME就是不同的对象。<#list>是正确的标记，而<#List>则不是。</p> <p>2)、interpolation只能在文本部分使用，不能位于FTL标记内。如<#if ${var}>是错误的，正确的方法是：<#if var>,而且此处var必须为布尔值。</p> <p>3)、FTL标记不能位于另一个FTL标记内部，注释例外。注释可以位于标记及interpolation内部。</p> <p>其实只要知道if即可以了，这里只用if来判断。</p> <h3><strong>globals.xml.ftl</strong></h3> <p>定义了全局变量，并引用了一个内置的通用globals.xml.ftl</p> <pre> <code class="language-xml"><?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></code></pre> <p>recipe.xml.ftl</p> <p>指定资源文件的路径并相应的生成到我们的项目目录去：</p> <pre> <code class="language-xml"><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></code></pre> <p>. copy :从root中copy文件到我们的目标目录，比如我们的模板Activity需要使用一些图标，那么可能就需要使用copy标签将这些图标拷贝到我们的项目对应文件夹。</p> <p>. merge : 合并的意思，比如将我们使用到的strings.xml合并到我们的项目的stirngs.xml中</p> <p>. instantiate : 和copy类似，但是可以看到上例试将ftl->java文件的，也就是说中间会通过一个步骤，将ftl中的变量都换成对应的值，那么完整的流程是ftl->freemarker process -> java。</p> <p>. open:在代码生成后，打开指定的文件，比如我们新建一个Activity后，默认就会将该Activity打开。</p> <p>那么整体的关系类似下图：</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/af4902acc791341e917255e88451c7ae.png"></p> <p>这里只是指定了生成的路径的文件名，但是如何生成呢，这就要根据前面创建的选项来设置生成的目标文件。</p> <h2><strong>root文件夹</strong></h2> <p>里面都是加了ftl的java文件和XML文件，所以我们用if来判断生成的方式。</p> <p>两个步骤:</p> <p>取值--->判断-->生成</p> <h3><strong>xml文件中：</strong></h3> <p>配置文件:</p> <pre> <code class="language-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></code></pre> <p>获取值，包括设定值和全局变量:</p> <ol> <li>设定值:activityClass获取，${activityClass}<br> 全局变量:isNewProject,hasNoActionBar</li> </ol> <p>if判断</p> <pre> <code class="language-xml"><#if isNewProject> android:label="@string/app_name" <#else> android:label="@string/title_${simpleName}" </#if></code></pre> <h3><strong>java文件中</strong></h3> <p>代码太长不贴<br> 也是类似的方式:<br> 比如包名引入 package ${packageName};<br> 判断：</p> <pre> <code class="language-xml"><#if parentActivityClass != ""> setupActionBar(); </#if></code></pre> <p>最后系统根据这些东西来生成最终的文件:</p> <p>流程大致可用下图说明：</p> <p style="text-align: center;"><img src="https://simg.open-open.com/show/533b19b9d25d8277281ac533510d925f.png"></p> <h2><strong>自己创造模板</strong></h2> <p>分析改写已经完成了，下面开始创造</p> <h3><strong>写个自己的登录界面</strong></h3> <p>不用完全从头开始。我们就拿LoginActivity模板来写。</p> <p> </p> <p>来自：http://www.jianshu.com/p/c76facb61d69</p> <p> </p>