Partite salvate per i giochi Android

Questa guida mostra come implementare i salvataggi utilizzando l'API Snapshots fornita da Google Play Services. Le API sono disponibili nei pacchetti com.google.android.gms.games.snapshot e com.google.android.gms.games.

Prima di iniziare

Per informazioni sulla funzionalità, consulta la panoramica di salvataggi.

Ottenere il client di snapshot

Per iniziare a utilizzare l'API Snapshot, il tuo gioco deve prima ottenere un oggetto SnapshotsClient. Per farlo, puoi chiamare il metodo Games.getSnapshotsContents() e passare l'attività.

Specifica l'ambito del viaggio

L'API Snapshots si basa sull'API Google Drive per lo spazio di archiviazione delle partite salvate. Per accedere all'API Drive, la tua app deve specificare l'ambito Drive.SCOPE_APPFOLDER quando crea il client di Accedi con Google.

Ecco un esempio di come eseguire questa operazione nel metodo onResume() per la tua attività di accesso:

@Override
protected void onResume() {
  super.onResume();
  signInSilently();
}

private void signInSilently() {
  GoogleSignInOptions signInOption =
      new GoogleSignInOptions.Builder(GoogleSignInOptions.DEFAULT_GAMES_SIGN_IN)
          // Add the APPFOLDER scope for Snapshot support.
          .requestScopes(Drive.SCOPE_APPFOLDER)
          .build();

  GoogleSignInClient signInClient = GoogleSignIn.getClient(this, signInOption);
  signInClient.silentSignIn().addOnCompleteListener(this,
      new OnCompleteListener<GoogleSignInAccount>() {
        @Override
        public void onComplete(@NonNull Task<GoogleSignInAccount> task) {
          if (task.isSuccessful()) {
            onConnected(task.getResult());
          } else {
            // Player will need to sign-in explicitly using via UI
          }
        }
      });
}

Visualizzare le partite salvate

Puoi integrare l'API Snapshots ovunque il tuo gioco offra ai giocatori la possibilità di salvare o ripristinare i progressi. Il tuo gioco potrebbe mostrare un'opzione di questo tipo in punti di salvataggio o ripristino designati oppure consentire ai giocatori di salvare o ripristinare i progressi in qualsiasi momento.

Una volta che i giocatori hanno selezionato l'opzione di salvataggio o ripristino nel gioco, il gioco può optionally visualizzare una schermata che chiede ai giocatori di inserire le informazioni per una nuova partita salvata o di selezionare una partita salvata esistente da ripristinare.

Per semplificare lo sviluppo, l'API Snapshots fornisce un'interfaccia utente (UI) predefinita per la selezione delle partite salvate che puoi utilizzare immediatamente. L'interfaccia utente di selezione delle partite salvate consente ai giocatori di creare una nuova partita salvata, visualizzare i dettagli delle partite salvate esistenti e caricare le partite salvate precedenti.

Per avviare l'interfaccia utente predefinita dei giochi salvati:

  1. Chiama SnapshotsClient.getSelectSnapshotIntent() per ricevere un Intent per avviare l'interfaccia utente di selezione delle partite salvate predefinita.
  2. Chiama startActivityForResult() e passa Intent. Se la chiamata va a buon fine, il gioco mostra l'interfaccia utente di selezione delle partite salvate, insieme alle opzioni specificate.

Ecco un esempio di come avviare l'interfaccia utente di selezione delle partite salvate predefinita:

private static final int RC_SAVED_GAMES = 9009;

private void showSavedGamesUI() {
  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);
  int maxNumberOfSavedGamesToShow = 5;

  Task<Intent> intentTask = snapshotsClient.getSelectSnapshotIntent(
      "See My Saves", true, true, maxNumberOfSavedGamesToShow);

  intentTask.addOnSuccessListener(new OnSuccessListener<Intent>() {
    @Override
    public void onSuccess(Intent intent) {
      startActivityForResult(intent, RC_SAVED_GAMES);
    }
  });
}

