ubuntu phpstorm如何进行插件开发

Ubuntu 下 PhpStorm 插件开发实战指南

一 环境准备

• 安装 JDK 17（IntelliJ 平台插件开发推荐版本）：sudo apt update && sudo apt install openjdk-17-jdk，验证：java -version。
• 安装 IntelliJ IDEA Community Edition（用于创建与调试插件工程，PhpStorm 本体用于运行与验证插件）。
• 安装 Gradle（推荐）或 Maven，用于构建与依赖管理：sudo apt install gradle maven。
• 准备 Git：sudo apt install git。以上为在 Ubuntu 上进行插件开发的基础环境配置。

二 创建与配置项目

• 方式一 Gradle（推荐）
  1. 使用官方模板生成骨架：gradle init --type intellij-platform-plugin。
  2. 在 build.gradle 中配置 IntelliJ 平台与 PHP 插件依赖，示例：

     plugins {
       id("org.jetbrains.intellij") version "1.17.3"
     }
     intellij {
       version.set("2023.2")         // 目标平台版本
       type.set("IU")                // Ultimate 版；若用 Community 则为 "IC"
       plugins.set(listOf("com.jetbrains.php:232.8660.184")) // PHP 插件版本
     }
     tasks {
       runIde {                     // 快速启动沙箱 IDE 进行调试
         jvmArgs("-Xmx2048m")
       }
     }
     

  3. 同步项目后，Gradle 会自动下载 IntelliJ SDK 与 PHP 插件 依赖。
• 方式二 Maven（备选）
  1. 新建 Maven 项目，选择 IntelliJ Platform Plugin 原型（archetype）。
  2. 在 pom.xml 中配置 intellij-plugin 依赖与插件目标版本，使用 mvn package 构建。

三 编写第一个插件

• 创建动作类（菜单或工具栏入口）：

  package com.example.myplugin;
  
  import com.intellij.openapi.actionSystem.AnAction;
  import com.intellij.openapi.actionSystem.AnActionEvent;
  import com.intellij.openapi.ui.Messages;
  
  public class HelloAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent e) {
      Messages.showInfoMessage("Hello from PHPStorm Plugin!", "Greeting");
    }
  }
  

• 在 plugin.xml 注册动作（位于 src/main/resources/META-INF/plugin.xml）：

  <idea-plugin>
    <id>com.example.myplugin</id>
    <name>MyPhpStormPlugin</name>
    <version>1.0</version>
    <vendor email="you@example.com" url="https://example.com"/>
  
    <depends>com.intellij.modules.platform</depends>
    <depends>com.jetbrains.php</depends>
  
    <actions>
      <action id="HelloAction" class="com.example.myplugin.HelloAction"
              text="Say Hello" description="Show hello message">
        <add-to-group group-id="ToolsMenu" anchor="last"/>
      </action>
    </actions>
  </idea-plugin>
  

• 运行与调试：执行 Gradle 任务 runIde，将启动带有你插件的 沙箱 IDE；在菜单 Tools 中点击 Say Hello 验证。

四 调试与日志

• 断点调试：在 IDE 中给插件代码设置断点，运行 runIde 任务即可调试；如需远程调试 Gradle 构建过程，可使用：./gradlew runIde -Dorg.gradle.debug=true。
• 查看日志：沙箱 IDE 日志位于用户目录，例如：tail -f ~/.PhpStorm2023.2/system/log/idea.log（路径中的版本号请与你的 IDE 一致）。

五 打包与发布

• 打包：执行 ./gradlew buildPlugin（或 mvn package），产物为 ZIP 包，位于 build/distributions/ 或 target/ 目录。
• 本地安装测试：在 PhpStorm 中进入 File → Settings → Plugins → ⚙️ → Install Plugin from Disk，选择 ZIP 安装并重启 IDE。
• 发布到 JetBrains 插件库：准备好账号与令牌，在 Gradle 中配置并运行 publishPlugin 任务（详见官方发布指南）。