Suggerimenti sulle prestazioni

Questo documento illustra alcune tecniche che puoi utilizzare per migliorare il rendimento della tua applicazione. In alcuni casi, vengono utilizzati esempi di altre API o API generiche per illustrare le idee presentate. Tuttavia, gli stessi concetti sono applicabili all'API Gmail.

Compressione con gzip

Un modo semplice e pratico per ridurre la larghezza di banda necessaria per ogni richiesta è attivare la compressione gzip. Sebbene ciò richieda ulteriore tempo della CPU per decomprimere i risultati, il compromesso con i costi di rete di solito lo rende molto utile.

Per ricevere una risposta codificata con gzip, devi fare due cose: impostare un'intestazione Accept-Encoding e modificare lo user agent in modo che contenga la stringa gzip. Ecco un esempio di intestazioni HTTP formate correttamente per attivare la compressione gzip:

Accept-Encoding: gzip
User-Agent: my program (gzip)

Utilizzare risorse parziali

Un altro modo per migliorare il rendimento delle chiamate API consiste nell'inviare e ricevere solo la parte dei dati che ti interessa. In questo modo, l'applicazione evita di trasferire, analizzare e archiviare campi non necessari, in modo da poter utilizzare le risorse, tra cui rete, CPU e memoria, in modo più efficiente.

Esistono due tipi di richieste parziali:

  • Risposta parziale: una richiesta in cui specifichi i campi da includere nella risposta (utilizza il parametro di richiesta fields).
  • Patch: una richiesta di aggiornamento in cui invii solo i campi che vuoi modificare (utilizza il verbo HTTP PATCH).

Nelle sezioni seguenti vengono forniti ulteriori dettagli sulla creazione di richieste parziali.

Risposta parziale

Per impostazione predefinita, il server restituisce la rappresentazione completa di una risorsa dopo l'elaborazione delle richieste. Per prestazioni migliori, puoi chiedere al server di inviare solo i campi di cui hai realmente bisogno e ricevere invece una risposta parziale.

Per richiedere una risposta parziale, utilizza il parametro di richiesta fields per specificare i campi che vuoi che vengano restituiti. Puoi utilizzare questo parametro con qualsiasi richiesta che restituisce dati di risposta.

Tieni presente che il parametro fields influisce solo sui dati di risposta, non sui dati che devi inviare, se presenti. Per ridurre la quantità di dati inviati durante la modifica delle risorse, utilizza una richiesta patch.

Esempio

L'esempio seguente mostra l'utilizzo del parametro fields con un'API "Demo" generica (fittizia).

Richiesta semplice:questa richiesta HTTP GET omette il parametro fields e restituisce la risorsa completa.

https://www.googleapis.com/demo/v1

Risposta completa della risorsa:i dati completi della risorsa includono i seguenti campi, oltre a molti altri che sono stati omessi per brevità.

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

Richiesta di una risposta parziale:la seguente richiesta per la stessa risorsa utilizza il parametro fields per ridurre significativamente la quantità di dati restituiti.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Risposta parziale:in risposta alla richiesta precedente, il server invia una risposta che contiene solo le informazioni sul tipo insieme a un array di elementi ridotto che include solo le informazioni sul titolo HTML e sulla lunghezza in ogni elemento.

200 OK
 
