AndroidStudio4.1 自定義模板的使用方法

更新時(shí)間：2021年01月21日 08:54:43 作者：億特博客

這篇文章主要介紹了AndroidStudio4.1 自定義模板的使用方法，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

AndroidStudio4.0之前，可以在template的文件夾里使用freemarker的自定義模板，可以在AndroidStudio的文件夾中，隨意的添加適合自己的自定義模板

但是從4.1版本開始提供新的方式，Geminio，用Kotlin的形式編寫新的template，而且需要使用插件的形式，才能使用自定義的模板，摸索了好幾天，終于解決了。

我的項(xiàng)目是使用MVVM的開發(fā)框架，每次在編寫一個(gè)新的頁(yè)面的時(shí)候，就需要新建四個(gè)文件Activity/Fragment, ViewModel, Repository, xml文件,寫的多了就會(huì)很煩。自從使用了自定義的模板以后，頭發(fā)掉得都少了。

開工！??！搞起?。。?/p>

準(zhǔn)備

開發(fā)工具 AndroidStudio4.1

模板基礎(chǔ)代碼配置

打開 https://github.com/JetBrains/intellij-platform-plugin-template，點(diǎn)擊綠色的#Use this template#,按步驟在自己的github上創(chuàng)建模板。

然后使用AndroidStudio 將模板下載到本地。

編碼

添加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.15.0")
  compileOnly(files("lib/wizard-template.jar"))
}

修改gradle.properties

修改gradle.properties中的pluginGroup, pluginName_, platformPlugins, platformVersion。

pluginGroup = com.bigaddemo.mvvm
pluginName_ = bigaddemo_MVVM
platformVersion = 2020.2
platformPlugins = java, com.intellij.java, org.jetbrains.android, android, org.jetbrains.kotlin

將默認(rèn)的listeners的父包名，調(diào)整為自己想要的樣子，例如com.company.app

修改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里創(chuàng)建other文件夾用于放置自定義模板

正式開始編寫自定義模板，以Activity為例。

1. 實(shí)現(xiàn)WizardTemplateProvider

SamplePluginTemplateProviderImpl

package other
import com.android.tools.idea.wizard.template.Template
import com.android.tools.idea.wizard.template.WizardTemplateProvider
import other.mvvm.activity.mvvmActivityTemplate
import other.mvvm.fragment.mvvmFragmentTemplate
class SamplePluginTemplateProviderImpl : WizardTemplateProvider() {

 override fun getTemplates(): List<Template> = listOf(
   // activity的模板
   mvvmActivityTemplate,
   // fragment的模板
   mvvmFragmentTemplate
 )
}

2. 創(chuàng)建 mvvmActivityTemplate.kt.

這個(gè)文件是設(shè)置在創(chuàng)建Activity的時(shí)候，輸入的信息，例如ActivityName，layoutName,packageName以及是否可以為為等

mvvmActivityTemplate.kt

package other
import com.android.tools.idea.wizard.template.Template
import com.android.tools.idea.wizard.template.WizardTemplateProvider
import other.mvvm.activity.mvvmActivityTemplate
import other.mvvm.fragment.mvvmFragmentTemplate
class SamplePluginTemplateProviderImpl : WizardTemplateProvider() {

 override fun getTemplates(): List<Template> = listOf(
   // activity的模板
   mvvmActivityTemplate,
   // fragment的模板
   mvvmFragmentTemplate
 )
}

3. 創(chuàng)建mvvmActivityRecipe.kt。

這個(gè)文件用于將創(chuàng)建的文件保存到文件夾中，例如Activity，布局文件等。原計(jì)劃將Activity直接添加到AndroidManifest里，但是發(fā)現(xiàn)generateManifest有點(diǎn)問(wèn)題，導(dǎo)致生成的插件不能使用，暫時(shí)去掉，只能手動(dòng)添加了。

mvvmActivityRecipe.kt

package other.mvvm.activity

import com.android.tools.idea.wizard.template.ModuleTemplateData
import com.android.tools.idea.wizard.template.RecipeExecutor
import other.mvvm.activity.res.layout.mvvmActivityXml
import other.mvvm.activity.src.app_package.mvvmAcitivityKt
import other.mvvm.activity.src.app_package.mvvmRepository
import other.mvvm.activity.src.app_package.mvvmViewModel


fun RecipeExecutor.mvvmActivityRecipe(
  moduleData: ModuleTemplateData,
  activityClass: String,
  layoutName: String,
  packageName: String
) {
 val (projectData, srcOut, resOut) = moduleData
 val ktOrJavaExt = projectData.language.extension
// generateManifest(
//   moduleData = moduleData,
//   activityClass = "${activityClass}Activity",
//   activityTitle = activityClass,
//   packageName = packageName,
//   isLauncher = false,
//   hasNoActionBar = false,
//   generateActivityTitle = true,
//   requireTheme = false,
//   useMaterial2 = false
// )

 val mvvmActivity = mvvmAcitivityKt(projectData.applicationPackage, activityClass, layoutName, packageName)
 // 保存Activity
 save(mvvmActivity, srcOut.resolve("${activityClass}Activity.${ktOrJavaExt}"))
 // 保存xml
 save(mvvmActivityXml(packageName, activityClass), resOut.resolve("layout/${layoutName}.xml"))
 // 保存viewmodel
 save(mvvmViewModel(packageName, activityClass), srcOut.resolve("${activityClass}ViewModel.${ktOrJavaExt}"))
 // 保存repository
 save(mvvmRepository(packageName, activityClass), srcOut.resolve("${activityClass}Repository.${ktOrJavaExt}"))
}

