使用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. 输入你的groupIdartifactId,点击Next

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

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

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

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

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

    <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.4</version> <configuration> <archive> <manifest> <mainClass>com.intellij.idea.plugin.hello.HelloWorldApplicationComponent</mainClass> <id>com.intellij</id> <name>hello-idea-plugin</name> <version>1.0-SNAPSHOT</version> </manifest> </archive> </configuration> </plugin> </plugins> </build>
  9. pom.xml文件中添加maven-assembly-pluginmaven-shade-plugin插件,以便能够将所有的依赖项打包到一个jar文件中:

    <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>3.3.0</version> <configuration> <archive> <manifest> <mainClass>com.intellij.idea.plugin.hello.HelloWorldApplicationComponent</mainClass> <id>com.intellij</id> <name>hello-idea-plugin</name> <version>1.0-SNAPSHOT</version> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> <executions> <execution> <id>make-assembly</id> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin>
         <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>
    
    </build>
  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插件项目的步骤。

相关推荐
10km25 分钟前
java:Apache Commons Configuration2占位符解析异常的正确解法:${prefix:name:-default}
java·apache·configuration2·变量插值·interpolation
customer0826 分钟前
【开源免费】基于SpringBoot+Vue.JS个人博客系统(JAVA毕业设计)
java·vue.js·spring boot·后端·开源
灰色人生qwer33 分钟前
SpringBoot 项目配置日志输出
java·spring boot·后端
2301_7930698243 分钟前
Spring Boot +SQL项目优化策略,GraphQL和SQL 区别,Spring JDBC 等原理辨析(万字长文+代码)
java·数据库·spring boot·sql·jdbc·orm
阿华的代码王国1 小时前
【从0做项目】Java搜索引擎(6)& 正则表达式鲨疯了&优化正文解析
java·后端·搜索引擎·正则表达式·java项目·从0到1做项目
服务端相声演员1 小时前
Oracle JDK、Open JDK zulu下载地址
java·开发语言
是姜姜啊!1 小时前
java连接redis
java·redis
hhw1991121 小时前
spring boot知识点5
java·数据库·spring boot
EQUINOX11 小时前
lab4 CSAPP:Cachelab
java·后端·spring
customer081 小时前
【开源免费】基于SpringBoot+Vue.JS打卡健康评测系统(JAVA毕业设计)
java·vue.js·spring boot·后端·开源