AndroidStudio4.1 自定義模板的使用方法
AndroidStudio4.0之前，可以在template的資料夾裡使用freemarker的自定義模板，可以在AndroidStudio的資料夾中，隨意的新增適合自己的自定義模板
但是從4.1版本開始提供新的方式，Geminio，用Kotlin的形式編寫新的template，而且需要使用外掛的形式，才能使用自定義的模板，摸索了好幾天，終於解決了。
我的專案是使用MVVM的開發框架，每次在編寫一個新的頁面的時候，就需要新建四個檔案Activity/Fragment,ViewModel,Repository,xml檔案,寫的多了就會很煩。自從使用了自定義的模板以後，頭髮掉得都少了。
開工！！！搞起！！！
準備
開發工具 AndroidStudio4.1
模板基礎程式碼配置
開啟 https://github.com/JetBrains/intellij-platform-plugin-template，點選綠色的#Use this template#,按步驟在自己的github上建立模板。
然後使用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
將預設的listeners的父包名，調整為自己想要的樣子，例如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裡建立other資料夾用於放置自定義模板
正式開始編寫自定義模板，以Activity為例。
1. 實現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. 建立 mvvmActivityTemplate.kt.
這個檔案是設定在建立Activity的時候，輸入的資訊，例如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. 建立mvvmActivityRecipe.kt。
這個檔案用於將建立的檔案儲存到資料夾中，例如Activity，佈局檔案等。 原計劃將Activity直接新增到AndroidManifest裡，但是發現generateManifest有點問題，導致生成的外掛不能使用，暫時去掉，只能手動添加了。
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,srcOut.resolve("${activityClass}ViewModel.${ktOrJavaExt}"))
// 儲存repository
save(mvvmRepository(packageName,srcOut.resolve("${activityClass}Repository.${ktOrJavaExt}"))
}
4. 建立mvvmAcitivityKt。
這個檔案用於建立Activity的模板程式碼，根據自己的情況，自行調整。
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()
}
/**
* 監聽資料的變化
*/
override fun observe() {
}
/**
* 控制元件的點選事件
*/
override fun onClick() {
}
override fun initData() {
super.initData()
}
override fun initVariableId(): Int {
TODO("Not yet implemented")
}
}
"""
5. 編寫mvvmRepository。
這個檔案是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。這個是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。這個檔案是用於生成佈局檔案的 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中listener的值
新增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>
生成jar檔案
在AS最上面選擇執行 Run plugin ，成功以後即可在build/libs找見對應的jar檔案。最後在AS的設定裡將這個jar包新增的plugin，重啟AS即可。
到此這篇關於AndroidStudio4.1 自定義模板的使用方法的文章就介紹到這了,更多相關AndroidStudio4.1 自定義模板內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！