Начало работы с клиентской библиотекой .NET

Джефф Фишер, команда Google Data API
август 2007 г.

Введение

Решение API данных Google
Рисунок 1. Решение Google Data API

Для многих разработчиков самой сложной частью нового проекта является начало работы — установка новых программных пакетов, настройка среды разработки и изучение новых библиотек. В этой статье я собрал воедино несколько пошаговых инструкций о том, как начать работу с клиентской библиотекой .NET, используя либо Visual Studio 2005 для Windows, либо Mono для Linux и других операционных систем Unix. Я надеюсь, что это сэкономит вам время при начале работы и позволит вам быстро приступить к работе с некоторым кодом.

Визуальная студия 2008

Если у вас еще не установлена ​​Visual Studio 2008, вы можете рассмотреть возможность использования Visual C# 2008 Express Edition , бесплатной версии Visual Studio, которая позволит вам работать с клиентской библиотекой .NET.

Настройка вашей среды

  1. Загрузите последний выпуск MSI клиентской библиотеки со страницы 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. Убедитесь, что запуск «Build > Build Solution» завершается без каких-либо ошибок.
  2. Чтобы создать отладочную сборку, перейдите в «Сборка > Диспетчер конфигураций» и выберите «Отладка» в качестве активной конфигурации решения. Затем выберите «Сборка > Построить решение».
  3. Только что скомпилированные двоичные файлы и DLL-файлы можно найти в «C:\Program Files\Google\Google Data API SDK\Sources\Samples\». Например, вы можете запустить пример приложения для календаря, выполнив «C:\Program Files\Google\Google Data API SDK\Sources\Samples\calendar\bin\Debug\Calendar.exe". Для этих примеров также есть несколько ярлыков меню «Пуск».

Разработка собственного приложения

Если вы хотите разрабатывать проект за пределами файла решения, предоставленного файлом MSI, вам необходимо добавить файлы DLL клиентской библиотеки в качестве эталонного пути.

  1. Создайте или откройте проект за пределами решения Google API SDK.
  2. Выберите «Добавить ссылку» в меню «Проект».
  3. Нажмите на вкладку Обзор.
  4. Перейдите в каталог Redist в SDK: «C:\Program Files\Google\Google Data API SDK\Redist».
  5. Выберите файлы DLL, которые будут использоваться вашим кодом. Google.GData.Extensions.dll и Google.GData.Client.dll потребуются для большинства проектов, а также файл DLL, относящийся к службам Google, которые вы используете в своем приложении.

Примечание. Существует также файл решения для клиентских библиотек на мобильных устройствах. По умолчанию он находится в папке «C:\Program Files\Google\Google Data API SDK\Sources\Library\VS2005.mobile». Это решение будет компилировать файлы DLL только для клиентских библиотек.

Запуск тестов NUnit

