Introduzione alla libreria client .NET

Jeff Fisher, team delle API di dati di Google
agosto 2007

Introduzione

La soluzione dell'API di dati di Google
Figura 1: la soluzione API di dati di Google

Per molti sviluppatori, la parte più difficile di un nuovo progetto è fare ordine con l'installazione di nuovi pacchetti software, la configurazione di un ambiente di sviluppo e l'apprendimento di nuove librerie. In questo articolo ho raccolto alcune istruzioni dettagliate per iniziare a utilizzare la libreria client .NET utilizzando Visual Studio 2005 per Windows o Mono per Linux e altri sistemi operativi Unix. Spero che questo ti consentirà di risparmiare tempo e di iniziare a lavorare rapidamente con del codice.

Visual Studio 2008

Se non hai ancora installato Visual Studio 2008, puoi utilizzare Visual C# 2008 Express Edition, una versione senza costi di Visual Studio che ti consente di lavorare con la libreria client .NET.

Configurazione dell'ambiente

  1. Scarica la release MSI più recente della libreria client da http://code.google.com/p/google-gdata/download/list.
  2. Esegui il file MSI scaricato per installare il pacchetto. Per impostazione predefinita, verrà installata in "C:\Programmi\Google\Google API API\". Per ulteriori esempi in questo articolo si presuppone che tu abbia installato la libreria client in questa posizione.
  3. Apri il file della soluzione denominato "Google Data API SDK" nella cartella "Google Data API SDK" del menu Start.

Compilazione ed esecuzione di esempi

  1. Verifica che l'esecuzione di "Build > Build Solution" venga completata senza errori.
  2. Per creare una build di debug, vai a "Build > Configuration Manager" e seleziona "Debug" come configurazione della soluzione attiva. Quindi seleziona "Crea > Crea soluzione".
  3. I file binari e i file DLL che hai appena compilato si trovano nella sezione "C:\Programmi\Google\Google API SDK\Sources\Samples\" Ad esempio, puoi eseguire l'applicazione di esempio per Calendar eseguendo il comando "C:\Programmi Google\Google Google API SDK\Sources\Samples\calendar\bin\Debug\Calendar.exe". A questi esempi sono disponibili anche alcune scorciatoie del menu Start.

Sviluppo della tua applicazione

Se vuoi sviluppare in un progetto al di fuori del file della soluzione fornito dal file MSI, devi aggiungere i file DLL della libreria client come percorso di riferimento.

  1. Crea o apri un progetto al di fuori della soluzione SDK dell'API di Google.
  2. Seleziona "Aggiungi riferimento" dal menu Progetto.
  3. Fai clic sulla scheda Sfoglia.
  4. Passa alla directory Redist nell'SDK: "C:\Programmi\Google\Google Data API SDK\Redist".
  5. Seleziona i file DLL che verranno utilizzati dal codice. Google.GData.Extensions.dll e Google.GData.Client.dll saranno necessari per la maggior parte dei progetti, insieme al file DLL specifico per i servizi Google che stai utilizzando nella tua applicazione.

Nota:è disponibile anche un file di soluzione per le librerie client sui dispositivi mobili. Lo trovi per impostazione predefinita in "C:\Programmi\Google\Google API SDK\Sources\Library\VS2005.mobile". Questa soluzione completerà solo i file DLL per le librerie client.

Esecuzione dei test NUnit

