在 NetBeans 平台中使用 Maven 的快速入门

查看 Maven 资源库

Maven 用于生成所有项目的工件均存储在本地 Maven 资源库中。如果某一工件被声明为项目依赖关系，则会将其从已注册的某个远程资源库下载到您的本地资源库中。

缺省情况下，已注册 NetBeans 资源库和一些常见的索引 Maven 资源库，并将它们列在资源库浏览器窗口中。NetBeans 资源库包含生成项目所需的大多数公共工件。您可以使用“Maven 资源库”浏览器查看本地和远程资源库的内容。您可以展开“本地库”节点以查看本地存在的工件。NetBeans 资源库节点下列出的工件可以添加为项目依赖关系，但并非所有这些工件都在本地存在。仅当这些工件被声明为项目依赖关系时，才会将其添加到“本地库”。

打开“Maven 资源库”浏览器：

• 从主菜单中选择“窗口”>“其他”>“Maven 资源库浏览器”。
  

当将光标置于某个工件上时，IDE 将显示包含其坐标的工具提示。在浏览器中双击工件的 JAR 文件，可以查看有关该工件的其他详细信息。

单击“Maven 资源库”浏览器工具栏上的“查找”按钮，或使用主工具栏中的“快速搜索”文本字段，可以搜索工件。

有关管理 Maven 类路径依赖关系和在 IDE 中使用 Maven 资源库的详细信息，请参见 Best Practices for Apache Maven in NetBeans 6.x（NetBeans 6.x 中 Apache Maven 的最佳做法）的Dependency Management（依赖关系管理）部分。

要观看使用工件查看器的演示，请参见处理 Maven 依赖关系截屏视频。

创建项目

请执行下列步骤，以使用“新建项目”向导创建 NetBeans 平台应用程序。

1. 选择“文件”>“新建项目”(Ctrl-Shift-N) 以打开“新建项目”向导。
2. 从 "Maven" 类别中选择“Maven NetBeans 应用程序”。单击“下一步”。
3. 在“项目名称”中键入 MavenPlatformWordApp 并设置“项目位置”。单击“完成”。
   

注意：如果这是您第一次使用 Maven 创建 NetBeans 平台应用程序，则创建项目可能会耗费一些时间，因为 IDE 需要从 NetBeans 资源库中下载所有必需的工件。

单击“完成”后，缺省情况下 IDE 会创建以下 Maven 项目类型。

• NetBeans 平台应用程序。此项目是平台应用程序的容器项目，它列出了要包含的模块和项目资源库的位置。此项目不包含任何源文件。IDE 在此项目的子目录中生成包含源文件和资源的模块。
• 基于 NetBeans 平台的应用程序。此项目指定编译应用程序所需的工件（源文件）。在此项目的 pom.xml 文件中，指定了必需的依赖关系（IDE 工件和模块工件）。如果展开“库”节点，可以看到 NetBeans 平台应用程序所需的库。
• 平台应用程序标记资源。此项目包含用于标记应用程序的资源。

对于所有 Maven 项目，pom.xml 文件 (POM) 都位于“项目”窗口中的“项目文件”节点下。如果查看 NetBeans 平台应用程序项目的 POM，可以看到由向导创建的其他两个模块已被列为该应用程序的模块。

<modules>
   <module>branding</module>
   <module>application</module>
</modules>

修改标记元素

标记模块用于指定在生成平台应用程序时所使用的标记资源。使用标记对话框，您可以方便地修改应用程序的标记属性，以更改其名称、闪屏和文本元素的值。

当通过原型创建 NetBeans 平台应用程序时，该应用程序的缺省名称便是应用程序的工件 Id。在本练习中，您将使用标记向导来修改应用程序的名称，并替换闪屏的缺省图像。

注意：IDE 需要首先生成标记模块，然后您才能修改标记资源。

1. 右键单击平台应用程序标记资源模块，然后选择“标记”。
2. 在“基本”标签中，将“应用程序标题”修改为 My Maven Platform Word App。
   