Se il giocatore seleziona la creazione di una nuova partita salvata o il caricamento di una partita salvata esistente, l'interfaccia utente invia una richiesta a Play Services. Se la richiesta va a buon fine, Play Giochi Services restituisce le informazioni per creare o ripristinare la partita salvata tramite il callback onActivityResult(). Il tuo gioco può sostituire questo callback per verificare se si sono verificati errori durante la richiesta.

Il seguente snippet di codice mostra un'implementazione di esempio di onActivityResult():

private String mCurrentSaveName = "snapshotTemp";

/**
 * This callback will be triggered after you call startActivityForResult from the
 * showSavedGamesUI method.
 */
@Override
protected void onActivityResult(int requestCode, int resultCode,
                                Intent intent) {
  if (intent != null) {
    if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA)) {
      // Load a snapshot.
      SnapshotMetadata snapshotMetadata =
          intent.getParcelableExtra(SnapshotsClient.EXTRA_SNAPSHOT_METADATA);
      mCurrentSaveName = snapshotMetadata.getUniqueName();

      // Load the game data from the Snapshot
      // ...
    } else if (intent.hasExtra(SnapshotsClient.EXTRA_SNAPSHOT_NEW)) {
      // Create a new snapshot named with a unique string
      String unique = new BigInteger(281, new Random()).toString(13);
      mCurrentSaveName = "snapshotTemp-" + unique;

      // Create the new snapshot
      // ...
    }
  }
}

Scrivere le partite salvate

Per archiviare contenuti in una partita salvata:

  1. Apri uno snapshot in modo asincrono utilizzando SnapshotsClient.open().

  2. Recupera l'oggetto Snapshot dal risultato dell'attività chiamando SnapshotsClient.DataOrConflict.getData().

  3. Recupera un'istanza SnapshotContents con SnapshotsClient.SnapshotConflict.

  4. Chiama SnapshotContents.writeBytes() per memorizzare i dati del giocatore in formato byte.

  5. Una volta apportate tutte le modifiche, chiama SnapshotsClient.commitAndClose() per inviarle ai server di Google. Nella chiamata al metodo, il gioco può facoltativamente fornire informazioni aggiuntive per indicare a Play Giochi Services come presentare questa partita salvata ai giocatori. Queste informazioni sono rappresentate in un oggetto SnapshotMetaDataChange che il gioco crea utilizzando SnapshotMetadataChange.Builder.

Il seguente snippet mostra come la tua partita potrebbe applicare le modifiche a una partita salvata:

private Task<SnapshotMetadata> writeSnapshot(Snapshot snapshot,
                                             byte[] data, Bitmap coverImage, String desc) {

  // Set the data payload for the snapshot
  snapshot.getSnapshotContents().writeBytes(data);

  // Create the change operation
  SnapshotMetadataChange metadataChange = new SnapshotMetadataChange.Builder()
      .setCoverImage(coverImage)
      .setDescription(desc)
      .build();

  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);

  // Commit the operation
  return snapshotsClient.commitAndClose(snapshot, metadataChange);
}

Se il dispositivo del giocatore non è connesso a una rete quando la tua app chiama SnapshotsClient.commitAndClose(), Play Giochi Services memorizza i dati di gioco salvati localmente sul dispositivo. Al nuovo collegamento del dispositivo, Play Giochi sincronizza le modifiche alle partite salvate memorizzate nella cache locale con i server di Google.

Caricare le partite salvate

Per recuperare le partite salvate per il giocatore che ha eseguito l'accesso:

  1. Apri uno snapshot in modo asincrono con SnapshotsClient.open().

  2. Recupera l'oggetto Snapshot dal risultato dell'attività chiamando SnapshotsClient.DataOrConflict.getData(). In alternativa, il gioco può anche recuperare uno snapshot specifico tramite l'interfaccia utente di selezione delle partite salvate, come descritto in Mostrare le partite salvate.

  3. Recupera l'istanza SnapshotContents con SnapshotsClient.SnapshotConflict.

  4. Chiama SnapshotContents.readFully() per leggere i contenuti dell'istantanea.

