Creazione dei gestori di attività

In questa pagina viene descritto come creare un gestore di attività, il codice che gestisce un'attività push. Devi fornire un gestore delle richieste per elaborare l'attività. Il mapping dall'URL della richiesta al gestore appropriato viene dichiarato nel app.yaml del tuo servizio, proprio come qualsiasi altro gestore di richieste. Poiché controlli la modalità di mappatura delle richieste di attività a un gestore, puoi organizzare i gestori delle attività. Se la tua applicazione elabora molti tipi diversi di attività, puoi aggiungere tutti i gestori a un singolo servizio oppure distribuirli tra più servizi.

Scrittura di un gestore di richieste di attività push

Nella coda, il servizio coda di attività crea un'intestazione HTTP e la invia a un'istanza del servizio worker specificata dalla destinazione dell'attività. Le richieste di code di attività vengono inviate dall'indirizzo IP 0.1.0.2.

Non è necessario che il gestore sia scritto nella stessa lingua in cui ha creato l'attività e che ha accodato l'attività se il gestore si trova in un servizio separato.

Quando scrivi il gestore, segui queste linee guida:

  • Per indicare l'esito positivo, il codice deve restituire un codice di stato HTTP compreso nell'intervallo 200-299. Qualsiasi altro codice indica che l'attività non è riuscita.

  • Le attività push hanno una scadenza di completamento fissa che dipende dal tipo di scalabilità del servizio su cui vengono eseguite. I servizi di scalabilità automatica devono terminare prima che siano trascorsi 10 minuti. I servizi di scalabilità manuali e di base possono essere eseguiti fino a 24 ore. Se il gestore non supera la scadenza, il servizio coda di attività presuppone che l'attività non sia riuscita e riprova.

    Quando il tempo di esecuzione di un'attività si avvicina alla scadenza, App Engine genera un valore DeadlineExceededError (dal modulo google.appengine.runtime) prima che venga raggiunta, in modo che tu possa salvare il lavoro o registrare gli eventuali progressi.

  • Il gestore deve essere idempotente. L'API Task Queue di App Engine è progettata per fornire la consegna "almeno una volta"; ossia, se un'attività viene aggiunta correttamente, App Engine la consegna a un gestore almeno una volta. Tieni presente che in alcune rare circostanze è possibile eseguire più attività, quindi il codice deve garantire che non ci siano effetti collaterali dannosi dell'esecuzione ripetuta.

L'esempio seguente mostra il recupero di un valore intero da una richiesta e l'aggiunta del valore a un contatore gestito in Cloud Datastore:


from google.appengine.ext import ndb
import webapp2

COUNTER_KEY = 'default counter'

class Counter(ndb.Model):
    count = ndb.IntegerProperty(indexed=False)

class UpdateCounterHandler(webapp2.RequestHandler):
    def post(self):
        amount = int(self.request.get('amount'))

        # This task should run at most once per second because of the datastore
        # transaction write throughput.
        @ndb.transactional
        def update_counter():
            counter = Counter.get_or_insert(COUNTER_KEY, count=0)
            counter.count += amount
            counter.put()

        update_counter()

app = webapp2.WSGIApplication([
    ('/update_counter', UpdateCounterHandler)
], debug=True)

La mappatura dall'URL dell'attività /update-counter al corso UpdateCounterHandler viene eseguita all'interno di WSGIApplication.

Il file worker.yaml crea un servizio denominato "worker" a cui aggiunge il codice worker. Tieni presente che l'URL del gestore è sicuro perché specifica login:admin:

runtime: python27
api_version: 1
threadsafe: true
service: worker

handlers:
- url: /.*
  script: worker.app
  login: admin

La coda di attività utilizza il codice HTTP nella risposta del gestore per determinare se l'attività è riuscita. La risposta del gestore viene visualizzata solo dal servizio coda di attività e solo per determinare se l'attività è riuscita. La coda ignora tutti gli altri campi nella risposta. Quindi il servizio ignora la risposta. L'app di origine non riceve mai nessuno dei dati. Se un'attività non va a buon fine, il servizio della coda di attività riprova a eseguire l'attività inviando un'altra richiesta.

I dati forniti dall'utente possono essere inviati al gestore nella richiesta come stringa di query o come payload nel corpo della richiesta. L'inserimento dei dati utente è descritto in Creazione di attività. Se la richiesta include dati, il gestore deve sapere come sono stati inseriti. Il codice esatto che utilizzi per recuperare i dati dalla richiesta dipende dal framework web specifico in uso.

Per testare un gestore di attività, accedi come amministratore e visita l'URL del gestore nel browser.

Lettura delle intestazioni delle richieste

Una richiesta HTTP di un'attività push ha intestazioni speciali impostate da App Engine, che contengono informazioni specifiche sull'attività che il gestore può utilizzare.

Se sono presenti in una richiesta di un utente esterno alla tua app, queste intestazioni vengono rimosse e sostituite. L'unica eccezione riguarda le richieste degli amministratori dell'applicazione che hanno eseguito l'accesso, autorizzati a impostare le intestazioni a scopo di test. Le intestazioni, invece, non vengono rimosse quando l'app è in esecuzione sul server di sviluppo.

Le richieste dalla coda di attività conterranno sempre le seguenti intestazioni:

Titolo Descrizione
X-Appengine-QueueName Il nome della coda (possibilmente "default" per la coda in modalità push predefinita).
X-Appengine-TaskName Il nome dell'attività o un ID univoco generato dal sistema se non è stato specificato alcun nome.
X-Appengine-TaskRetryCount Il numero di nuovi tentativi di questa attività. Per il primo tentativo, questo valore è 0. Questo numero include i tentativi in cui l'attività non è riuscita a causa della mancanza di istanze disponibili e non ha mai raggiunto la fase di esecuzione.
X-Appengine-TaskExecutionCount Il numero di volte in cui questa attività non è riuscita in precedenza durante la fase di esecuzione. Questo numero non include gli errori dovuti alla mancanza di istanze disponibili.
X-Appengine-TaskETA Il tempo di esecuzione target dell'attività, specificato in secondi dal 1° gennaio 1970.

Se il gestore delle richieste trova una qualsiasi delle intestazioni elencate sopra, può considerare attendibile che la richiesta è una richiesta di coda di attività.

Inoltre, le richieste dalla coda di attività possono contenere le seguenti intestazioni:

Titolo Descrizione
X-Appengine-TaskPreviousResponse Il codice di risposta HTTP del tentativo precedente.
X-Appengine-TaskRetryReason Il motivo per il nuovo tentativo dell'attività.
X-Appengine-FailFast Indica che un'attività in esecuzione non va a buon fine immediatamente se un'istanza esistente non è disponibile.

Protezione degli URL dei gestori delle attività

Se un'attività esegue operazioni sensibili (come la modifica dei dati), potrebbe essere opportuno proteggere l'URL del gestore per impedire a un utente esterno malintenzionato di chiamarla direttamente. Puoi impedire agli utenti di accedere agli URL delle attività limitando l'accesso agli amministratori di App Engine. Le richieste di attività vengono emesse da App Engine e possono sempre avere come target un URL limitato.

Puoi limitare un URL aggiungendo l'elemento login: admin alla configurazione del gestore nel file app.yaml.

Ad esempio:

handlers:
- url: /your-task
  script: worker.app
  login: admin

Passaggi successivi