3. 单击“闪屏”标签，然后单击缺省闪屏图像旁边的“浏览”按钮以查找其他图像。单击“确定”。

您可以将下面的图像复制到本地系统，然后在标记对话框中将该图像指定为闪屏。

创建模块

在本练习中，您将在包含标记模块和应用程序模块的同一个目录中创建一个新模块项目。

1. 从主菜单选择“文件”>“新建项目”。
2. 从 "Maven" 类别中选择“Maven NetBeans 模块”。单击“下一步”。
3. 在“项目名称”中键入 MavenWordEngine。
4. 单击“浏览”，然后找到 MavenPlatformWordApp 目录作为“项目位置”。单击“完成”。

如果查看 MavenWordEngine 模块的 POM，则会看到该项目的 artifactId 为 MavenWordEngine。

<modelVersion>4.0.0</modelVersion>
<parent>
    <groupId>com.mycompany</groupId>
    <artifactId>MavenPlatformWordApp</artifactId>
    <version>1.0-SNAPSHOT</version>
</parent>
<groupId>com.mycompany</groupId>
<artifactId>MavenWordEngine</artifactId>
<packaging>nbm</packaging>
<version>1.0-SNAPSHOT</version>
<name>MavenWordEngine NetBeans Module</name>

要生成 NetBeans 模块，您需要使用 nbm-maven-plugin。如果查看该模块的 POM，可以看到 IDE 自动为 packaging 指定了 nbm，并将 nbm-maven-plugin 指定为生成插件。

<plugin>
   <groupId>org.codehaus.mojo</groupId>
   <artifactId>nbm-maven-plugin</artifactId>
   <version>3.2-SNAPSHOT</version>
   <extensions>true</extensions>
</plugin>

如果查看 NetBeans 平台应用程序的 POM，可以看到 MavenWordEngine 已被添加到应用程序的模块列表中。

<modules>
   <module>branding</module>
   <module>application</module>
   <module>MavenWordEngine</module>
</modules>

使模块成为 MavenPlatformWordApp 的依赖关系

在本练习中，您将通过在 POM 中添加依赖关系，将 MavenWordEngine 模块声明为基于 NetBeans 平台的应用程序的依赖关系。此应用程序的 POM 声明了以下依赖关系。

<dependencies>
    <dependency>
        <groupId>org.netbeans.cluster</groupId>
        <artifactId>platform</artifactId>
        <version>${netbeans.version}</version>
        <type>pom</type>
    </dependency>
    <dependency>
        <groupId>com.mycompany</groupId>
        <artifactId>branding</artifactId>
        <version>1.0-SNAPSHOT</version>
    </dependency>
</dependencies>

如果展开基于 NetBeans 平台的应用程序的“库”节点，可以看到其中包含对标记模块和其他一些库的依赖关系，这些库是生成应用程序所需的群集依赖关系。

您可以展开非类路径依赖关系列表以查看依赖关系的完整列表。

要在 POM 中添加依赖关系，您可以直接在编辑器中编辑 POM，也可以通过从“项目”窗口中打开“添加依赖关系”对话框进行添加。

1. 在“项目”窗口中展开 "MavenPlatformWordApp - NetBeans Platform based application"。
2. 右键单击“库”节点，然后选择“添加依赖关系”。
3. 单击“打开的项目”标签，然后选择 MavenWordEngine。单击“确定”。

注意：在 IDE 完成扫描和更新索引之后，新项目将出现在对话框中。

如果在“项目”窗口中展开 MavenPlatformWordApp 的“库”节点，可以看到 MavenWordEngine 现在已被列为依赖关系。

在模块中添加窗口组件

在本练习中，您将使用向导来将窗口组件添加到 MavenWordEngine 模块中。

1. 在“项目”窗口中右键单击 "MavenWordEngine NetBeans Module"，然后选择“新建”>“其他”以打开“新建文件”向导。
2. 在“模块开发”类别中选择“窗口”。单击“下一步”。
3. 在“窗口位置”下拉列表中，选择 "output"。单击“下一步”。
   
