Android Studio自定义模板 写页面竟然可以如此轻松

前言

每次创建新的Android Studio工程时,都需要手动修改一些工程的配置,比如删除不必要的依赖、删掉Activity中不必要的代码 配置私有maven库的地址、增加公用的依赖库、修改.gitingore、关闭lint的严格检查、配置APK的输出路径等等;项目比较少还好,如果项目比较多,并且还不断有新人加入时,就可以考虑修改Android Studio默认的project和module模板,避免做无用功和口口相传。

工程模板路径

Android Studio的工程模板在安装目录的“\plugins\android\lib\templates\gradle-projects”文件夹下,这里面包含了导入工程模板、新建工程模板、新建module模板等。

Android Studio自定义模板 写页面竟然可以如此轻松_第1张图片

提醒

修改前一定要备份,避免修改模板后导致新建project和module异常的情况(亲身经历,出现这样的情况你会很烦躁的);

模板文件说明

NewAndroidProject模板

Android Studio自定义模板 写页面竟然可以如此轻松_第2张图片

NewAndroidModule模板

Android Studio自定义模板 写页面竟然可以如此轻松_第3张图片

修改Android Studio工程模板

对工程模板中的每个文件和文件夹有一定的了解后,就可以按照自己的意愿修改模板中的内容了,如何修改得根据自己的需求而定,举个栗子,修改module的build.gradle模板(Android Studio\plugins\android\lib\templates\gradle-projects\NewAndroidModule\root\build.gradle.ftl),通常我们不需要依赖单元测试,去掉对单元测试的依赖,屏蔽lint的严格检查、并配置好APK的输出路径:

<#if !(perModuleRepositories??) || perModuleRepositories>
buildscript {
    repositories {
        jcenter()
<#if mavenUrl != "mavenCentral">
        maven {
            url '${mavenUrl}'
        }
#if>
    }
    dependencies {
        classpath 'com.android.tools.build:gradle:${gradlePluginVersion}'
    }
}
#if>
<#if isLibraryProject?? && isLibraryProject>
apply plugin: 'com.android.library'
<#else>
apply plugin: 'com.android.application'
#if>
<#if !(perModuleRepositories??) || perModuleRepositories>

repositories {
        jcenter()
<#if mavenUrl != "mavenCentral">
        maven {
            url '${mavenUrl}'
        }
#if>
}
#if>

android {
    compileSdkVersion <#if buildApiString?matches("^\\d+$")>${buildApiString}<#else>'${buildApiString}'#if>
    buildToolsVersion "${buildToolsVersion}"

    defaultConfig {
    <#if isLibraryProject?? && isLibraryProject>
    <#else>
    applicationId "${packageName}"
    #if>
        minSdkVersion <#if minApi?matches("^\\d+$")>${minApi}<#else>'${minApi}'#if>
        targetSdkVersion <#if targetApiString?matches("^\\d+$")>${targetApiString}<#else>'${targetApiString}'#if>
        versionCode 1
        versionName "1.0"
    }
<#if javaVersion?? && (javaVersion != "1.6" && buildApi lt 21 || javaVersion != "1.7")>

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_${javaVersion?replace('.','_','i')}
        targetCompatibility JavaVersion.VERSION_${javaVersion?replace('.','_','i')}
    }
#if>
<#if enableProGuard>
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
#if>

    sourceSets {
        main {
            jniLibs.srcDirs = ['libs']
        }
    }
  
  // 屏蔽lint的严格检查
    lintOptions {
        abortOnError false
    }
}

dependencies {
    <#if dependencyList?? >
    <#list dependencyList as dependency>
    compile '${dependency}'
    #list>
    #if>
  // 在这里删掉对单元测试的依赖,如果需要依赖公用控件,直接在这里添加
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

repositories {
    flatDir() {
        dirs 'libs'
    }
}

// 删掉没有签名的APK文件,同时在这里也可以配置APK文件的输出路径
android.applicationVariants.all { variant ->
  variant.assemble.doLast {
    variant.outputs.each { output ->
        println "aligned " + output.outputFile
        println "unaligned " + output.packageApplication.outputFile

        File unaligned = output.packageApplication.outputFile;
        File aligned = output.outputFile
        if (!unaligned.getName().equalsIgnoreCase(aligned.getName())) {
            println "deleting " + unaligned.getName()
            unaligned.delete()
        }
    }
  }
}

http://www.tuicool.com/articles/VRBJneu


正文

1、概述

上一篇文章,已经初步对Android Studio的模板有了初步的介绍与使用,以及一些开源模板的推荐:

  • 神奇的Android Studio Template

本文将对如何编写Template,进行详细的介绍(以activity摸版为例)。

2、模板的文件结构

学习编写模板最好的方式呢,就是参考IDE中已经提供的最简单的模板,那么在Android Studio中最简单的activity模板就是:Empty Activity了,我们打开该模板文件,首先对文件结构有个直观的了解,如图:

Android Studio自定义模板 写页面竟然可以如此轻松_第4张图片

可以看到每个插件对应一个文件夹,文件夹包含

  • template.xml
  • globals.xml.ftl
  • recipe.xml.ftl
  • root文件夹 存放对应源码的ftl文件,以及资源文件
  • 效果缩略图

下面我们逐一对上述每个文件的作用就行介绍。

2.1 template.xml

打开该文件,发现其主要内容如下:


<template
    name="Empty Activity"
    minApi="7"
    minBuildApi="14"
    description="Creates a new empty activity">
    <category value="Activity" />
    <parameter
        id="activityClass"
        name="Activity Name"
        type="string"
        constraints="class|unique|nonempty"
        suggest="${layoutToActivity(layoutName)}"
        default="MainActivity"
        help="The name of the activity class to create" />

    <thumbs>
        
        <thumb>template_blank_activity.pngthumb>
    thumbs>

    <globals file="globals.xml.ftl" />
    <execute file="recipe.xml.ftl" />
template>
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25

其中