【goland插件开发】如何开发自己的goland插件

Goland是一个非常强大的Go语言开发工具，可以提供一系列的功能辅助开发和调试。除了自带的功能外，Goland还支持插件扩展。本文将介绍如何开发自己的Goland插件。

1. 准备工作

首先需要安装Goland，如果还没有安装可以去JetBrains官网下载并安装。

安装完成后需要配置Go环境，可以参照官方文档进行配置。

2. 创建插件项目

打开Goland，创建一个新的Project，选择"Go Plugin"作为项目类型。

选择好项目类型后，可以自己定义插件名称和插件ID，也可以使用默认值。

3. 插件结构

Goland插件项目的结构如下：

```
myplugin/
├── .idea/
├── .gitignore
├── myplugin.iml
├── src/
│   ├── main/
│   │   ├── go/
│   │   │   └── myplugin/
│   │   │       ├── MyPlugin.kt
│   │   │       ├── MyToolWindow.kt
│   │   │       ├── resources/
│   │   │       │   ├── MyToolWindow.form
│   │   │       │   └── myIcon.svg
│   │   │       ├── actions/
│   │   │       │   └── MyAction.kt
│   │   │       └── ui/
│   │   │           └── MyUI.kt
│   │   └── resources/
│   │        └── META-INF/
│   │             └── plugin.xml
│   └── test/
│        └── go/
│            └── myplugin/
│                ├── MyPluginTest.kt
│                └── utils/
│                    └── MyTestUtils.kt
└── build.gradle.kts
```

其中：

- `src`目录下是插件的源文件，包括插件的核心逻辑和UI代码。
- `resources`是资源文件，包括插件定义文件`plugin.xml`和一些UI设计文件。
- `test`目录下是插件测试代码。

4. 插件配置

插件的配置文件是`plugin.xml`，可以在该文件中配置插件的基本信息和UI设计。

一个简单的插件配置文件示例如下：

```

  myplugin
  My Plugin
  My awesome plugin
  1.0.0
  Me, myself and I

  
    
  

  
    
    resources/myIcon.svg
    
      
    
  

```

其中：

- `id`是插件的唯一标识符，`name`是插件名称，`description`是插件描述，`version`是插件版本号，`vendor`是插件作者信息。
- `actions`中定义插件在菜单中的显示位置，可以参考Goland提供的菜单ID。
- `tool-window`定义插件的工具窗口，包括窗口ID、窗口位置、窗口工厂类、窗口标题、窗口图标、窗口内容等。

5. 插件代码

插件代码部分包括核心逻辑和UI设计，下面以一个简单的插件为例，介绍插件的代码实现。

5.1. 核心逻辑

核心逻辑包括一个插件类和一个Action类。

插件类用于加载插件和管理插件资源，其中包含了插件的启动和停止方法。

```
class MyPlugin : BasePlugin() {
  private val logger = Logger.getInstance(this.javaClass)

  override fun start() {
    logger.info("My plugin started")
  }

  override fun stop() {
    logger.info("My plugin stopped")
  }
}
```

Action类是执行具体操作的类，示例代码如下：

```
class MyAction : AnAction() {
  override fun actionPerformed(e: AnActionEvent) {
    val project = e.project
    if (project != null) {
      val dialog = Messages.showMessageDialog(project, "Hello, world!", "My Plugin", Messages.getInformationIcon())
      logger.info("Dialog shown")
    }
  }
}
```

上述代码中，`actionPerformed`方法是Action执行的核心逻辑，通过弹出一个对话框展示一段提示信息。

5.2. UI设计

UI设计包括一个插件工具窗口和对应的类。

插件工具窗口类需要继承自`ToolWindowFactory`，并实现`createToolWindowContent`方法来创建窗口内容。

```
class MyToolWindowFactory : ToolWindowFactory {
  override fun createToolWindowContent(project: Project, toolWindow: ToolWindow) {
    val myUI = MyUI(project)
    val content = toolWindow.contentManager.factory.createContent(myUI.panel, null, false)
    toolWindow.contentManager.addContent(content)
  }
}
```

`MyUI`类负责UI的创建和相关操作。示例代码如下：

```
class MyUI(private val project: Project) {
  val panel = JPanel()

  init {
    panel.layout = BorderLayout()
    val label = JLabel("My Plugin")
    panel.add(label, BorderLayout.CENTER)
  }
}
```

上述代码中，`MyUI`类创建一个`JPanel`对象作为插件窗口的UI组件，并在窗口中添加了一个标签。

6. 调试和发布

完成插件代码编写后，可以使用Debug模式进行测试和调试，可以通过Goland调试工具进行断点调试和变量监控。

调试完成后，可以将插件打包成jar文件进行发布。可以使用Gradle或者Maven进行打包，也可以直接在Goland中使用"Build Plugin"进行打包。

打包完成后，可以在Goland中使用"Install Plugin from Disk"进行插件的安装和使用。

至此，我们已经完成了自己的Goland插件开发。