{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Tieni presente che la risposta è un oggetto JSON che include solo i campi selezionati e i relativi oggetti principali contenitori.

Di seguito vengono forniti i dettagli su come formattare il parametro fields, seguiti da ulteriori dettagli su cosa viene restituito esattamente nella risposta.

Riepilogo della sintassi del parametro Fields

Il formato del valore del parametro di richiesta fields si basa vagamente sulla sintassi XPath. La sintassi supportata è riassunta di seguito e nella sezione successiva vengono forniti ulteriori esempi.

  • Utilizza un elenco separato da virgole per selezionare più campi.
  • Utilizza a/b per selezionare un campo b nidificato all'interno del campo a; utilizza a/b/c per selezionare un campo c nidificato all'interno di b.

    Eccezione:per le risposte API che utilizzano wrapper "data", in cui la risposta è nidificata all'interno di un oggetto data simile a data: { ... }, non includere "data" nella specifica fields. L'inclusione dell'oggetto dati con una specifica dei campi come data/a/b causa un errore. Utilizza invece una specifica fields come a/b.

  • Utilizza un selettore secondario per richiedere un insieme di campi secondari specifici di array o oggetti inserendo le espressioni tra parentesi "( )".

    Ad esempio, fields=items(id,author/email) restituisce solo l'ID articolo e l'email dell'autore per ogni elemento dell'array degli articoli. Puoi anche specificare un singolo campo secondario, dove fields=items(id) equivale a fields=items/id.

  • Utilizza i caratteri jolly nelle selezioni dei campi, se necessario.

    Ad esempio, fields=items/pagemap/* seleziona tutti gli oggetti in una pagemap.

Altri esempi di utilizzo del parametro fields

Gli esempi riportati di seguito includono descrizioni di come il valore del parametro fields influisce sulla risposta.

Nota:come per tutti i valori dei parametri di query, il valore del parametro fields deve essere codificato nell'URL. Per una migliore leggibilità, gli esempi in questo documento omettono la codifica.

Identifica i campi che vuoi restituire o effettua selezioni di campi.
Il valore del parametro di richiesta fields è un elenco di campi separati da virgole e ogni campo è specificato rispetto alla radice della risposta. Pertanto, se esegui un'operazione list, la risposta è una raccolta e in genere include un array di risorse. Se esegui un'operazione che restituisce una singola risorsa, i campi vengono specificati in relazione a quella risorsa. Se il campo selezionato è (o fa parte di) un array, il server restituisce la porzione selezionata di tutti gli elementi dell'array.

Ecco alcuni esempi a livello di raccolta:
Esempi Effetto
items Restituisce tutti gli elementi dell'array items, inclusi tutti i campi di ogni elemento, ma nessun altro campo.
etag,items Restituisce sia il campo etag sia tutti gli elementi nell'array items.
items/title Restituisce solo il campo title per tutti gli elementi dell'array degli elementi.

Ogni volta che viene restituito un campo nidificato, la risposta include gli oggetti padre che lo contengono. I campi principali non includono altri campi secondari, a meno che non vengano selezionati esplicitamente.
context/facets/label Restituisce solo il campo label per tutti i membri dell'array facets, che a sua volta è nidificato nell'oggetto context.
items/pagemap/*/title Per ogni elemento dell'array items, restituisce solo il campo title (se presente) di tutti gli oggetti secondari di pagemap.

Ecco alcuni esempi a livello di risorsa:
Esempi Effetto
title Restituisce il campo title della risorsa richiesta.
author/uri Restituisce il sotto-campo uri dell'oggetto author nella risorsa richiesta.
links/*/href
 Restituisce il campo href di tutti gli oggetti secondari di links.
Richiedi solo parti di campi specifici utilizzando le sotto-selezioni.
Per impostazione predefinita, se la richiesta specifica campi particolari, il server restituisce gli oggetti o gli elementi dell'array nella loro interezza. Puoi specificare una risposta che includa solo determinati campi secondari. A questo scopo, utilizza la sintassi di selezione secondaria "( )", come nell'esempio riportato di seguito.
Esempio Effetto
items(title,author/uri) Restituisce solo i valori di title e uri dell'autore per ogni elemento dell'array items.

Gestire le risposte parziali

Dopo che un server elabora una richiesta valida che include il parametro di query fields, restituisce un codice di stato HTTP 200 OK, insieme ai dati richiesti. Se il parametro di query fields presenta un errore o non è valido, il server restituisce un codice di stato HTTP 400 Bad Request, insieme a un messaggio di errore che indica all'utente cosa non va nella selezione dei campi (ad esempio, "Invalid field selection a/b").

Ecco l'esempio di risposta parziale mostrato nella sezione introduttiva precedente. La richiesta utilizza il parametro fields per specificare i campi da restituire.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

La risposta parziale è simile alla seguente:

200 OK
 
{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Nota:per le API che supportano i parametri di query per la paginazione dei dati (ad esempio maxResults e nextPageToken), utilizza questi parametri per ridurre i risultati di ogni query a una dimensione gestibile. In caso contrario, i miglioramenti delle prestazioni possibili con la risposta parziale potrebbero non essere realizzati.

Patch (aggiornamento parziale)

Puoi anche evitare di inviare dati non necessari durante la modifica delle risorse. Per inviare dati aggiornati solo per i campi specifici che stai modificando, utilizza il verbo HTTP PATCH. La semantica delle patch descritta in questo documento è diversa (e più semplice) rispetto a quella dell'implementazione GData precedente dell'aggiornamento parziale.

Il breve esempio riportato di seguito mostra come l'utilizzo di patch riduce al minimo i dati da inviare per apportare un piccolo aggiornamento.

Esempio

Questo esempio mostra una semplice richiesta di patch per aggiornare solo il titolo di una risorsa API "Demo" generica (fittizia). La risorsa ha anche un commento, un insieme di caratteristiche, uno stato e molti altri campi, ma questa richiesta invia solo il campo title, poiché è l'unico campo modificato:

PATCH https://www.googleapis.com/demo/v1/324
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "title": "New title"
}

Risposta:

200 OK
 
{
  "title": "New title",
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "accuracy": "high",
    "followers": ["Jo", "Will"],
  },
  "status": "active",
  ...
}

Il server restituisce un codice di stato 200 OK, insieme alla rappresentazione completa della risorsa aggiornata. Poiché nella richiesta di patch è stato incluso solo il campo title, questo è l'unico valore diverso da prima.

Nota:se utilizzi il parametro fields risposta parziale in combinazione con patch, puoi aumentare ulteriormente l'efficienza delle richieste di aggiornamento. Una richiesta di patch riduce solo le dimensioni della richiesta. Una risposta parziale riduce le dimensioni della risposta. Per ridurre la quantità di dati inviati in entrambe le direzioni, utilizza una richiesta di patch con il parametro fields.

Semantica di una richiesta patch

Il corpo della richiesta di patch include solo i campi delle risorse che vuoi modificare. Quando specifichi un campo, devi includere tutti gli oggetti principali racchiusi, proprio come i genitori racchiusi vengono restituiti con una risposta parziale. I dati modificati che invii vengono uniti ai dati dell'oggetto principale, se presente.

  • Aggiungi:per aggiungere un campo che non esiste già, specifica il nuovo campo e il relativo valore.
  • Modifica:per modificare il valore di un campo esistente, specifica il campo e impostalo sul nuovo valore.
  • Elimina:per eliminare un campo, specificane il nome e impostalo su null. Ad esempio: "comment": null. Puoi anche eliminare un intero oggetto (se è modificabile) impostandolo su null. Se utilizzi la libreria client API Java, utilizza Data.NULL_STRING. Per maggiori dettagli, consulta JSON null.

Nota sugli array:le richieste di patch che contengono array sostituiscono l'array esistente con quello che fornisci. Non puoi modificare, aggiungere o eliminare elementi in un array in modo frammentario.

Utilizzo di patch in un ciclo di lettura, modifica e scrittura

Può essere utile iniziare recuperando una risposta parziale con i dati che vuoi modificare. Ciò è particolarmente importante per le risorse che utilizzano ETag, poiché devi fornire il valore ETag corrente nell'intestazione HTTP If-Match per aggiornare correttamente la risorsa. Dopo aver ottenuto i dati, puoi modificare i valori che vuoi cambiare e inviare nuovamente la rappresentazione parziale modificata con una richiesta di patch. Ecco un esempio che presuppone che la risorsa Demo utilizzi ETag:

GET https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token

Questa è la risposta parziale:

200 OK
 
{
  "etag": "ETagString"
  "title": "New title"
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "level": "5",
    "followers": ["Jo", "Will"],
  }
}

La seguente richiesta di patch si basa su questa risposta. Come mostrato di seguito, utilizza anche il parametro fields per limitare i dati restituiti nella risposta alla patch:

PATCH https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json
If-Match: "ETagString"

{
  "etag": "ETagString"
  "title": "",                  /* Clear the value of the title by setting it to the empty string. */
  "comment": null,              /* Delete the comment by replacing its value with null. */
  "characteristics": {
    "length": "short",
    "level": "10",              /* Modify the level value. */
    "followers": ["Jo", "Liz"], /* Replace the followers array to delete Will and add Liz. */
    "accuracy": "high"          /* Add a new characteristic. */
  },
}