4. 在“类名前缀”字段中键入 Text。单击“完成”。

   向导会显示将创建和修改的文件列表。

单击“完成”后，可以在“项目”窗口中看到 IDE 在“源包”下面的 com.mycompany.mavenwordengine 中生成了 TextTopComponent.java 类。IDE 还在“其他源”下面的 com.mycompany.mavenwordengine 中生成了其他资源文件。在本练习中，您将仅编辑 TextTopComponent.java。

可以在“文件”窗口中查看项目的结构。要编译 Maven 项目，“源包”（“文件”窗口中的 src/main/java 目录）下只能放置源文件。其他资源（例如，XML 文件）需要置于“其他源”（“文件”窗口中的 src/main/resources 目录）下面。

修改窗口组件

在本练习中，您将在窗口组件中添加一个文本区域和一个按钮。然后，您将修改由按钮调用的方法，以将文本区域中的字母更改为大写字母。

1. 在编辑器中单击 TextTopComponent.java 的“设计”标签。
2. 将一个按钮和一个文本区域从“组件面板”拖放到窗口中。
3. 右键单击文本区域并选择“更改变量名称”，然后键入 text 作为名称。当通过代码访问该组件时，将使用此名称。
4. 将按钮的文本设置为 "Filter!"。
   
5. 在“设计”视图中双击 "Filter!" 按钮元素，以在源代码编辑器中打开该按钮的事件处理程序方法。当双击该按钮元素时，将会自动为其创建方法。
6. 修改方法的主体以添加下列代码。保存所做的更改。

   private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {
      String s = text.getText();
      s = s.toUpperCase();
      text.setText(s);
   }

   可以在编辑器中使用代码完成功能来帮助键入代码。

如果您希望测试应用程序是否可以正常运行，可以右键单击 "MavenPlatformWordApp - NetBeans Platform based application" 项目节点，然后选择“使用依赖关系生成”。

映射到“使用依赖关系生成”的缺省操作为使用 Reactor 插件生成项目。在使用 Reactor 插件生成项目时，首先将生成子项目的依赖关系，然后再生成包含项目。“输出”窗口将显示生成顺序。

还会在“输出”窗口中显示生成结果。

如果查看“项目”窗口，则会看到这些项目不再带有标记，因为所需依赖关系的工件此时在“本地资源库”的 "com.mycompany" 节点下可用。

要运行项目，请右键单击 "MavenPlatformWordApp - NetBeans Platform based application" 项目节点，然后选择“运行”。在应用程序启动后，您可以通过执行下列步骤来测试该应用程序。

1. 从平台应用程序的主菜单中选择 "Window" > "Text" 以打开 Text 窗口。
2. 在文本区域中键入一些小写字母，然后单击 "Filter!"。
3. 退出 Maven Platform Word App。

当单击 "Filter!" 时，您所键入的字母会被更改为大写并显示在文本区域中。

创建模块

在本练习中，您将执行下列步骤来创建 TextFilter 模块。

1. 选择“文件”>“新建项目”(Ctrl-Shift-N)。
2. 从 "Maven" 类别中选择“Maven NetBeans 模块”原型。单击“下一步”。
3. 在“项目名称”中键入 TextFilter。
4. 单击“浏览”以设置“项目位置”并找到 MavenPlatformWordApp 目录。单击“完成”。

单击“完成”后，IDE 会创建模块，并在“项目”窗口中打开 "TextFilter NetBeans Module" 模块项目。

IDE 会修改 POM 项目 "MavenPlatformWordApp - NetBeans Platform Application" 的 pom.xml，以将新模块添加到要在项目中包含的模块列表中。

<modules>
    <module>branding</module>
    <module>application</module>
    <module>MavenWordEngine</module>
    <module>TextFilter</module>
</modules>

创建模块后，您需要将该模块添加为应用程序的依赖关系。

