.NET 客户端库使用入门

Jeff Fisher,Google 数据 API 团队
2007 年 8 月

简介

Google Data API 解决方案
图 1:Google Data API 解决方案

对于许多开发者来说,新项目的最难部分是让滚动式安装新的软件包、配置开发环境以及学习新的库。在本文中,我收集了一些分步说明,介绍如何使用 Visual Studio 2005(适用于 Windows)或 Mono(适用于 Linux 及其他 Unix 操作系统)开始使用 .NET 客户端库。我希望这可以节省一些时间,让您快速上手使用代码。

Visual Studio 2008

如果您尚未安装 Visual Studio 2008,可以考虑使用 Visual C# 2008 Express Edition,这是免费版 Visual Studio,可用于处理 .NET 客户端库。

设置您的环境

  1. http://code.google.com/p/google-WorkManager/downloads/list 下载客户端库的最新 MSI 版本。
  2. 运行下载的 MSI 文件以安装该软件包。该工具将默认安装到“C:\Program Files\Google\Google Data API SDK”。本文中的更多示例假设您将客户端库安装到此位置。
  3. 在“开始”菜单的“Google Data API SDK”文件夹中打开名为“Google Data API SDK”的解决方案文件。

编译和运行示例

  1. 验证“Build > Build Solution”运行是否完成,没有任何错误。
  2. 如需创建调试 build,请依次转到“Build > Configuration Manager”,然后选择“Debug”作为活跃的解决方案配置。然后,依次选择“Build > Build Solution”。
  3. 您刚刚编译的二进制文件和 DLL 文件可以在“C:\Program Files\Google\Google Data API SDK\Sources\Samples\" 例如,您可以通过执行“C:\Program Files\Google\Google Data SDK Sources\Samples\calendar\bin\Debug\Calendar.exe”来运行 Google 日历示例应用。这些示例还提供了一些“开始”菜单快捷方式。

开发您自己的应用

如果您要在 MSI 文件提供的解决方案文件之外的项目中进行开发,则需要将客户端库 DLL 文件添加为参考路径。

  1. 在 Google API SDK 解决方案之外创建或打开项目。
  2. 从“项目”菜单中选择“添加引用”。
  3. 点击“浏览”标签页。
  4. 前往 SDK 中的 Redist 目录:“C:\Program Files\Google\Google Data API SDK\Redist”。
  5. 选择要用于您的代码的 DLL 文件。大多数项目都需要用到 Google.GData.Extensions.dll 和 Google.GData.Client.dll 以及您在应用中使用的 Google 服务专用的 DLL 文件。

注意:我们还提供了一个适用于移动设备客户端库的解决方案文件。默认位于“C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile”。该解决方案只编译客户端库的 DLL 文件。

运行 NUnit 测试

如果您要对客户端库进行任何更改或计划为其贡献代码,请确保通过相应的 NUnit 测试。如果您计划不修改地使用客户端库,通常无需运行它们。

  1. http://www.nunit.org/index.php?p=download 下载 NUnit 的 .NET 2.0 MSI 文件版本。
  2. 通过运行 MSI 文件安装 NUnit。默认安装位置类似于“C:\Program Files\NUnit 2.4.8”。您可能希望将其更改为诸如“C:\Program Files\NUnit”之类的内容,以便将来升级 NUnit,而不必更改 Visual Studio 项目中的路径。
  3. 转到“C:\Program Files\Google\Google Data SDK Sources\Library\VS2005”目录,然后打开名为“Google Data API”的解决方案文件。 您会看到“转换向导”,因为这是一个 Visual Studio 2005 项目文件。您可以点击提示,也可以直接点击“Finish”(完成)按钮。其中应显示可忽略的转化日志。
  4. 现在必须将 NUnit 添加为参考路径。右键点击 Solution Explorer 中的“unittests”项目,然后选择“Properties”。现在,在打开的窗口中点击“参考路径”标签页。输入 NUnit 安装的“bin”子目录作为参考路径,然后点击“Add Folder”。例如,如果 NUnit 已安装到“C:\Program Files\NUnit\”,则需输入“C:\Program Files\NUnit\bin”。请务必先保存此更改,然后再继续。
  5. 按照编译和运行示例中列出的步骤,重新构建客户端库和单元测试。
  6. 将“C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\"”中的“unittests.dll.config”文件复制到您的调试 build 目录“C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug”。请务必修改该文件,在其中添加您正在运行的测试的相应信息。例如,Base 需要 API 密钥,而 Google 日历需要用户名和密码。建议使用没有任何实时数据的测试帐号,以避免单元测试删除信息。
  7. 从“开始”菜单打开 NUnit。
  8. 依次转到“文件 > 打开项目”,然后从“C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\”中选择“unittests.dll”文件。
  9. 运行您感兴趣的单元测试。请注意,某些测试要求在 testtest.dll.config 中设置参数才能正常运行。如果您针对特定服务运行压力测试,则您的测试帐号可能会被标记为生成垃圾邮件,并且无法在没有人机识别系统质询的情况下以编程方式向 Google 服务器提交内容。