Убедиться, что соответствующие тесты NUnit пройдены, — важный шаг, если вы вносите какие-либо изменения в клиентские библиотеки или планируете внести в них свой вклад. Если вы планируете использовать клиентские библиотеки без модификаций, обычно нет необходимости их запускать.

  1. Загрузите выпуск файла .NET 2.0 MSI NUnit с http://www.nunit.org/index.php?p=download .
  2. Установите NUnit, запустив файл MSI. Место установки по умолчанию похоже на «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 должен быть добавлен в качестве эталонного пути. Щелкните правой кнопкой мыши проект «unittests» в обозревателе решений справа и выберите «Свойства». Теперь нажмите на вкладку «Пути ссылок» в открывшемся окне. Введите местоположение подкаталога «bin» установки NUnit в качестве эталонного пути и нажмите «Добавить папку». Например, если NUnit установлен в «C:\Program Files\NUnit\», нужно ввести «C:\Program Files\NUnit\bin». Обязательно сохраните это изменение, прежде чем продолжить.
  5. Выполните шаги, перечисленные в разделе Компиляция и запуск примеров , чтобы перестроить клиентскую библиотеку и модульные тесты.
  6. Скопируйте файл «unittests.dll.config» в «C:\Program Files\Google\Google Data API SDK\Sources\Library\unittests\» в каталог отладочной сборки «C:\Program Files\Google\Google Data API SDK». \Source\Library\VS2005\unittests\bin\Debug\". Не забудьте отредактировать файл, чтобы включить соответствующую информацию для тестов, которые вы выполняете. Например, для Base требуется ключ API, а для Calendar — имя пользователя и пароль. Рекомендуется использовать тестовую учетную запись без каких-либо оперативных данных, чтобы избежать удаления информации модульными тестами.
  7. Откройте NUnit из меню «Пуск».
  8. Перейдите в «Файл > Открыть проект» и выберите файл «unittests.dll» из «C:\Program Files\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\».
  9. Запустите интересующие вас модульные тесты. Помните, что некоторые тесты требуют установки параметров в unittests.dll.config для работы. Если вы запускаете стресс-тесты для определенных служб, ваша тестовая учетная запись может быть помечена как генерирующая спам, и вы не сможете программно отправлять контент на серверы Google, не сталкиваясь с проблемами CAPTCHA.

Мононуклеоз

Mono — это проект с открытым исходным кодом, который позволяет запускать клиентские и серверные приложения .NET в Linux, Solaris, Mac OS X, Windows и Unix. Мы предлагаем отдельный ZIP-файл нашей клиентской библиотеки для разработчиков, которые хотят работать на одной из этих платформ.

Настройка вашей среды

  1. Загрузите последний выпуск ZIP-файла клиентской библиотеки со страницы http://code.google.com/p/google-gdata/downloads/list .
  2. Извлечь в локальный каталог (например, «/scratch/gdata.NET»)
  3. Используйте управление пакетами вашего дистрибутива для установки Mono. Кроме того, вы можете загрузить его с http://www.mono-project.com .
  4. В некоторых дистрибутивах необходимо убедиться, что файл nunit.framework.dll правильно связан с монобиблиотекой. Если моно было установлено в «/usr/lib/mono», убедитесь, что в «/usr/lib/mono/1.0» и «/usr/lib/mono/2.0» есть символические ссылки для nunit.framework.dll ( который должен быть установлен в "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit.framework.dll").

Компиляция и запуск образцов

  1. Предполагая, что вы установили клиентскую библиотеку в «/scratch/gdata.NET», перейдите в каталог «/scratch/gdata.NET/clients/cs».
  2. Отредактируйте Makefile в зависимости от того, какую версию .NET вы хотите использовать. Для .NET 1.x используйте CSC=mcs , а для .NET 2.x используйте CSC=gmcs .
  3. Запустите make , чтобы скомпилировать библиотеки и примеры приложений.
  4. Выполните make install если вы хотите установить библиотеки DLL клиентской библиотеки в библиотеку Mono.

Разработка собственного приложения

Если вы выполнили 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, а для Calendar — имя пользователя и пароль. Я рекомендую использовать тестовую учетную запись без каких-либо оперативных данных, чтобы избежать удаления информации модульными тестами.
  3. После компиляции библиотеки в "/scratch/gdata.NET/clients/cs" появится файл unittests.dll. Используйте эту DLL с выбранным менеджером тестов NUnit (nunit-console, gnunit и т. д.).

Заключение

Теперь вы сможете скомпилировать библиотеки и запустить пример кода. Однако это только начало. Я рекомендую вам прочитать документацию в каталоге ".../clients/cs/docs" клиентской библиотеки. Вы также можете ознакомиться с Руководством разработчика клиентской библиотеки .NET , страницей проекта и справочным руководством , а также с форумом клиентской библиотеки Google Data .NET .

Инструменты, упомянутые в этой статье:

Удачи в вашем следующем приложении .NET!