Lo snippet seguente mostra come caricare una partita salvata specifica:

Task<byte[]> loadSnapshot() {
  // Display a progress dialog
  // ...

  // Get the SnapshotsClient from the signed in account.
  SnapshotsClient snapshotsClient =
      PlayGames.getSnapshotsClient(this);

  // In the case of a conflict, the most recently modified version of this snapshot will be used.
  int conflictResolutionPolicy = SnapshotsClient.RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED;

  // Open the saved game using its name.
  return snapshotsClient.open(mCurrentSaveName, true, conflictResolutionPolicy)
      .addOnFailureListener(new OnFailureListener() {
        @Override
        public void onFailure(@NonNull Exception e) {
          Log.e(TAG, "Error while opening Snapshot.", e);
        }
      }).continueWith(new Continuation<SnapshotsClient.DataOrConflict<Snapshot>, byte[]>() {
        @Override
        public byte[] then(@NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task) throws Exception {
          Snapshot snapshot = task.getResult().getData();

          // Opening the snapshot was a success and any conflicts have been resolved.
          try {
            // Extract the raw data from the snapshot.
            return snapshot.getSnapshotContents().readFully();
          } catch (IOException e) {
            Log.e(TAG, "Error while reading Snapshot.", e);
          }

          return null;
        }
      }).addOnCompleteListener(new OnCompleteListener<byte[]>() {
        @Override
        public void onComplete(@NonNull Task<byte[]> task) {
          // Dismiss progress dialog and reflect the changes in the UI when complete.
          // ...
        }
      });
}

Gestire i conflitti dei giochi salvati

Quando utilizzi l'API Snapshots nel tuo gioco, è possibile che più dispositivi effettuino letture e scritture sulla stessa partita salvata. Se un dispositivo perde temporaneamente la connessione di rete e si riconnette in un secondo momento, potrebbero verificarsi conflitti di dati per cui la partita salvata sul dispositivo locale di un giocatore non è sincronizzata con la versione remota archiviata sui server di Google.

L'API Snapshots fornisce un meccanismo di risoluzione dei conflitti che presenta entrambi gli insiemi di partite salvate in conflitto al momento della lettura e ti consente di implementare una strategia di risoluzione appropriata per il tuo gioco.

Quando Play Giochi Services rileva un conflitto di dati, il metodo SnapshotsClient.DataOrConflict.isConflict() restituisce un valore true. In questo caso, la classe SnapshotsClient.SnapshotConflict fornisce due versioni della partita salvata:

  • Versione del server: la versione più aggiornata nota da Play Giochi Services come precisa per il dispositivo del giocatore.

  • Versione locale: una versione modificata rilevata su uno dei dispositivi del player che contiene contenuti o metadati in conflitto. Potrebbe non essere uguale alla versione che hai provato a salvare.

Il gioco deve decidere come risolvere il conflitto scegliendo una delle versioni fornite o unendo i dati delle due versioni salvate del gioco.

Per rilevare e risolvere i conflitti delle partite salvate:

  1. Chiama SnapshotsClient.open(). Il risultato dell'attività contiene una classe SnapshotsClient.DataOrConflict.

  2. Chiama il metodo SnapshotsClient.DataOrConflict.isConflict(). Se il risultato è vero, devi risolvere un conflitto.

  3. Chiama SnapshotsClient.DataOrConflict.getConflict() per recuperare un'istanza SnapshotsClient.snapshotConflict.

  4. Chiama SnapshotsClient.SnapshotConflict.getConflictId() per recuperare l'ID conflitto che identifica in modo univoco il conflitto rilevato. Il tuo gioco ha bisogno di questo valore per inviare una richiesta di risoluzione dei conflitti in un secondo momento.

  5. Chiama SnapshotsClient.SnapshotConflict.getConflictingSnapshot() per ottenere la versione locale.

  6. Chiama SnapshotsClient.SnapshotConflict.getSnapshot() per ottenere la versione del server.

  7. Per risolvere il conflitto della partita salvata, seleziona una versione che vuoi salvare sul server come versione finale e passala al metodo SnapshotsClient.resolveConflict().

