Android Studio自定义页面模板
历史背景
随着Android原生环境的丰富多彩，诞生了很多的架构，比如我们熟悉的MVC、MVP、MVVM，还有MVI，然而使用这些架构不得已会新建很多类文件（项目结构会更加清晰），MVC我们会新建Activity/Fragment、Model、Controller、View的布局文件，MVP会新建Activity/Fragment、Model、Presenter、View的布局文件，MVVM会新建Activity/Fragment、Model、ViewModel、View的布局文件。随着我们项目页面越来越多，新建起文件来就会愈加觉得繁琐。
谷歌爸爸或许早就认识到了我们的耐心是有限的，从很早开始就为我们提供了创建Activivity/Fragment的项目模板，File -> New -> Activity/Fragment就会看到，瞬间热泪盈眶。。。。
可以看到谷歌提供了不少模板，下面来举个例子，看看怎么用这些模板。
File -> New -> Activity -> Empty Activity可以看到
Activity Name：即新建页面的名称。
Generate a Layout File：是否创建布局文件。
Layout Name：即新建布局文件的名称。
Laucher Activity：即是否运行这个Activity。
Package name：即新建页面所在的包名。
Source Language：即新建页面所使用的语言。
修改上述这些参数，然后点击Finish就可以看到AS已经在为我们创建Activity以及布局文件了，AndroidManifest.xml里也会有相应的声明添加进来。
自定义模板
谷歌提供的创建页面的模板在我们不使用架构的前提下是可以很方便的解决我们的问题的，但是如果我们使用了架构，而且是自己封装的框架，那么谷歌提供的模板就不是那么方便了，于是从5年前就有开发大佬开始为自己的框架提供页面生成模板，例如JessYanCoding的MvpArms，不仅为单一页面提供了模板，还为整个module的创建提供了模板，在这里为拥护开源精神默默付出的大佬们致敬。
依据MVPArmsTemplate创建页面的方式，只需要我们把自定义的模板放在AS安装目录\plugins\android\lib\templates\activities里，然后重启AS即可使用，这种方式在Android Studio版本4.0以下是没有问题的，然而随着AS版本的更新，AS安装目录里已经没有了对应的模板文件夹，也就不允许我们这样操作了。后来找Issue发现也有同学遇到了同样的问题，并且已经找到了解决方法AndroidStudio4.1 自定义模板。我也就顺其自然的去照葫芦画瓢，意外顺利的撸了一个框架模板，下面说一下具体步骤：
打开Template repository for creating plugins for IntelliJ Platform 点击绿色的#Use this template#按步骤在自己的github上创建模板。然后使用AndroidStudio 将模板下载到本地。
(截止到本文写的时间2021/11/29该模板版本是1.1.0 使用的IDE版本是2021.2.3，java环境：java11)
添加wizard-template.jar
在根目录里添加lib文件夹，并添加AndroidStudio安装目录里的wizard-template.jar，位于 /Applications/Android Studio.app/Contents/plugins/android/lib/目录下。
修改build.gradle.kts
在dependencies里添加wizard-template.jar的依赖
dependencies {
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.18.1")
compileOnly(files("lib/wizard-template.jar"))
}
修改gradle.properties
修改gradle.properties中的pluginGroup, pluginName_, platformPlugins, platformVersion。
pluginSinceBuild表示插件适配的最低版本，pluginUntilBuild表示插件适配的最高版本。
踩坑注意：pluginSinceBuild不是说想适配到哪个版本就可以适配的，跟对应Android Studio的JDK版本需保持一直，太低不支持。
# IntelliJ Platform Artifacts Repositories
# -> https://plugins.jetbrains.com/docs/intellij/intellij-artifacts.html
pluginGroup = me.soushin
pluginName = tin-mvvm
# SemVer format -> https://semver.org
pluginVersion = 1.0.71
# See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
# for insight into build numbers and IntelliJ Platform versions.
pluginSinceBuild = 201
pluginUntilBuild = 213.*
pluginVerifierIdeVersions = 2020.2.4, 2020.3.4, 2021.1
# IntelliJ Platform Properties -> https://github.com/JetBrains/gradle-intellij-plugin#intellij-platform-properties
platformType = IC
platformVersion = 2020.2.4
# Plugin Dependencies -> https://plugins.jetbrains.com/docs/intellij/plugin-dependencies.html
# Example: platformPlugins = com.intellij.java, com.jetbrains.php:203.4449.22
platformPlugins = java, com.intellij.java, org.jetbrains.android, android, org.jetbrains.kotlin
# Java language level used to compile sources and to generate the files for - Java 11 is required since 2020.3
javaVersion = 11
# Gradle Releases -> https://github.com/gradle/gradle/releases
gradleVersion = 7.3
# Opt-out flag for bundling Kotlin standard library.
# See https://plugins.jetbrains.com/docs/intellij/kotlin.html#kotlin-standard-library for details.
# suppress inspection "UnusedProperty"
kotlin.stdlib.default.dependency = false
修改MyProjectManagerListener
将默认的listeners的父包名，调整为自己想要的样子，例如me.soushin。修改MyProjectManagerListener。
internal class MyProjectManagerListener : ProjectManagerListener {
override fun projectOpened(project: Project) {
projectInstance = project
project.getService(MyProjectService::class.java)
}
override fun projectClosing(project: Project) {
projectInstance = null
super.projectClosing(project)
}
companion object {
var projectInstance: Project? = null
}
}
在src/main/kotlin里创建tinmvvm文件夹用于放置自定义模板
正式开始编写自定义模板，以Activity为例。
1. 实现WizardTemplateProvider
SamplePluginTemplateProviderImpl
package me.soushin.tinmvvm
import com.android.tools.idea.wizard.template.Template
import com.android.tools.idea.wizard.template.WizardTemplateProvider
import me.soushin.tinmvvm.activity.mvvmActivityTemplate
import me.soushin.tinmvvm.fragment.mvvmFragmentTemplate
class SamplePluginTemplateProviderImpl: WizardTemplateProvider() {
override fun getTemplates(): List = listOf(
mvvmActivityTemplate,
mvvmFragmentTemplate
)
}
2. 创建 mvvmActivityTemplate.kt.
这个文件是设置在创建Activity的时候，输入的信息，例如ActivityName，layoutName,packageName
mvvmActivityTemplate.kt
package me.soushin.tinmvvm.activity
import com.android.tools.idea.wizard.template.WizardUiContext
import com.android.tools.idea.wizard.template.template
import com.android.tools.idea.wizard.template.*
import com.android.tools.idea.wizard.template.impl.activities.common.MIN_API
import java.lang.StringBuilder
val mvvmActivityTemplate get() = template {
// revision = 1
name = "Tin MVVM Activity"
description = "适用于TinMVVM框架的Activity"
minApi = MIN_API
minApi = MIN_API
category = Category.Other
formFactor = FormFactor.Mobile
screens = listOf(WizardUiContext.ActivityGallery, WizardUiContext.MenuEntry, WizardUiContext.NewProject, WizardUiContext.NewModule)
val activityClass = stringParameter {
name = "Activity Name"
default = "Main"
help = "只输入名字，不要包含Activity"
constraints = listOf(Constraint.NONEMPTY)
}
val layoutName = stringParameter {
name = "Layout Name"
default = "activity_main"
help = "请输入布局的名字"
constraints = listOf(Constraint.LAYOUT, Constraint.UNIQUE, Constraint.NONEMPTY)
suggest = { activityToLayout(createLayoutName(activityClass.value)) }
}
val packageName = stringParameter {
name = "Package name"
visible = { !isNewModule }
default = "com.mycompany.myapp"
constraints = listOf(Constraint.PACKAGE)
suggest = { packageName }
}
val language= enumParameter {
name = "Source Language"
help = "请选择语言"
default = Language.Kotlin
}
widgets(
TextFieldWidget(activityClass),
TextFieldWidget(layoutName),
PackageNameWidget(packageName),
EnumWidget(language),
)
// thumb { File("logo.png") }
recipe = { data: TemplateData ->
mvvmActivityRecipe(
data as ModuleTemplateData,
activityClass.value,
layoutName.value,
packageName.value,
language.value,
)
}
}
fun createLayoutName(className:String):String{
val array=className.toCharArray()
val string= StringBuilder()
array.forEach {
if (it.isUpperCase()){
//第一个首字母大写的话 不加下划线
if (string.isNotEmpty()){
string.append("_")
}
string.append(it.toLowerCase())
}else {
string.append(it)
}
}
return string.toString()
}
3. 创建mvvmActivityRecipe.kt。
这个文件用于将创建的文件保存到文件夹中，例如Activity，布局文件等。原计划将Activity直接添加到AndroidManifest里，但是发现generateManifest有点问题，导致生成的插件不能使用，暂时去掉，只能手动添加了。
mvvmActivityRecipe.kt
package me.soushin.tinmvvm.activity
import com.android.tools.idea.wizard.template.Language
import com.android.tools.idea.wizard.template.ModuleTemplateData
import com.android.tools.idea.wizard.template.RecipeExecutor
import com.android.tools.idea.wizard.template.impl.activities.common.generateManifest
import me.soushin.tinmvvm.activity.src.app_package.ui.mvvmActivityJava
import me.soushin.tinmvvm.activity.src.app_package.ui.mvvmActivityKt
import me.soushin.tinmvvm.common.repository.mvvmRepositoryJava
import me.soushin.tinmvvm.common.repository.mvvmRepositoryKt
import me.soushin.tinmvvm.common.res.layout.mvvmXml
import me.soushin.tinmvvm.common.viewmodel.mvvmViewModelJava
import me.soushin.tinmvvm.common.viewmodel.mvvmViewModelKt
fun RecipeExecutor.mvvmActivityRecipe(
moduleData: ModuleTemplateData,
activityClass: String,
layoutName: String,
packageName: String,
language: Language
) {
val (projectData, srcOut, resOut) = moduleData
val ktOrJavaExt = language.extension//projectData.language.extension
generateManifest(
moduleData = moduleData,
activityClass = "${activityClass}Activity",
// activityTitle = activityClass,
packageName = "${packageName}.ui",
isLauncher = false,
hasNoActionBar = false,
generateActivityTitle = true,
// requireTheme = false,
// useMaterial2 = false
)
if (language == Language.Kotlin){
//applicationPackage
val mvvmActivity = mvvmActivityKt(projectData.applicationPackage, activityClass, layoutName, packageName)
// 保存Activity
save(mvvmActivity, srcOut.resolve("ui/${activityClass}Activity.${ktOrJavaExt}"))
// 保存xml
save(mvvmXml(packageName, activityClass), resOut.resolve("layout/${layoutName}.xml"))
// 保存viewmodel
save(mvvmViewModelKt(packageName, activityClass), srcOut.resolve("viewmodel/${activityClass}ViewModel.${ktOrJavaExt}"))
// 保存repository
save(mvvmRepositoryKt(packageName, activityClass), srcOut.resolve("repository/${activityClass}Repository.${ktOrJavaExt}"))
//保存model
// save(mvvmModel(packageName, activityClass), srcOut.resolve("model/${activityClass}Model.${ktOrJavaExt}"))
}else if (language == Language.Java){
//applicationPackage
val mvvmActivity = mvvmActivityJava(projectData.applicationPackage, activityClass, layoutName, packageName)
// 保存Activity
save(mvvmActivity, srcOut.resolve("ui/${activityClass}Activity.${ktOrJavaExt}"))
// 保存xml
save(mvvmXml(packageName, activityClass), resOut.resolve("layout/${layoutName}.xml"))
// 保存viewmodel
save(mvvmViewModelJava(packageName, activityClass), srcOut.resolve("viewmodel/${activityClass}ViewModel.${ktOrJavaExt}"))
// 保存repository
save(mvvmRepositoryJava(packageName, activityClass), srcOut.resolve("repository/${activityClass}Repository.${ktOrJavaExt}"))
//保存model
// save(mvvmModel(packageName, activityClass), srcOut.resolve("model/${activityClass}Model.${ktOrJavaExt}"))
}
}
4. 创建mvvmAcitivityKt。
这个文件用于创建Activity的模板代码，根据自己的情况，自行调整。
mvvmAcitivityKt.kt
package me.soushin.tinmvvm.activity.src.app_package.ui
fun mvvmActivityKt(
applicationPackage:String?,
activityClass:String,
layoutName:String,
packageName:String
)="""
package ${packageName}.ui
import android.os.Bundle
import ${applicationPackage}.BR
import ${applicationPackage}.R
import ${applicationPackage}.databinding.Activity${activityClass}Binding
import ${applicationPackage}.mvvm.viewmodel.${activityClass}ViewModel
import me.soushin.tinmvvm.base.DataBindingActivity
import me.soushin.tinmvvm.config.DataBindingConfig
class ${activityClass}Activity : DataBindingActivity() {
//配置当前页面的内容 各项参数都可为空
//BR.xxxxViewModel是kotlin-kapt插件默认生成的 对应xml文件里的xxxxViewModel
override fun getDataBindingConfig(): DataBindingConfig? {
return DataBindingConfig(layoutId = R.layout.${layoutName},variableId = BR.${activityClass}ViewModel,
vmClass = ${activityClass}ViewModel::class.java);
}
override fun initView(savedInstanceState:Bundle?) {
}
}
"""
5. 编写mvvmRepository。
这个文件是mvvm的repository层的代码。
mvvmRepository.kt
package me.soushin.tinmvvm.common.repository
fun mvvmRepositoryKt(
packageName:String,
clazz:String
)="""
package ${packageName}.repository
import me.soushin.tinmvvm.base.BaseRepository
class ${clazz}Repository :BaseRepository(){
}
"""
6. 编写mvvmViewModel。这个是mvvm的viewmodel层
mvvmViewModel.kt
package me.soushin.tinmvvm.common.viewmodel
fun mvvmViewModelKt(
packageName:String,
clazz:String
)="""
package ${packageName}.viewmodel
import android.app.Application
import me.soushin.tinmvvm.base.BaseViewModel
import ${packageName}.repository.${clazz}Repository
class ${clazz}ViewModel(application: Application) :
BaseViewModel<${clazz}Repository>(application,${clazz}Repository()) {
}
"""
7.编写mvvmActivityXml。这个文件是用于生成布局文件的
mvvmActivityXml.kt
package me.soushin.tinmvvm.common.res.layout
fun mvvmXml(
packageName: String,
fragmentClass: String
) = """
"""
8. 修改plugin.xml
1.添加org.jetbrains.android，org.jetbrains.kotlin，com.intellij.modules.java的依赖
2.修改applicationService和projectService的值
3.修改applicationListenersv中listener的值
4.添加wizardTemplateProvider为刚才添加的类
me.soushin.tin-mvvm
TinMVVM
soushin
org.jetbrains.android
org.jetbrains.kotlin
com.intellij.modules.java
com.intellij.modules.platform
生成jar文件
Gradle -> Tasks -> build -> jar双击，稍等几秒就可以在build -> lib 里看到打包后的插件。
然后在AS中 Plugins -> 右上角设置齿轮 -> Install Plugin from Disk… ->选择jar包 -> 安装后Apply -> 重启AS即可。如果插件编写有错误可在AS右下角Event Log里看到相应的错误信息修改即可。
目前我的框架模板已经适配至Android Studio Arctic Fox 203。
参考文档：
️ TinMvvm框架Android studio页面模板插件
️ 一键搭建 MVPArms 的官方架构, 让新手一秒即可开启 MVPArms 的世界, 免于项目繁琐配置的烦恼
️ A template for Android Studio to create MVPArms and MVPArt Page