为 TFS 和 Eclipse 开发自定义注释签入策略
5.00/5 (5投票s)
本文将帮助你开发、测试和部署用于 Eclipse IDE 和 Microsoft TFS 的自定义注释签入策略。应该为注释签入策略开发编写插件。
引言
本文将向你展示如何为 Eclipse IDE 和 Microsoft TFS 实现自定义注释签入策略。应该为注释签入策略开发编写插件。该实现将分为 4 个部分进行解释：
- 环境配置，
- 插件开发，
- 插件测试，
- 部署
环境配置
步骤 1 可以帮助进行插件开发的 Eclipse 产品被称为 Eclipse for RCP/Plug-in Developers。 可以从 https://eclipse.org/downloads/packages/eclipse-rcp-and-rap-developers/lunasr1a 下载 IDE。
Microsoft Team Explorer Everywhere 插件可以帮助你与 Microsoft Team Foundation Server 和你的 Eclipse 集成。 在要使用的项目中，可以从 http://www.microsoft.com/en-us/download/details.aspx?id=40785 下载它。
下载 Microsoft Team Explorer Everywhere 插件后，转到 IDE 的帮助菜单，然后单击“安装新软件”，如图 1 所示。
图 1 – Eclipse 安装新软件
步骤 2 单击“添加”按钮，在“添加存储库”窗口中提供本地驱动器上的文件位置（对于下载的 Micorsoft Team Explorer Plugin 插件）。 在“名称”字段中输入任何名称，然后继续安装插件。 选择 TFSEclipsePlugin-UpdateSiteArchive-XXXXX 的路径。 图 2 显示了添加存储库。
图 2 – 添加存储库
步骤 3 要检查其是否正常工作，请转到 IDE 的“窗口”菜单，单击“打开透视图”，然后单击“其他”，如图 3 所示。
图 3 – 打开透视图
选择“Team Foundation Server 浏览”，如图 4 所示。
图 4 – Team Foundation Server 浏览
插件开发
步骤 4 从 IDE 创建新的插件开发项目，如图 5 和图 6 所示。
图 5 – 插件项目
图 6 – 创建插件项目
步骤 5 将 com.microsoft.tfs.checkingpolicies 作为依赖项添加到 Manifest.MF 文件，如图 7 所示。
图 7 – 添加依赖项
步骤 6 将 com.microsoft.tfs.checkinpolicies.checkinPolicy 作为扩展添加到插件项目的扩展中，如图 8 所示。
图 8 – 添加扩展
步骤 7 在插件的概述选项卡中，清除“激活器”和“当加载其一个类时激活此插件”字段，如图 9 所示。
图 9 – 清除激活器字段
步骤 8 在 src 文件夹中创建一个名为 CommentCheckinPolicy 的类。 导入 com.microsoft.tfs.core.checkinpolicies.PolicyBase 并从 PolicyBase 扩展该类。 添加未实现的方法，你的类将如图 10 所示。
图 10 – CommentCheckinPolicy 类
步骤 9 使用适当的参数（例如安装指南、解释等）创建策略类型，如图 11 所示。
图 11 – 创建策略类型
步骤 10 在 evaluate 方法中，获取 PedningCheckin 并通过 pendingcheckin 获取输入的注释。 检查注释是否有效，如果无效，则将其添加到 failures 数组并显示特殊的警告消息。 evaluate 方法应返回 PolicyFailure 数组。 图 12 显示了 Evaluate 方法。
图 12 – Evaluate 方法
步骤 11 edit 方法应返回 true，以在编辑后在策略菜单中显示该策略，如图 13 所示。
图 13 – Edit 方法
插件测试
步骤 12 你可以使用运行按钮运行插件项目，当出现新的 IDE 时，选择 Microsoft Team Explorer Everywhere 的设置菜单，如图 14 所示。
图 14 – Team Explorer Everywhere 设置
步骤 13 图 15 显示了设置菜单以及如何添加我们的注释策略。
图 15 – 添加签入策略
步骤 14 如果你在添加带有无效注释的策略后尝试签入，则会发生以下消息。
图 16 – 无效注释警告
部署
步骤 15 由于适用于 Eclipse 的 TFS 插件的签入策略只是 Eclipse 插件，因此可以使用它支持的任何方法将其部署到目标 IDE。
请按照以下步骤进行插件部署
1. 在“包资源管理器”中，右键单击示例插件项目，然后选择“导出”。
2. 在出现的对话框中，选择“插件开发” > “可部署插件和片段”作为目标，然后单击“下一步”。
3. 选择你喜欢的输出格式和名称，然后完成向导。
4. 将输出复制到目标 IDE 的 dropins 目录（或较旧的 Eclipse 版本的 plugins 目录）。
历史
2015 年 2 月 2 日：版本 1