Il seguente snippet mostra un esempio di come la tua app potrebbe gestire un conflitto di salvataggio selezionando la partita salvata modificata più di recente come versione finale da salvare:

private static final int MAX_SNAPSHOT_RESOLVE_RETRIES = 10;

Task<Snapshot> processSnapshotOpenResult(SnapshotsClient.DataOrConflict<Snapshot> result,
                                         final int retryCount) {

  if (!result.isConflict()) {
    // There was no conflict, so return the result of the source.
    TaskCompletionSource<Snapshot> source = new TaskCompletionSource<>();
    source.setResult(result.getData());
    return source.getTask();
  }

  // There was a conflict.  Try resolving it by selecting the newest of the conflicting snapshots.
  // This is the same as using RESOLUTION_POLICY_MOST_RECENTLY_MODIFIED as a conflict resolution
  // policy, but we are implementing it as an example of a manual resolution.
  // One option is to present a UI to the user to choose which snapshot to resolve.
  SnapshotsClient.SnapshotConflict conflict = result.getConflict();

  Snapshot snapshot = conflict.getSnapshot();
  Snapshot conflictSnapshot = conflict.getConflictingSnapshot();

  // Resolve between conflicts by selecting the newest of the conflicting snapshots.
  Snapshot resolvedSnapshot = snapshot;

  if (snapshot.getMetadata().getLastModifiedTimestamp() <
      conflictSnapshot.getMetadata().getLastModifiedTimestamp()) {
    resolvedSnapshot = conflictSnapshot;
  }

  return PlayGames.getSnapshotsClient(theActivity)
      .resolveConflict(conflict.getConflictId(), resolvedSnapshot)
      .continueWithTask(
          new Continuation<
              SnapshotsClient.DataOrConflict<Snapshot>,
              Task<Snapshot>>() {
            @Override
            public Task<Snapshot> then(
                @NonNull Task<SnapshotsClient.DataOrConflict<Snapshot>> task)
                throws Exception {
              // Resolving the conflict may cause another conflict,
              // so recurse and try another resolution.
              if (retryCount < MAX_SNAPSHOT_RESOLVE_RETRIES) {
                return processSnapshotOpenResult(task.getResult(), retryCount + 1);
              } else {
                throw new Exception("Could not resolve snapshot conflicts");
              }
            }
          });
}

Modificare le partite salvate

Se vuoi unire i dati di più partite salvate o modificare unSnapshot esistente da salvare sul server come versione finale risolta, segui questi passaggi:

  1. Chiama SnapshotsClient.open().

  2. Chiama SnapshotsClient.SnapshotConflict.getResolutionSnapshotsContent() per ricevere un nuovo SnapshotContents oggetto.

  3. Unisci i dati di SnapshotsClient.SnapshotConflict.getConflictingSnapshot() e SnapshotsClient.SnapshotConflict.getSnapshot() nell'oggetto SnapshotContents del passaggio precedente.

  4. Se vuoi, crea un'istanza SnapshotMetadataChange se vengono apportate modifiche ai campi dei metadati.

  5. Chiama SnapshotsClient.resolveConflict(). Nella chiamata al metodo, passa SnapshotsClient.SnapshotConflict.getConflictId() come primo argomento e gli oggetti SnapshotMetadataChange e SnapshotContents che hai modificato in precedenza come secondo e terzo argomento rispettivamente.

  6. Se la chiamata SnapshotsClient.resolveConflict() è andata a buon fine, l'API memorizza l'oggetto Snapshot sul server e tenta di aprire l'oggetto Snapshot sul tuo dispositivo locale.