设置 Eclipse

这一部分介绍了如何为开发基于 SpongeAPI 的插件,设置你的 Eclipse 工作目录,并 使用一些诸如 Maven 或 Gradle 的构建系统

备注

一个由 Mumfrey 创建的教程 展示了使用 Eclipse 设置 Sponge 插件开发环境的方式,同时,这一教程使用了 Buildship 和 ForgeGradle 的新特性。

Gradle

使用 Gradle 前的准备工作

备注

从 Eclipse 的 Neon 版本(于 2016 年 6 月 22 日发布)开始,Eclipse 已经集成了 Gradle 的支持。下面这些步骤只适用于旧版本。

你首先必须安装 Gradle Integration Plugin ,然后才能在 Eclipse 中使用 Gradle 。这只需要你在创建项目的时候去做这件事就可以了。

小技巧

通常情况下,你并不需要随这个 Eclipse 插件一起分发的 Spring 模块,所以你可以在安装的过程中取消勾选它们。

  • 打开 Eclipse

  • 点击 Help > Eclipse Marketplace

  • 搜索 Gradle Integration Plugin

  • 安装 Gradle Integration Plugin

创建你的项目

  • 打开 Eclipse

  • 点击 File > New > Other

  • 选中 Gradle > Gradle Project

  • 点击 Next

  • 输入项目的名称,然后点击 Finish

编辑构建脚本

  • 在 Navigator 中打开 build.gradle

  • 可以根据 设置 Gradle 的内容编辑构建脚本。

  • 右键点击你的项目,并选择 Gradle > Refresh Gradle Project

导入你的项目

如果你已经开始你的项目开发工作了,而且想要稍后在 IDE 中打开它,那么你需要去直接导入它而不是在 IDE 中再次创建。

  • 点击 File > Import

  • 选中 Gradle > Gradle Project

  • 定位至你的项目的根目录

  • 点击 Finish

Maven

创建你的项目

  • 打开 Eclipse

  • 点击 File > New > Other

  • 在左侧边栏选中 Maven ,然后在右侧边栏选中 Maven Project

  • 点击 Next

  • 选中 Create a simple project ,除非你需要更高级的设置。

  • 输入你的 Group IDArtifact IDVersion , 项目名称,以及项目描述。

    • 你的 Group ID 通常应和你的 Java 包名相一致。详见 插件的主类

    • 你的 Artifact ID 通常应该和你的 plugin ID 一致,如 myplugin

    • 版本号由你来决定。参阅这里了解更多信息。

  • 点击 Finish

小技巧

Eclipse 经常不能在创建新的项目后打开它们。如果发生这种情况,请尝试先把 Eclipse 欢迎屏幕关掉,您的项目随后应该就可以开启。

修改项目配置

  • 在 Navigator 中打开 pom.xml

  • 可以根据 设置 Maven 的内容编辑构建配置。

  • 刷新你的 Maven 项目。

导入你的项目

如果你已经开始你的项目开发工作了,而且想要稍后在 IDE 中打开它,那么你需要去直接导入它而不是在 IDE 中再次创建。

  • 点击 File > Import

  • 选中 Maven > Existing Maven Projects

  • 定位至你的项目的根目录

  • 点击 Finish

Git 集成

Ecipse Foundation 提供了 EGit 插件的使用文档:

https://www.eclipse.org/egit/documentation/