这是一份全面 & 详细的Android Studio插件开发指南

801 阅读3分钟

前言

AndroidStudio有丰富的插件可以让开发者使用,很多开发者也想拥有一个自己的Android Studio插件;

但:

  • 网上教程较少 & 讲解不详细,看完还是没法快速完成一个Android Studio插件开发;
  • 不同版本的开发IDE会导致流程差异较大,网上几乎都是较旧的开发教程。

本文将用最新版本的IDE手把手教你如何实现一个Android Studio插件的开发。主要包括:

  1. 开发环境配置
  2. 插件开发
  3. 插件调试
  4. 插件打包
  5. 插件测试
  6. 插件发布

1. 开发环境配置

步骤1:安装最新版IntelliJ IDEA

此处采用2024版:IntelliJ IDEA 2024.1.3 进行说明

下载地址:www.jetbrains.com/zh-cn/idea/… 需要注意的是:区别于之前的版本,2024版IntelliJ IDEA开发插件具备较大区别

步骤2:下载创建插件项目的插件

区别于之前的版本,2024版需要下载一个插件(Plugin Devkit)才可进行插件开发。

安装完成后需先重启一下IDE

步骤3:通过插件创建项目

选择左边的IDE Plugin,填写必要信息即可。


2. 插件开发

经过上面的前期准备,我们正式进入了插件的开发工作中。此处我们关注下面三个地方:

  1. build.gradle.kts
  2. plugin.xml
  3. main里的资源文件

关注1:build.gradle.kts

与Android Studio中的build.gradle文件非常类似,此处仅说明常见需要配置的内容:(里面的配置都可以直接按需拷贝到你们的工程里。)

这里需要注意的是,构建配置intellij中的属性localPath不能和version同时使用,因为本地的Android Studio路径中已经有版本信息了。本地调试时跟上线配置是两个属性,大家可以按需拷贝。

// 语言配置
// 主要关心intellj跟kotlin的版本
plugins {
    id("java")
    id("org.jetbrains.kotlin.jvm") version "1.9.24"
    id("org.jetbrains.intellij") version "1.17.3"
}

// 插件依赖
// 此处主要给出一些kotlin常见依赖
dependencies {
    implementation(kotlin("stdlib"))
    implementation(kotlin("reflect"))
    implementation(fileTree(baseDir = "libs"))
}

// 构建配置
// 更多官网配置请看官网:https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html
intellij {
    // 参数介绍
    // 本地调试配置:如直接用androidStudio进行调试
    localPath.set("/Applications/Android Studio.app/Contents") // macOS 示例路径

    // 添加开发需要的依赖插件
    // 如添加 Android 插件
    plugins.set(listOf("org.jetbrains.android"))

    // 上线配置
    version.set("2024.1.3") // 代表构建该插件的IntelliJ 平台IDE的版本
    type.set("IC")


    // 最终配置:选择下面其中一个即可
    // 本地调试配置:如直接用androidStudio进行调试
    localPath.set("/Applications/Android Studio.app/Contents") // macOS 示例路径
    plugins.set(listOf("org.jetbrains.android")) // 添加 Android 插件

    // 上线配置
    version.set("2024.1.3") // 代表构建该插件的IntelliJ 平台IDE的版本
    type.set("IC")
    plugins.set(listOf("org.jetbrains.android"))

}

关注2:Plugin.xml

主要关于插件发布的一些信息。这里主要关注相关依赖(可直接拷贝使用)

<depends>com.intellij.modules.platform</depends>
<depends>com.intellij.modules.lang</depends>
 <depends>org.jetbrains.kotlin</depends>

在这里插入图片描述

关注3:main里的资源文件

  • 终于要开始真正的插件内容开发了;
  • 插件的开发称为:Action:右键main里的kotlin文件夹,按图示操作即可。

点击创建后,会:

  1. 创建一个新的文件(命名即刚刚填写的),里面即可进行你的插件内容开发;
  2. action配置:在plugin.xml里

3. 插件调试

当完成插件开发后,即可点击右上角进行插件调试


4. 插件打包

按照下图图示,即可获得一个插件的jar包。


5. 插件测试

  • 在Android Studio打开plugin配置,然后选择从本地安装插件(选择上一个步骤生成的.jar包)
  • 其实这个时候你已经可以在本地用起来了。

6. 插件发布

只要完成了远端发布,其他开发者就可以在应用市场搜索到你的插件了。

第一步:在jetbrains插件开发平台登录/注册账号,然后点击上传控件

地址:plugins.jetbrains.com/developers/…

第二步:上传刚刚打包好的jar包 & 填写相关信息,等待审核即可。


总结

至此,关于如何开发一个Android Studio插件讲解完毕。