Il server risponde con un codice di stato HTTP 200 OK e la rappresentazione parziale della risorsa aggiornata:

200 OK
 
{
  "etag": "newETagString"
  "title": "",                 /* Title is cleared; deleted comment field is missing. */
  "characteristics": {
    "length": "short",
    "level": "10",             /* Value is updated.*/
    "followers": ["Jo" "Liz"], /* New follower Liz is present; deleted Will is missing. */
    "accuracy": "high"         /* New characteristic is present. */
  }
}

Costruzione diretta di una richiesta di patch

Per alcune richieste di patch, devi basarle sui dati recuperati in precedenza. Ad esempio, se vuoi aggiungere un elemento a un array e non vuoi perdere nessuno degli elementi esistenti, devi prima recuperare i dati esistenti. Allo stesso modo, se un'API utilizza ETag, devi inviare il valore ETag precedente con la richiesta per aggiornare correttamente la risorsa.

Nota:puoi utilizzare un'intestazione HTTP "If-Match: *" per forzare l'applicazione di una patch quando vengono utilizzati gli ETag.  Se lo fai, non devi eseguire la lettura prima della scrittura.

Per altre situazioni, tuttavia, puoi creare direttamente la richiesta di patch, senza prima recuperare i dati esistenti. Ad esempio, puoi configurare facilmente una richiesta di patch che aggiorni un campo a un nuovo valore o aggiunga un nuovo campo. Ecco un esempio:

