IntelliJ IDEA 插件开发：解析Java DTO对象并展示JSON字段信息

由 ChatGPT4o 使用 ChatGPT 4o 回答

问题：

如何新建一个idea的插件，实现对java中dto对象进行解析，解析其中的字段，字段类型，字段名称，字段注释，并使用json的格式进行展示到对话框中

回答：

要在 IntelliJ IDEA 中创建一个插件，实现对 Java 中 DTO 对象进行解析，并将字段信息以 JSON 格式展示在对话框中，你可以按照以下步骤进行：

1. 设置开发环境

首先，你需要设置开发环境以便开发 IntelliJ IDEA 插件。

  1. 安装 IntelliJ IDEA Ultimate 版本：插件开发需要使�� Ultimate 版本。
  2. 安装 IntelliJ IDEA Plugin SDK：在 IntelliJ IDEA 中，打开 File -> Project Structure -> SDKs，添加 IntelliJ IDEA Plugin SDK。

2. 创建插件项目

  1. 创建新项目：选择 File -> New -> Project，然后选择 IntelliJ Platform Plugin。
  2. 配置项目：填写项目名称、位置等信息。

3. 配置插件元数据

在 src/main/resources/META-INF 目录下创建 plugin.xml 文件，定义插件的元数据：

<idea-plugin>
    <id>com.example.dto.parser</id>
    <name>DTO Parser</name>
    <version>1.0.0</version>
    <vendor email="[email protected]" url="http://example.com">Your Name</vendor>

    <description>
        A plugin to parse DTO objects and display their fields in JSON format.
    </description>

    <depends>com.intellij.modules.platform</depends>

    <extensions defaultExtensionNs="com.intellij">
        <!-- Add your extensions here -->
    </extensions>

    <actions>
        <action id="DTOParserAction" class="com.example.dto.parser.DTOParserAction" text="Parse DTO" description="Parse DTO and show fields in JSON format">
            <add-to-group group-id="ToolsMenu" anchor="last"/>
        </action>
    </actions>
</idea-plugin>

4. 实现插件逻辑

创建一个新的 Java 类 DTOParserAction，实现解析逻辑和对话框展示。

package com.example.dto.parser;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.Messages;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiTreeUtil;
import org.jetbrains.annotations.NotNull;
import org.json.JSONObject;

public class DTOParserAction extends AnAction {

    @Override
    public void actionPerformed(@NotNull AnActionEvent event) {
        Project project = event.getProject();
        PsiFile psiFile = event.getData(CommonDataKeys.PSI_FILE);
        if (psiFile == null || project == null) {
            return;
        }

        PsiClass psiClass = PsiTreeUtil.findChildOfType(psiFile, PsiClass.class);
        if (psiClass == null) {
            Messages.showMessageDialog(project, "No class found in the file.", "Error", Messages.getErrorIcon());
            return;
        }

        JSONObject jsonObject = new JSONObject();
        for (PsiField field : psiClass.getAllFields()) {
            JSONObject fieldObject = new JSONObject();
            fieldObject.put("type", field.getType().getPresentableText());
            fieldObject.put("name", field.getName());
            PsiComment comment = PsiTreeUtil.findChildOfType(field, PsiComment.class);
            if (comment != null) {
                fieldObject.put("comment", comment.getText());
            }
            jsonObject.put(field.getName(), fieldObject);
        }

        Messages.showMessageDialog(project, jsonObject.toString(4), "DTO Fields", Messages.getInformationIcon());
    }
}

5. 运行和测试插件

  1. 运行插件：在 IntelliJ IDEA 中，选择 Run -> Edit Configurations，添加一个新的 Plugin 配置，然后运行该配置。
  2. 测试插件：在新的 IntelliJ IDEA 实例中，打开一个包含 DTO 类的 Java 文件，使用 Tools -> Parse DTO 菜单项来测试插件。

6. 打包和发布插件

  1. 打包插件：在 Build -> Prepare Plugin Module for Deployment 中打包插件。
  2. 发布插件：你可以将插件上传到 JetBrains 插件仓库，或者在本地共享。

通过以上步骤，你可以创建一个 IntelliJ IDEA 插件，实现对 Java 中 DTO 对象