使用maven框架搭建一个IDEA插件项目

以下是使用 Maven 框架搭建 IDEA 插件项目的步骤:

  1. 打开 IDEA,点击 File -> New -> Project,选择 Maven。

  2. 在弹出的 New Project 窗口中,选择 Maven,然后选择 Create from archetype,找到 Maven 插件开发的 archetypes,选择 IntelliJ IDEA Plugin Archetype。

  3. 填写 GroupId、ArtifactId、Version 等基本信息,然后点击 Next。

  4. 在下一个窗口中,可以选择插件类型,如 Action、Tool Window、Inspection 等,选择合适的类型并填写信息,然后点击 Next。

  5. 在下一个窗口中,可以选择项目配置,如 JDK 版本、项目名称、包名等,填写好后点击 Next。

  6. 最后一步是确认信息,检查无误后点击 Finish,等待 IDEA 创建项目。

  7. 项目创建完毕后,可以在 pom.xml 文件中添加插件依赖,配置插件信息等。

现在,你已经成功搭建了一个 IDEA 插件项目,可以开始编写代码了。


步骤如下:

  1. 在IDEA中新建一个Maven项目,选择Create from archetype,选择org.jetbrains.intellij.idea-plugin,点击Next。

  2. 输入你的项目名称,点击Next。

  3. 输入你的groupId和artifactId,点击Next。

  4. 点击Finish,完成项目的创建。

  5. 在pom.xml文件中,添加需要的依赖。例如,如果你需要使用JUnit进行测试,则需要添加以下依赖:

    junit junit 4.12 test
  6. 在src/main目录下创建一个resources/META-INF/plugin.xml文件,这个文件包含了你的插件的配置信息。

  7. 在src/main目录下创建你的插件代码,在这里可以实现你需要的功能。

  8. 在pom.xml文件中添加maven-jar-plugin插件,以便能够生成插件文件:

    org.apache.maven.plugins maven-jar-plugin 2.4 com.intellij.idea.plugin.hello.HelloWorldApplicationComponent com.intellij hello-idea-plugin 1.0-SNAPSHOT
  9. 在pom.xml文件中添加maven-assembly-plugin和maven-shade-plugin插件,以便能够将所有的依赖项打包到一个jar文件中:

    org.apache.maven.plugins maven-assembly-plugin 3.3.0 com.intellij.idea.plugin.hello.HelloWorldApplicationComponent com.intellij hello-idea-plugin 1.0-SNAPSHOT jar-with-dependencies make-assembly package single
    复制代码
         <plugin>
             <groupId>org.apache.maven.plugins</groupId>
             <artifactId>maven-shade-plugin</artifactId>
             <version>2.4.3</version>
             <executions>
                 <execution>
                     <phase>package</phase>
                     <goals>
                         <goal>shade</goal>
                     </goals>
                     <configuration>
                         <artifactSet>
                             <includes>
                                 <include>*:*</include>
                             </includes>
                         </artifactSet>
                         <transformers>
                             <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                                 <mainClass>com.intellij.idea.plugin.hello.HelloWorldApplicationComponent</mainClass>
                             </transformer>
                         </transformers>
                     </configuration>
                 </execution>
             </executions>
         </plugin>
     </plugins>
  10. 执行mvn clean package命令,生成插件的jar文件。

  11. 在IDEA中选择File > Settings,选择Plugins,点击Install plugin from disk,选择你生成的插件的jar文件,点击OK。


搭建步骤如下:

  1. 创建一个Maven项目,选择idea-plugin-archetype作为项目模板。

    mvn archetype:generate
    -DarchetypeGroupId=org.apache.maven.archetypes
    -DarchetypeArtifactId=maven-archetype-quickstart
    -DarchetypeVersion=1.4
    -DgroupId=com.example
    -DartifactId=my-idea-plugin
    -DinteractiveMode=false
    -DarchetypeCatalog=local

  2. 修改pom.xml文件,添加以下插件依赖:

xml 复制代码
<dependencies>
    <!--添加依赖-->
    <dependency>
        <groupId>com.intellij</groupId>
        <artifactId>ideaIU</artifactId>
        <version>2019.3.4</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

<build>
    <plugins>
        <!--添加插件-->
        <plugin>
            <groupId>org.jetbrains.intellij</groupId>
            <artifactId>idea-plugin</artifactId>
            <version>0.4.17</version>
            <extensions>true</extensions>
            <configuration>
                <id>${project.artifactId}</id>
                <name>${project.name}</name>
                <description>${project.description}</description>
                <vendor>Email</vendor>
                <changeNotes>${project.version}</changeNotes>
                <productDescriptor>
                    <code>Java</code>
                    <since-build>201.0</since-build>
                    <until-build>201.*</until-build>
                </productDescriptor>
            </configuration>
        </plugin>
    </plugins>
</build>
  1. 在src/main目录下创建resources/META-INF/plugin.xml文件。

  2. 编写插件功能代码。

  3. 在IDEA中打开项目,右键点击pom.xml文件,选择Maven -> Generate Sources and Update Folders。

  4. 在IDEA中选择菜单栏中的Run -> Edit Configurations,然后点击左上角的"+"号,选择"Plugin"来创建一个新的运行配置。

  5. 点击运行按钮来启动插件。在启动后的IDEA中,可以看到插件已经成功安装并开始工作。

以上就是使用Maven框架搭建一个IDEA插件项目的步骤。

相关推荐
AI你一生一世22 分钟前
不止于时序存储:DolphinDB 如何成为 AI 时代的工业智能底座
java·人工智能·struts·时序数据库·工业智能·dolphindb·ai基础设施
云-缩影33 分钟前
拆解 AI 图像生成应用的后端架构:ECS、OSS 和大模型 API 怎么配合
java·spring boot·后端
瑞克-桑切斯1 小时前
7、MySQL 慢查询排查与优化实战指南
java·服务器·数据库
海的透彻5 小时前
dockerfile如何快速构建容器(java服务)
java·开发语言
code2cat5 小时前
Java工具篇之Gradle:用任务图组织构建与交付
java·开发语言·单元测试·gradle
后台模板学习6 小时前
大模型 Prompt 工程在电商订单系统中的踩坑记录
java·python·prompt
w_zero_one6 小时前
算法--构造
java·数据结构·算法
SL_staff6 小时前
制造业订单交付崩盘?用四层协同框架重建交付可信度(技术实践)
java·产品·全栈
SL_staff7 小时前
打破风控迭代死循环:用决策编排重构业务与技术协作链路
java·产品·全栈
Mikko78 小时前
Redis 连接数满了服务端有错误信息吗?连接数不增加却命令超时?6.2 实测连接池、超时与大 key 怎么判定
java·spring boot·redis·后端