開始使用 .NET 用戶端程式庫

Google Data API 團隊的 Jeff Fisher
2007 年 8 月

簡介

Google Data API 解決方案
圖 1：Google Data API 解決方案

對許多開發人員來說，新專案是最困難的部分，那就是取得滾動式安裝的新軟體套件、設定開發環境及學習新程式庫。在本文中，我們收集了一些逐步指示，說明如何使用 Visual Studio 2005 for Windows 或 Mono for Linux 以及其他 Unix 作業系統，來開始使用 .NET 用戶端程式庫。希望您能更快上手，讓您快速開始使用程式碼。

Visual Studio 2008

如果您尚未安裝 Visual Studio 2008，可以考慮使用 Visual C# 2008 Express Edition，這個免費的 Visual Studio 版本可讓您使用 .NET 用戶端程式庫。

設定環境

  1. 前往 http://code.google.com/p/google-gdata/downloads/list 下載最新版本的用戶端程式庫。
  2. 執行下載的 MSI 檔案來安裝套件。根據預設，應用程式會安裝為「C:\Program Files\Google\Google Data API SDK」。本文的其他範例假設您將用戶端程式庫安裝到這個位置。
  3. 開啟「開始」功能表中「Google Data API SDK」資料夾，並命名為「Google Data API SDK」解決方案檔案。

編譯及執行範例

  1. 確認執行「建構 > 建構解決方案」執行完畢，沒有任何錯誤。
  2. 如要建立偵錯版本，請依序前往 [Build] (建構) > [Configuration Manager] (設定管理員)，然後選取 [Debug] (偵錯) 做為有效解決方案設定。然後依序選取「Build」(建構) >「Build Solution」(建構解決方案)。
  3. 您可以在「C:\Program Files\Google\Google Data API SDK\Sources\Samples」中找到剛編譯的二進位檔和 DLL 檔案。舉例來說，您可以執行「C:\Program Files\Google\Google Data API 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 API SDK\Sources\Library\VS2005」目錄，然後開啟名為「Google Data API」的解決方案檔案。 畫面上是 Visual Studio 2005 專案檔案，因此會顯示轉換精靈。點擊提示或點選 [完成] 按鈕。應該會顯示可忽略的轉換記錄。
  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」檔案複製到偵錯版本目錄「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. 執行您感興趣的單元測試。請記住，某些測試需要在 unittests.dll.config 中設定參數才能運作。如果您針對某些服務執行壓力測試，系統可能會將您的測試帳戶標記為會產生垃圾內容，而不會以程式輔助方式將內容提交至 Google 伺服器，也不會處理人機驗證 (Captcha) 挑戰。

單聲道

Mono 是一項開放原始碼專案，可讓您在 Linux、Solaris、Mac OS X、Windows 和 Unix 上執行 .NET 用戶端和伺服器應用程式。針對想在這些平台上工作的開發人員，我們提供獨立的用戶端程式庫 ZIP 檔案。

設定環境

  1. 前往 http://code.google.com/p/google-gdata/downloads/list 下載用戶端程式庫的最新最新版本 ZIP 檔案。
  2. 解壓縮至本機目錄 (例如「/scratch/gdata.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/gdata.NET」，請變更為「/scratch/gdata.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 傳遞至 Mono C# 編譯器，以及需要使用任何特定服務擴充功能的 DLL 檔案的參照，以在自己的程式庫中加入程式庫。

執行 NUnit 測試

  1. 將 unittests.dll.config 檔案從「/scratch/gdata.NET/clients/cs/src/unittests」複製到「/scratch/gdata.NET/clients/cs/」。
  2. 編輯「/scratch/gdata.NET/clients/cs/unittests.dll.config」以包含要執行的測試相關資訊。舉例來說，Base 需要 API 金鑰，Google 日曆則必須提供使用者名稱和密碼。我們建議您使用不含即時資料的測試帳戶，以免商品單元資訊遭到刪除。
  3. 編譯程式庫後，「/scratch/gdata.NET/clients/cs」中會有 unittests.dll 檔案。將這個 DLL 與您選擇的 NUnit 測試經理 (nunit-console、gnunit 等) 搭配使用。

結語

現在，您應該能夠編譯程式庫並執行程式碼範例。不過這只是個開端。建議您詳閱用戶端程式庫用戶端程式庫的「.../clients/cs/docs」目錄。 建議您參閱 .NET 用戶端程式庫開發人員指南、專案網頁和參考指南，以及 Google Data .NET 用戶端程式庫論壇。

本文中提及的工具：

祝您順利使用下一個 .NET 應用程式！