PATCH https://www.googleapis.com/demo/v1/324?fields=comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "comment": "A new comment",
  "characteristics": {
    "volume": "loud",
    "accuracy": null
  }
}

Con questa richiesta, se il campo dei commenti ha un valore esistente, il nuovo valore lo sovrascrive; in caso contrario, viene impostato sul nuovo valore. Allo stesso modo, se esiste una caratteristica di volume, il relativo valore viene sovrascritto; in caso contrario, viene creata. Il campo di precisione, se impostato, viene rimosso.

Gestione della risposta a una patch

Dopo aver elaborato una richiesta patch valida, l'API restituisce un codice di risposta HTTP 200 OK insieme alla rappresentazione completa della risorsa modificata. Se le ETag vengono utilizzate dall'API, il server aggiorna i valori ETag quando elabora correttamente una richiesta patch, proprio come fa con PUT.

La richiesta di patch restituisce l'intera rappresentazione della risorsa, a meno che tu non utilizzi il parametro fields per ridurre la quantità di dati restituiti.

Se una richiesta di patch genera un nuovo stato della risorsa sintatticamente o semanticamente non valido, il server restituisce un codice di stato HTTP 400 Bad Request o 422 Unprocessable Entity e lo stato della risorsa rimane invariato. Ad esempio, se tenti di eliminare il valore di un campo obbligatorio, il server restituisce un errore.

Notazione alternativa quando il verbo HTTP PATCH non è supportato

Se il firewall non consente le richieste HTTP PATCH, esegui una richiesta HTTP POST e imposta l'intestazione di override su PATCH, come mostrato di seguito:

POST https://www.googleapis.com/...
X-HTTP-Method-Override: PATCH
...

Differenza tra patch e aggiornamento

In pratica, quando invii dati per una richiesta di aggiornamento che utilizza il verbo HTTP PUT, devi inviare solo i campi obbligatori o facoltativi; se invii valori per i campi impostati dal server, questi vengono ignorati. Anche se questo potrebbe sembrare un altro modo per eseguire un aggiornamento parziale, questo approccio presenta alcune limitazioni. Con gli aggiornamenti che utilizzano il verbo HTTP PUT, la richiesta non va a buon fine se non fornisci i parametri obbligatori e cancella i dati impostati in precedenza se non fornisci i parametri facoltativi.

Per questo motivo, è molto più sicuro utilizzare la patch. Fornisci i dati solo per i campi che vuoi modificare; i campi che ometti non vengono cancellati. L'unica eccezione a questa regola si verifica con gli elementi ripetuti o gli array: se li ometti tutti, rimangono invariati; se ne fornisci uno qualsiasi, l'intero insieme viene sostituito con l'insieme che fornisci.