Garantire che il test NUnit appropriato sia un passaggio importante se apporti modifiche alle librerie client o prevedi di contribuire. Se prevedi di utilizzare le librerie client senza modifiche, in genere non è necessario eseguirle.

  1. Scarica la release del file MSI di .NET 2.0 da NUnit da http://www.nunit.org/index.php?p=download.
  2. Installa NUnit eseguendo il file MSI. Il percorso di installazione predefinito è simile a "C:\Programmi\NUnit 2.4.8". Ti consigliamo di sostituire questa impostazione con "C:\Programmi\NUnit" per poter eseguire l'upgrade di NUnit in futuro senza dover modificare il percorso del tuo progetto Visual Studio.
  3. Vai alla directory "C:\Programmi\Google\Google API API\Sources\Library\VS2005" e apri il file della soluzione denominato "API di dati di Google". Verrà visualizzata la procedura guidata di conversione, poiché si tratta di un file di progetto Visual Studio 2005. Attieniti ai suggerimenti o fai semplicemente clic sul pulsante "Fine". Dovrebbe essere visualizzato il log delle conversioni, che può essere ignorato.
  4. Ora NUnit deve essere aggiunto come percorso di riferimento. Fai clic con il tasto destro del mouse sul progetto "unittests" in Esplora soluzioni a destra e seleziona "Proprietà". Ora fai clic sulla scheda "Percorsi di riferimento" all'interno della finestra visualizzata. Inserisci il percorso di riferimento nella sottodirectory "bin" dell'installazione di NUnit e fai clic su "Aggiungi cartella". Ad esempio, se NUnit è installata su "C:\Programmi\NUnit\", viene inserito "C:\Programmi\NUnit\bin". Assicurati di salvare questa modifica prima di continuare.
  5. Segui i passaggi elencati in Compilazione ed esecuzione di esempi per ricreare la libreria client e i test delle unità.
  6. Copia il file "unittests.dll.config" in "C:\Programmi\Google\Google Data API SDK\Sources\Library\unittests\" nella directory di build di debug "C:\Programmi\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\". Ricorda di modificare il file in modo da includere le informazioni appropriate per i test in esecuzione. Ad esempio, Base richiede una chiave API e Calendar richiede un nome utente e una password. Ti consigliamo di utilizzare un account di prova senza dati in tempo reale per evitare che le informazioni vengano eliminate dai test delle unità.
  7. Apri NUnit dal menu Start.
  8. Vai a "File > Apri progetto" e seleziona il file "unittests.dll" in "C:\Programmi\Google\Google Data API SDK\Source\Library\VS2005\unittests\bin\Debug\".
  9. Esegui i test delle unità di tuo interesse. Ricorda che alcuni test richiedono l'impostazione di parametri in unittests.dll.config per funzionare. Se esegui gli stress test per determinati servizi, è possibile che il tuo account di prova venga segnalato come spam e che non sia in grado di inviare contenuti ai server di Google in modo programmatico senza riscontrare problemi CAPTCHA.

Mono

Mono è un progetto open source che consente di eseguire applicazioni client e server .NET su Linux, Solaris, Mac OS X, Windows e Unix. Offriamo un file ZIP separato della nostra libreria client per gli sviluppatori che vogliono lavorare su una di queste piattaforme.

Configurazione dell'ambiente

  1. Scarica la release più recente del file ZIP della libreria client da http://code.google.com/p/google-gdata/download/list
  2. Estrai in una directory locale (ad es. "/scratch/gdata.NET")
  3. Usa la gestione dei pacchetti della tua distribuzione per installare Mono. In alternativa, puoi scaricarla da http://www.mono-project.com.
  4. In alcune distribuzioni devi assicurarti che il file nunit.framework.dll sia collegato correttamente alla libreria mono. Se il mono è stato installato in "/usr/lib/mono", assicurati che siano presenti link simbolici in "/usr/lib/mono/1.0" e "/usr/lib/mono/2.0" per nunit.framework.dll (che deve essere installato in "/usr/lib/mono/gac/nunit.framework/<someversionstring>/nunit").

Compilazione ed esecuzione di esempi

  1. Se hai installato la libreria client in "/scratch/gdata.NET", passa alla directory "/scratch/gdata.NET/clients/cs".
  2. Modifica il Makefile in base alla versione di .NET che intendi usare. Per .NET 1.x, utilizza CSC=mcs. Per .NET 2.x, utilizza CSC=gmcs.
  3. Esegui make per compilare le librerie e le applicazioni di esempio.
  4. Esegui make install se vuoi installare le DLL della libreria client nella libreria mono.

Sviluppo della tua applicazione

Se hai eseguito un make install dopo aver compilato la libreria client, dovresti essere in grado di includere le librerie nel tuo codice passando -r:Google.GData.Extensions.dll -r:Google.GData.Client.dll al compilatore Mono C# insieme ai riferimenti ai file DLL di eventuali estensioni di servizio specifiche che vuoi utilizzare.

Esecuzione dei test NUnit

  1. Copia il file unittests.dll.config da "/scratch/gdata.NET/clients/cs/src/unittests" in "/scratch/gdata.NET/clients/cs/".
  2. Modifica "/scratch/gdata.NET/clients/cs/unittests.dll.config" in modo da includere le informazioni appropriate per i test in esecuzione. Ad esempio, Base richiede una chiave API e Calendar richiede un nome utente e una password. Ti consiglio di utilizzare un account di prova senza dati attivi per evitare che le informazioni vengano eliminate dai test delle unità.
  3. Dopo aver compilato la libreria, sarà presente un file unittests.dll in "/scratch/gdata.NET/clients/cs". Utilizza questa DLL con il gestore di test NUnit scelto (nunit-console, gnunit e così via).

Conclusione

Ora dovresti essere in grado di compilare le librerie ed eseguire il codice campione. Tuttavia, questo è solo l'inizio. Ti invito a leggere la documentazione disponibile nella directory ".../clients/cs/docs" della libreria client. Puoi anche consultare la Guida per gli sviluppatori della libreria client.NET, la pagina del progetto e la guida di riferimento e il forum della libreria client di .NET dei dati di Google.

Strumenti indicati in questo articolo:

Buona fortuna con la tua prossima applicazione .NET.