将 TextFilter 模块添加为 MavenPlatformWordApp 的依赖关系

在本练习中，您要将 TextFilter 模块添加为 "MavenPlatformWordApp - NetBeans Platform based application" 的依赖关系。

1. 右键单击 "MavenPlatformWordApp - NetBeans Platform based application" 项目的“库”节点，然后选择“添加依赖关系”。
2. 在“添加依赖关系”对话框中，单击“打开的项目”标签。
3. 选择 "TextFilter NetBeans Module" 模块。单击“确定”。

单击“确定”后，IDE 会将该模块添加为项目的依赖关系。如果展开“库”节点，可以看到该模块已被添加到依赖关系列表中。在 "MavenPlatformWordApp - NetBeans Platform based application" 的 POM 中，可以看到 IDE 在 dependencies 元素中添加了以下代码行。

<dependency>
   <groupId>${project.groupId}</groupId>
   <artifactId>TextFilter</artifactId>
   <version>${project.version}</version>
</dependency>

在 TextFilter 模块中添加接口

在本练习中，您将在 TextFilter 模块中添加一个简单的接口。

1. 右键单击 "TextFilter NetBeans Module"，然后选择“新建”>“Java 接口”。
2. 在“类名”中键入 TextFilter。
3. 在“包”下拉列表中选择 "com.mycompany.textfilter"。单击“完成”。
4. 修改该类以添加下列代码。保存所做的更改。

package com.mycompany.textfilter;

public interface TextFilter {
    public String process(String s);
}

公开 TextFilter 模块

在本练习中，您将公开 com.mycompany.textfilter 包的内容，以便其他模块可以访问其方法。要将包声明为公共包，您需要在 POM 中修改 nbm-maven-plugin 的 configuration 元素，以指定将由插件作为公共包导出的包。您可以在编辑器中更改 POM，也可以通过在“项目属性”对话框中选择要公开的包来进行更改。

1. 右键单击 "TextFilter NetBeans Module"，然后选择“属性”。
2. 在“项目属性”对话框中选择“公共包”类别。
3. 选择 "com.mycompany.textfilter" 包。单击“确定”。

单击“确定”后，IDE 会修改项目 POM，从而修改 nbm-maven-plugin 工件的 configuration 元素以添加下列条目。

<publicPackages>
   <publicPackage>com.mycompany.textfilter</publicPackage>
</publicPackages>

现在，POM 包含以下条目。

<plugin>
    <groupId>org.codehaus.mojo</groupId>
    <artifactId>nbm-maven-plugin</artifactId>
    <version>3.2</version>
    <extensions>true</extensions>
    <configuration>
                    <publicPackages>
                        <publicPackage>com.mycompany.textfilter</publicPackage>
                    </publicPackages>

    </configuration>
</plugin>

有关详细信息，请参见 nbm-maven-plugin 清单。

创建模块

在本练习中，您将创建一个名为 MyFilter 的模块。要创建此模块，您需要执行与创建 TextFilter 模块相同的步骤。

1. 选择“文件”>“新建项目”(Ctrl-Shift-N)。
2. 从 "Maven" 类别中选择“Maven NetBeans 模块”。单击“下一步”。
3. 在“项目名称”中键入 MyFilter。
4. 单击“浏览”以设置“项目位置”并找到 MavenPlatformWordApp 目录。单击“完成”。
5. 将 MyFilter 模块添加为 "MavenPlatformWordApp - NetBeans Platform based application" 项目的依赖关系。

将 TextFilter 模块添加为依赖关系

在本练习中，您会将 TextFilter 模块添加为 MyFilter 模块的依赖关系。

1. 右键单击 MyFilter 项目的“库”节点，然后选择“添加依赖关系”。
2. 在“添加依赖关系”对话框中，单击“打开的项目”标签。
3. 选择 TextFilter 模块。单击“确定”。

修改 MyFilter 模块

