1. 簡(jiǎn)介
- Jetbrains 提供了3種插件創(chuàng)建的方式
- Using GitHub Template
- Using Gradle
- Using DevKit
本文選擇第一種方案實(shí)現(xiàn)
代碼地址：https://github.com/sxfxwlh/hw_as_plugins
AS插件開發(fā)文檔：https://plugins.jetbrains.com/docs/intellij/android-studio.html
2. 模板項(xiàng)目搭建和環(huán)境配置
2.1 獲取模板項(xiàng)目
首先來(lái)到JetBrains的GitHub倉(cāng)庫(kù)，根據(jù)readme.md引導(dǎo)進(jìn)行操作,獲取到官方提供的template項(xiàng)目恬惯。
2.2 在本地運(yùn)行起來(lái)獲取到的項(xiàng)目
2.2.1 用AS在本地獲取并打開自己fork到的項(xiàng)目参咙。
2.2.2 修改配置文件狂秦，添加依賴
- 修改文件
settings.gradle.kts中的變量rootProject.name = "自定義插件名字" - 修改文件
gradle.properties中的變量
pluginGroup = com.hw
pluginName = hw_child
pluginVersion = 1.0.0
platformPlugins = android
- 修改src/main/resources/META_INF/plugin.xml文件拉鹃，增加以下依賴
<depends>org.jetbrains.android</depends>
<depends>com.intellij.modules.androidstudio</depends>
- 拷貝AndroidStudio安裝目錄下模板jar包到項(xiàng)目根目錄下的lib下麻顶，jar包文件路徑：
/Applications/Android Studio.app/Contents/plugins/android/lib/wizard-template.jar， 同時(shí)添加依賴到build.gradle.kts文件最底部崖咨，Sync Now
dependencies {
compileOnly(files("lib/wizard-template.jar"))
}
2.2.3 注冊(cè)插件入口
在src/main/kotlin下新建other包,新建kotlin-class WizardTemplateProviderImpl繼承自WizardTemplateProvider，實(shí)現(xiàn)抽象方法如下击蹲，
override fun getTemplates(): List<Template> = listOf(
//自定義模板就添加在此處
)
注冊(cè)插件到plugin.xml中署拟，如下
<!-- android-plugins.xml文檔地址如下 -->
<!-- https://plugins.jetbrains.com/docs/intellij/extension-point-list.html#android-plugin-->
<!-- <extensions defaultExtensionNs="com.android.tools.idea.wizard.template">-->
<!-- <wizardTemplateProvider implementation="com.android.tools.idea.wizard.template.impl.WizardTemplateProviderImpl" />-->
<!-- </extensions>-->
<extensions defaultExtensionNs="com.android.tools.idea.wizard.template">
<wizardTemplateProvider implementation="WizardTemplateProviderImpl" />
</extensions>
3. 模板基礎(chǔ)文件編寫
3.1 在src/main/kotlin目錄下新建包層級(jí)結(jié)構(gòu)如下
plugin-4.png
3.2 activity插件主要文件編寫
3.2.1 在activity/res/layout目錄下新建createActivityXml文件
package other.activity.res.layout
import java.lang.StringBuilder
/**
* @Author hubert
* @Date 2022/5/1 12:51 下午
*/
fun createActivityXml(
packageName: String,
activityClass: String
):String{
val sb = StringBuilder()
sb.append( """
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout
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"
android:orientation="vertical"
tools:context="${packageName}.${activityClass}Activity">
""")
if(hasNavigation){
sb.append("""
<com.necer.basic2.view.Navigation
android:id="@+id/navigation"
android:layout_width="match_parent"
android:layout_height="wrap_content"/>
""")
}
sb.append("""
</LinearLayout>
""")
return sb.toString().trim()
}
3.2.2 在activity/src/app_package目錄下新建createActivityKt文件
package other.activity.src.app_package
import java.lang.StringBuilder
/**
* @Author hubert
* @Date 2022/5/1 12:57 下午
*/
fun createActivityKt(
applicationPackage: String?,
packageName: String,
activityClass: String,
layoutName: String,
hasNavigation: Boolean
):String{
val sb = StringBuilder()
sb.append("""
package $packageName
import android.os.Bundle
import ${applicationPackage}.R
import com.necer.basic2.ui.BaseActivity
import kotlinx.android.synthetic.main.${layoutName}.*
class ${activityClass}Activity : BaseActivity() {
override fun getLayoutId()=R.layout.${layoutName}
override fun onCreatee(savedInstanceState: Bundle?) {
""")
if(hasNavigation){
sb.append("""
navigation.title("").left(true)
""")
}
sb.append("""
}
override fun getNetData() {
}
}
""")
return sb.toString()
}
3.2.3 在activity/src目錄下新建createActivityRecipe文件
package other.activity.src
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 other.activity.res.layout.createActivityXml
import other.activity.src.app_package.createActivityKt
/**
* @Author hubert
* @Date 2022/5/1 1:02 下午
*/
fun RecipeExecutor.createActivityRecipe(
moduleData: ModuleTemplateData,
packageName: String,
activityClass: String,
layoutName: String,
hasNavigation:Boolean
) {
val (projectData, srcOut, resOut) = moduleData
val ktOrJavaExt = projectData.language.extension
// generateManifest(moduleData: com.android.tools.idea.wizard.template.ModuleTemplateData, activityClass: kotlin.String, packageName: kotlin.String,
// isLauncher: kotlin.Boolean,
// hasNoActionBar: kotlin.Boolean,
// activityThemeName: kotlin.String /* = compiled code */,
// isNewModule: kotlin.Boolean /* = compiled code */,
// isLibrary: kotlin.Boolean /* = compiled code */,
// manifestOut: java.io.File /* = compiled code */,
// baseFeatureResOut: java.io.File /* = compiled code */,
// generateActivityTitle: kotlin.Boolean,
// isResizeable: kotlin.Boolean /* = compiled code */): kotlin.Unit { /* compiled code */
// }
generateManifest(
moduleData = moduleData,
activityClass = "${activityClass}Activity",
packageName = packageName,
isLauncher = false,
hasNoActionBar = false,
isNewModule = false,
isLibrary = false,
// manifestOut = ,
// baseFeatureResOut = ,
generateActivityTitle = false,
isResizeable = false,
)
val createActivity = createActivityKt(projectData.applicationPackage,packageName, activityClass, layoutName, hasNavigation)
// 保存Activity
save(createActivity, srcOut.resolve("${activityClass}Activity.${ktOrJavaExt}"))
// 保存xml
save(createActivityXml(packageName, activityClass,hasNavigation), resOut.resolve("layout/${layoutName}.xml"))
}
3.2.4 在activity/src目錄下新建createActivityTemplate文件
package other.activity.src
import com.android.tools.idea.wizard.template.*
import com.android.tools.idea.wizard.template.impl.activities.common.MIN_API
import java.io.File
/**
* @Author hubert
* @Date 2022/5/1 1:42 下午
*/
val createActivityTemplate
get() = template {
name = "Child Activity"
description = "繼承自BaseActivity的Activity"
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 = "請(qǐng)輸入布局的名字"
constraints = listOf(Constraint.LAYOUT,Constraint.UNIQUE,Constraint.NONEMPTY)
suggest = { activityToLayout(activityClass.value.toLowerCase()) }
}
val hasNavigation = booleanParameter {
name = "Has a Navigation"
default = true
help = "若勾選，自動(dòng)添加導(dǎo)航欄"
}
val packageName = stringParameter {
name = "Package name"
visible = { !isNewModule }
default = "com.hw.lzjr"
constraints = listOf(Constraint.PACKAGE)
suggest = { packageName }
}
widgets(
TextFieldWidget(activityClass),
TextFieldWidget(layoutName),
CheckBoxWidget(hasNavigation),
PackageNameWidget(packageName)
)
recipe = { data:TemplateData ->
createActivityRecipe(
data as ModuleTemplateData,
packageName.value,
activityClass.value,
layoutName.value,
hasNavigation.value
)
}
thumb { File("images/template_child_activity.png") }
}
3.3 添加Activity模板到WizardTemplateProviderImpl
class WizardTemplateProviderImpl: WizardTemplateProvider() {
override fun getTemplates(): List<Template> = listOf(
//自定義模板就添加在此處
createActivityTemplate
)
}
4 生成插件馒铃，安裝使用
4.1 執(zhí)行g(shù)radle任務(wù)獲取插件
plugin-5.png
執(zhí)行Run Plugin 后骗露，在build/libs目錄下即可獲取生成的pluginhw-child-1.0.0.jar,如下圖
plugin-6.png
4.2 安裝插件
plugin-7.png
plugin-8.png
4.3 使用插件新建Activity
plugin-9.png
plugin-10.png
【注】 插件縮略圖展示為no_activity.png 未按照配置展示萧锉，原因不明。
- 聯(lián)系方式：微信賬號(hào)：sxfxwlh
