RestfulTool 开源项目使用教程

RestfulTool 开源项目使用教程

1. 项目的目录结构及介绍

RestfulTool 项目的目录结构如下：

RestfulTool/
├── icons/
│   └── method/
│       ├── default/
│       └── cute/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── zys/
│   │   │           └── restful/
│   │   │               ├── action/
│   │   │               ├── constant/
│   │   │               ├── icon/
│   │   │               ├── service/
│   │   │               ├── toolwindow/
│   │   │               └── utils/
│   │   └── resources/
│   │       └── META-INF/
│   └── test/
│       └── java/
│           └── com/
│               └── zys/
│                   └── restful/
├── .gitignore
├── LICENSE
├── README.md
└── build.gradle

目录结构介绍

• icons/: 存放项目中使用的图标文件。
  • method/: 包含不同主题的图标文件夹。
    • default/: 默认主题的图标。
    • cute/: 可爱主题的图标。
• src/: 项目的源代码目录。
  • main/: 主代码目录。
    • java/: Java 源代码。
      • com/zys/restful/: 主要功能包。
        • action/: 动作相关类。
        • constant/: 常量定义。
        • icon/: 图标相关类。
        • service/: 服务相关类。
        • toolwindow/: 工具窗口相关类。
        • utils/: 工具类。
    • resources/: 资源文件。
      • META-INF/: 插件配置文件。
  • test/: 测试代码目录。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• build.gradle: 项目构建配置文件。

2. 项目的启动文件介绍

RestfulTool 项目的启动文件主要是插件的入口类，通常位于 src/main/java/com/zys/restful/ 目录下。具体文件名可能因版本更新而有所不同，但通常会包含 Plugin 或 Main 等关键词。

例如，假设启动文件名为 RestfulToolPlugin.java，其内容可能如下：

package com.zys.restful;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.project.Project;

public class RestfulToolPlugin extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        Project project = e.getProject();
        // 启动逻辑
    }
}

启动文件介绍

• RestfulToolPlugin.java: 插件的主入口类，负责初始化和启动插件的各项功能。

3. 项目的配置文件介绍

RestfulTool 项目的配置文件主要包括 build.gradle 和 META-INF/plugin.xml。

build.gradle

build.gradle 是 Gradle 构建工具的配置文件，用于配置项目的依赖、任务等。示例如下：

plugins {
    id 'java'
    id 'org.jetbrains.intellij' version '0.7.3'
}

group 'com.zys.restful'
version '1.0.0'

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'junit:junit:4.13.2'
}

intellij {
    version '2020.3'
    pluginName 'RestfulTool'
    updateSinceUntilBuild false
}

patchPluginXml {
    changeNotes """
      <ul>
        <li>初始版本发布</li>
      </ul>
    """
}

META-INF/plugin.xml

plugin.xml 是