为什么要写这个系列文章

后端

2023-04-04 14:27:33

IDEA插件开发：从初学者到专家

为什么要写这个系列文章？

作为一名程序员，我常常会遇到重复性的任务，因此萌生了开发IDEA插件的想法，希望能提升工作效率。然而，市面上现有的插件无法完全满足我的需求，我渴望挑战自己，学习新的知识和技能，于是决定自己动手开发。

在开发插件的过程中，我遇到了许多困难，但从中也学到了很多。因此，我想把这些经验分享给大家，帮助大家提高工作效率，并激发对编程的兴趣。

IDEA插件开发的基础知识

什么是IDEA插件？

IDEA插件是IDEA的扩展程序，可以添加新的功能或增强现有功能，提升开发效率和自定义体验。

插件开发包（SDK）

SDK是IDEA提供的工具，用于开发插件。它包含了开发所需的库和文档。

插件元数据

插件元数据是插件的配置文件，包括插件名称、版本、作者等基本信息。

插件类

插件类是插件的核心代码，用于实现插件的功能。

插件动作

插件动作是插件提供的功能入口，可以是菜单项、工具栏按钮、快捷键等。

IDEA插件开发的入门步骤

准备工作

安装IDEA插件开发包（SDK）。
创建一个插件项目。

编写插件类

编写插件功能代码。

编写插件元数据

填写插件的基本信息。

打包插件

将插件代码和元数据打包成JAR文件。

安装插件

将插件JAR文件安装到IDEA中。

测试插件

运行插件，验证功能是否正常。

深入IDEA插件开发

代码示例

以下代码示例演示了一个简单的IDEA插件，用于生成当前文件中的所有类的方法列表：

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.CommonDataKeys;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.fileTypes.FileType;
import com.intellij.openapi.fileTypes.StdFileTypes;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiTreeUtil;
import com.intellij.ui.awt.RelativePoint;
import com.intellij.ui.popup.PopupFactoryImpl;
import java.awt.Point;
import java.util.ArrayList;
import java.util.List;

public class GenerateMethodListAction extends AnAction {
    @Override
    public void actionPerformed(AnActionEvent event) {
        // 获取当前文件
        Project project = event.getData(CommonDataKeys.PROJECT);
        Editor editor = event.getData(CommonDataKeys.EDITOR);
        Document document = editor.getDocument();
        FileType fileType = document.getFileType();
        if (!StdFileTypes.JAVA.equals(fileType)) {
            return;
        }

        // 解析文件
        PsiFile file = PsiManager.getInstance(project).findFile(document.getPsiFile());
        List<PsiClass> classes = new ArrayList<>();
        for (PsiClass cls : PsiTreeUtil.getChildrenOfTypeAsList(file, PsiClass.class)) {
            classes.add(cls);
        }

        // 生成方法列表
        List<String> methodList = new ArrayList<>();
        for (PsiClass cls : classes) {
            for (PsiMethod method : cls.getAllMethods()) {
                methodList.add(String.format("%s%s", method.getName(), method.getParameterList().getText()));
            }
        }

        // 弹出方法列表
        Point point = editor.visualPositionToXY(editor.getCaretModel().getCurrentCaret().getVisualPosition());
        RelativePoint relativePoint = new RelativePoint(editor, point);
        PopupFactoryImpl.getInstance().createListPopup(methodList).show(relativePoint);
    }
}