4. 創(chuàng)建mvvmAcitivityKt。

這個(gè)文件用于創(chuàng)建Activity的模板代碼，根據(jù)自己的情況，自行調(diào)整。

mvvmAcitivityKt.kt

package other.mvvm.activity.src.app_package

fun mvvmAcitivityKt(
  applicationPackage:String?,
  activityClass:String,
  layoutName:String,
  packageName:String
)="""
package ${packageName}
import android.os.Bundle
import com.bigademo.baselib.base.BaseActivity
import ${applicationPackage}.R
import ${applicationPackage}.BR;
import ${applicationPackage}.databinding.Activity${activityClass}Binding
class ${activityClass}Activity : BaseActivity<${activityClass}ViewModel, Activity${activityClass}Binding>() {
 override fun getContentView(): Int {
  return R.layout.${layoutName}
 }

 override fun init(savedInstanceState: Bundle?) {
  super.init(savedInstanceState)
  isShowTopBar = false
 }

 override fun initViewModel() {
  viewModel = ${activityClass}ViewModel()
 }
 /**
  *	監(jiān)聽數(shù)據(jù)的變化
  */
 override fun observe() {

 }
 
 /**
  * 控件的點(diǎn)擊事件
  */
 override fun onClick() {
 }

 override fun initData() {
  super.initData()
 }
 override fun initVariableId(): Int {
  TODO("Not yet implemented")
 }
 } 
"""

5. 編寫mvvmRepository。

這個(gè)文件是mvvm的repository層的代碼。

mvvmRepository.kt

package other.mvvm.activity.src.app_package

fun mvvmRepository(
  packageName:String,
  activityClass:String
)="""
package ${packageName}

import androidx.lifecycle.MutableLiveData
import com.shide.baselib.base.basemvvm.BaseRepository
import com.shide.baselib.base.basemvvm.BaseViewModel
import com.shide.baselib.net.exception.ShideApiException
import kotlinx.coroutines.CoroutineScope

class ${activityClass}Repository(
 baseViewModel: BaseViewModel,
 coroutineScope: CoroutineScope,
 errorLiveData: MutableLiveData<ShideApiException>
) : BaseRepository(baseViewModel, coroutineScope, errorLiveData) {
}
"""

6. 編寫mvvmViewModel。這個(gè)是mvvm的viewmodel層 mvvmViewModel.kt

package other.mvvm.activity.src.app_package
fun mvvmViewModel(
  packageName:String,
  activityClass:String
)="""
package ${packageName}
import androidx.lifecycle.viewModelScope
import com.bigademo.baselib.base.basemvvm.BaseViewModel
class ${activityClass}ViewModel : BaseViewModel() {
 private val repo by lazy { ${activityClass}Repository(this, viewModelScope, errorLiveData) }
} 
"""

7.編寫mvvmActivityXml。這個(gè)文件是用于生成布局文件的 mvvmActivityXml.kt

package other.mvvm.activity.res.layout

fun mvvmActivityXml(
  packageName: String,
  activityClass: String
) = """
<?xml version="1.0" encoding="utf-8"?>
<layout xmlns:android="http://schemas.android.com/apk/res/android">

 <data>

 </data>
 
 <androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
 xmlns:app="http://schemas.android.com/apk/res-auto"
 xmlns:tools="http://schemas.android.com/tools"
 android:layout_width="match_parent"
 android:layout_height="match_parent"
 tools:context="${packageName}.${activityClass}Activity">
</androidx.constraintlayout.widget.ConstraintLayout>
</layout>

8. 修改plugin.xml

添加org.jetbrains.android，org.jetbrains.kotlin，com.intellij.modules.java的依賴

修改applicationService和projectService的值

修改applicationListenersv中l(wèi)istener的值

添加wizardTemplateProvider為剛才添加的類

<idea-plugin>
 <id>com.bigaddemo.mvvm</id>
 <name>bigaddemo_MVVM</name>
 <vendor>bigademo</vendor>

 <!-- Product and plugin compatibility requirements -->
 <!-- https://www.jetbrains.org/intellij/sdk/docs/basics/getting_started/plugin_compatibility.html -->
 <depends>org.jetbrains.android</depends>
 <depends>org.jetbrains.kotlin</depends>
 <depends>com.intellij.modules.java</depends>
 <depends>com.intellij.modules.platform</depends>

 <extensions defaultExtensionNs="com.intellij">
 <applicationService serviceImplementation="com.bigaddemo.mvvm.services.MyApplicationService" />
 <projectService serviceImplementation="com.bigaddemo.mvvm.services.MyProjectService" />
 </extensions>

 <applicationListeners>
 <listener class="com.bigaddemo.mvvm.listeners.MyProjectManagerListener" topic="com.intellij.openapi.project.ProjectManagerListener" />
 </applicationListeners>

 <extensions defaultExtensionNs="com.android.tools.idea.wizard.template">
 <wizardTemplateProvider implementation="other.SamplePluginTemplateProviderImpl" />
 </extensions>
</idea-plugin>