在本练习中，您将添加一个 Java 类，该类仅包含一个名为 process 的方法，用于将字符串转换为大写字母。您还将指定该类实现 TextFilter 接口。您将使用 @ServiceProvider 标注来将 TextFilter 指定为将在编译时注册的服务。

1. 右键单击 MyFilter 模块，然后选择“新建”>“Java 类”。
2. 在“类名”中键入 UpperCaseFilter。
3. 在“包”下拉列表中选择 "com.mycompany.myfilter"。单击“完成”。
4. 修改该类以添加下列代码。保存所做的更改。

package com.mycompany.myfilter;

import com.mycompany.textfilter.TextFilter;
import org.openide.util.lookup.ServiceProvider;

@ServiceProvider(service=TextFilter.class)
public class UpperCaseFilter implements TextFilter {

    public String process(String s) {
        return s.toUpperCase();
    }
}

请注意是如何使用标注来指定服务提供器的。有关 @ServiceProvider 标注以及 ServiceLoader 机制在 JDK 6 中的行为的详细信息，请参见《实用程序 API》文档。

修改 MavenWordEngine 模块

在本练习中，您将修改 Text 窗口组件中的事件处理程序，以使用 lookup 来调用 TextFilter 接口并访问 MyFilter 中的方法。在事件处理程序中添加代码之前，您需要声明对 TextFilter 模块的依赖关系。

1. 右键单击 MavenWordEngine 模块的“库”节点，然后添加对 TextFilter 模块的依赖关系。
2. 展开 MavenWordEngine 模块的“源包”，然后在源代码编辑器中打开 TextTopComponent。
3. 修改 jButton1ActionPerformed 按钮处理程序方法以添加下列代码。保存所做的更改。

   private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {
       String s = text.getText();
       TextFilter filter = Lookup.getDefault().lookup(TextFilter.class);
       if (filter != null) {
           s = filter.process(s);
       }
       text.setText(s);
   }

可以使用代码完成功能来帮助您完成代码。

此时，可以检查您的应用程序是否可以正常运行。接下来，您将添加一个新的窗口组件，该组件会显示您使用过滤器处理过的文本的历史记录。

1. 选择“文件”>“新建项目”(Ctrl-Shift-N)。
2. 从 "Maven" 类别中选择“Maven NetBeans 模块”。单击“下一步”。
3. 在“项目名称”中键入 History。
4. 单击“浏览”以设置“项目位置”并找到 MavenPlatformWordApp 目录。单击“完成”。
5. 将 History 模块添加为 "MavenPlatformWordApp - NetBeans Platform based application" 项目的依赖关系。

在 History 模块中创建窗口组件

在本练习中，您将使用向导在模块中添加窗口组件。

1. 在“项目”窗口中右键单击 "History NetBeans Module"，然后选择“新建”>“其他”以打开“新建文件”对话框。
2. 在“模块开发”类别中选择“窗口”。单击“下一步”。
3. 在“窗口位置”下拉列表中选择 "editor"。单击“下一步”。
4. 在“类名前缀”字段中键入 History。单击“完成”。
   向导会显示将创建和修改的文件列表。

修改 History 窗口组件

现在，您将在窗口组件中添加一个文本区域元素，用于显示已过滤的字符串。

1. 在编辑器中单击 HistoryTopComponent.java 的“设计”标签。
2. 将一个文本区域从“组件面板”拖放到窗口中。
3. 右键单击文本区域并选择“更改变量名称”，然后键入 historyText 作为名称。
4. 在 HistoryTopComponent 的构造函数中添加 private 字段 result 和以下代码，以使其侦听当前活动窗口 String 类的 lookup 事件，并在文本区域中显示所有检索到的 String 对象。

         private Lookup.Result result;
   
         public HistoryTopComponent() {
             initComponents();
             ...
   
             result = org.openide.util.Utilities.actionsGlobalContext().lookupResult(String.class);
             result.addLookupListener(new LookupListener() {
                 public void resultChanged(LookupEvent e) {
                     historyText.setText(result.allInstances().toString());
                 }
             });
         }