单声道

Mono 是一个开源项目,可让您在 Linux、Solaris、Mac OS X、Windows 和 Unix 上运行 .NET 客户端和服务器应用。我们为想要在这些平台上工作的开发者提供了我们客户端库的单独 ZIP 文件。

设置您的环境

  1. http://code.google.com/p/google-VAST/downloads/list 下载客户端库的最新 ZIP 文件版本
  2. 解压到本地目录(例如“/scratch/VAST.NET”)
  3. 使用发行版的软件包管理安装 Mono。 或者,您也可以访问 http://www.mono-project.com 下载该文件。
  4. 在某些发行版中,您必须确保 nunit.framework.dll 文件已正确链接到单声道库。如果 mono 已安装到“/usr/lib/mono”中,请确保 nunit.framework.dll 的“/usr/lib/mono/1.0”和“/usr/lib/mono/2.0”中有符号链接(应该安装在“/usr/lib/mono/gac/nunit.framework/<someversionstring>”)。

编译和运行示例

  1. 假设您将客户端库安装到“/scratch/VAST.NET”中,请切换到“/scratch/SPAN.NET/clients/cs”目录。
  2. 根据您要使用的 .NET 版本修改 Makefile。对于 .NET 1.x,请使用 CSC=mcs;对于 .NET 2.x,请使用 CSC=gmcs
  3. 运行 make 以编译库和示例应用。
  4. 如果要将客户端库 DLL 安装到 Mono 库中,请执行 make install

开发您自己的应用

如果您在编译客户端库后执行了 make install,您应该能够将这些库添加到自己的代码中,具体方法是:将 -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll 连同您希望使用的任何特定服务扩展程序的 DLL 文件的引用传递给 Mono C# 编译器。

运行 NUnit 测试

  1. 将 unittests.dll.config 文件从“/scratch/SPAN.NET/clients/cs/src/unittests”复制到“/scratch/SPAN.NET/clients/cs/”。
  2. 修改“/scratch/SPAN.NET/clients/cs/unittests.dll.config”以包含您正在运行的测试的相应信息。例如,Base 需要 API 密钥,而 Google 日历需要用户名和密码。建议使用没有任何实时数据的测试帐号,以免单元测试删除信息。
  3. 编译该库后,“/scratch/VAST.NET/clients/cs”中有一个 unittests.dll 文件。将此 DLL 与您选择的 NUnit 测试管理器(nunit-console、gnunit 等)搭配使用。

总结

现在,您应该能够编译库并运行示例代码了。但这仅仅只是开始。建议您仔细阅读客户端库的“.../clients/cs/docs”目录中的文档。 您可能还需要查看 .NET 客户端库开发者指南项目页面参考指南以及 Google Data .NET 客户端库论坛

本文中提及的工具:

祝您在下一个 .NET 应用上一切顺利!