SpringSource Tool Suite (STS) 提供了“新建 Spring 模板项目”向导。使用此向导，用户可以查看许多项目模板，选择一个模板，然后让向导根据该模板描述创建一个完整的项目。虽然这为您提供了一种轻松创建新项目的方法，但您可能希望为您的团队或组织定义您自己的自定义项目模板。接下来我们将向您展示如何做到这一点。

步骤 1：为 STS 贡献新的资源扩展

STS 通过下载和读取资源 XML 文件来创建可用项目模板的列表。为了让 STS 知道这些资源文件位于何处，您需要通过扩展程序将其贡献给 STS。

因此，第一步是创建一个新的空插件项目。您不需要其中的 Java 代码，因此不要将其创建为 Java 项目。只需创建一个新的插件项目，在向导中取消选择 Java 选项即可。

现在在该插件项目中定义扩展。当您打开清单编辑器（双击META-INF/MANIFEST.MF）时，选择“扩展”选项卡，创建plugin.xml。您可以通过修改plugin.xml使其看起来像这样来定义扩展

<?xml version="1.0" encoding="UTF-8"?>
<?eclipse version="3.4"?>

<plugin>
   <extension point="com.springsource.sts.core.resources">
      <url
         id="content.descriptors"
         value="%content.descriptor.urls">
      </url>
   </extension>

</plugin>

这定义了对 STS 扩展点com.springsource.sts.core.resources的贡献，并使用您的新值覆盖content.descriptors ID 的默认值。此新值应包含您希望在 STS 向导中看到的所有模板的所有 URL。在本例中，我们不会直接在此处放置 URL，而是将其外部化到一个单独的属性文件中。这对于多个 URL 是必需的，您将会看到。

下一步是在您的插件中创建一个名为bundle.properties的属性文件，您应该将其放入名为OSGI-INF/I10n/的目录中。此属性文件应如下所示

content.descriptor.urls = http://dist.springsource.com/release...riptors.xml\n\
file:///Users/mlippert/template-contribution/descriptor.xml

如您所见，我将原始 STS 值放在其中以保持 STS 默认模板可用，并添加了我自己的 URL 到我的（在本例中为本地）descriptor.xml文件。因此，如果您只想使用本地文件，您可以继续使用此方法。如果您希望在公司范围内分发您的新模板，则将descriptor.xml文件作为 http 资源提供将很有意义。请注意，URL 用\n分隔。

现在您几乎完成了为 STS 创建的新插件。您可以导出它并将生成的 JAR 文件放入 STS 安装的dropins目录中。注意，build.properties已选中 META-INF、OSGI-INF 和plugin.xml以包含在二进制构建中。

(我为此附加了一个示例插件项目：template-contribution-plugin.zip)

步骤 2：构建descriptor.xml文件

您在上一步中添加到 STS 扩展的 URL 指向descriptor.xml文件。此文件应如下所示

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<descriptors>
   <descriptor id="org.test.mynewtemplate" kind="template" local="false" name="Mein neues Template" size="998877" url="file:///Users/mlippert/template-contribution/test-template-1.0.0.zip" version="1.0.0">
      <description>My brand new template contribution for this hacky stuff etc.</description>
   </descriptor>
</descriptors>

如您所见，我在其中添加了一些随机的示例，您应该将其替换为您自己的 ID。请选择

• 模板的自己的 ID（示例中的org.test.mynewtemplate）
• 模板的自己的名称（“Mein neues Template”），这将显示在向导列表中
• 指向模板 ZIP 文件的自己的 URL
• 不要忘记在side属性中设置 ZIP 文件的正确大小
• 描述：更多文本，告诉用户您的模板是关于什么的

步骤 3：构建实际模板

现在您需要创建我们从descriptor.xml文件中引用的 ZIP 文件。此 ZIP 文件的根目录中应包含三个文件：

• template.xml
• template.zip
• wizard.json

让我们看一下第一个文件，template.xml

<template>
   <descriptor id="org.test.mynewtemplate"
             name="Mein neues Template"
             kind="template"
             version="1.0.0">
      <description>My brand new template contribution for this hacky stuff</description>
   </descriptor>
   <project path="template.zip"/>
   <json path="wizard.json"/>
</template>

它包含与descriptor.xml相同的模板id、name和description，以及相同的version和类型template。除此之外，它还包含对template.zip文件和wizard.json文件的引用。因此，这是您定义这两个其他文件的地方。

wizard.json文件包含用于创建和处理此模板的向导 UI 的描述。在我的示例中，wizard.json文件如下所示

{
   "info" : {
      "elements" : {
         "element" : [
         {
            "name" : "topLevelPackage",
            "description" : "Please specify the top-level package e.g. com.mycompany.myapp",
            "type" : "java.lang.String",
            "page" : 0,
            "required" : true,
            "pattern" : "\\w+\\.\\w+(\\.\\w+)+",
            "replaceKind" : "topLevelPackage"
         }
         ]
      },

      "topLevelPackage" : "mytld.mycompany.myapp.mysubsystem",
      "projectName" : "projectName",

      "pages" : {
         "page" : [
         {
            "order" : 0,
            "description" : "Project Settings"
         }
         ]
      }
   }
}

我这里不详细介绍，但这基本上是向导 UI 的信息。它包含用户可以在向导中输入并用于创建实际项目（例如顶级包）的元素。

最后一部分是用户选择您的模板时想要实例化的实际项目。您需要做的就是自己创建项目并将顶级包命名为您在wizard.json中定义的方式（在本例中为mytld.mycompany.myapp.mysubsystem）。在我附加到此的示例中，模板项目位于名为template的根目录中，并包含

• .classpath
• .project
• .settings
• .springBeans
• pom.xml
• 包含项目布局和一些预定义源代码的 src 目录

这是一个示例：template-contribution.zip。

就是这样！

请注意：将新模板的 zip 文件下载到 STS 后（在您从列表中选择并按回车键后会自动完成），STS 将在下一次重新使用下载的文件。因此，如果您更改模板，请注意设置较新的版本号。否则，STS 将不会选择您更改的版本。