本頁面由 Cloud Translation API 翻譯而成。

封鎖商店

許多使用者在設定新的 Android 裝置時，仍會自行管理自己的憑證。這項手動程序可能會變得相當困難，且通常會導致使用者體驗不佳。Block Store API 是由 Google Play 服務提供技術支援的程式庫，旨在讓應用程式提供一種儲存使用者憑證的方式，省去與儲存使用者密碼相關的複雜性或安全風險。

Block Store API 可讓應用程式儲存資料，方便日後擷取並在新裝置重新驗證使用者。這有助於為使用者提供更流暢的體驗，因為使用者在新裝置首次啟動應用程式時，不必查看登入畫面。

使用「封鎖商店」功能的好處如下：

適用於開發人員的加密憑證儲存空間解決方案。系統會盡可能對憑證進行端對端加密處理。
儲存權杖，而非使用者名稱和密碼。
排除登入流程的阻礙。
讓使用者不必再費心管理複雜的密碼。
Google 會驗證使用者身分。

事前準備

如要讓應用程式做好準備，請完成下列各節的步驟。

設定應用程式

在專案層級的 build.gradle 檔案中，請同時在 buildscript 和 allprojects 區段中加入 Google Maven 存放區：

buildscript {
  repositories {
    google()
    mavenCentral()
  }
}

allprojects {
  repositories {
    google()
    mavenCentral()
  }
}

將 Block Store API 的 Google Play 服務依附元件新增至模組的 Gradle 建構檔案，通常為 app/build.gradle：

dependencies {
  implementation 'com.google.android.gms:play-services-auth-blockstore:16.2.0'
}

運作方式

區塊存放區可讓開發人員儲存及還原多達 16 個位元組的陣列。這可讓您儲存目前使用者工作階段的相關重要資訊，也讓您可以隨心所欲地儲存這些資訊。這些資料可能會經過端對端加密處理，支援 Block Store 的基礎架構是以「備份與還原」基礎架構為基礎。

本指南會說明將使用者權杖儲存至 Block Store 的用途。下列步驟概述採用 Block Store 的應用程式的運作方式：

在應用程式的驗證流程中，或之後都可以將使用者的驗證權杖儲存至 Block Store，以供日後擷取。
權杖會儲存在本機中，也可備份到雲端，並視情況進行端對端加密處理。
當使用者在新裝置上啟動還原流程時，系統就會轉移資料。
如果使用者在還原流程中還原應用程式，應用程式便可在新裝置上的 Block Store 擷取已儲存的權杖。

正在儲存權杖

當使用者登入應用程式時，您可以將你為該使用者產生的驗證權杖儲存至 Block Store。您可以使用不重複的金鑰組值，儲存每個項目的最高 4 KB。如要儲存權杖，請在 StoreBytesData.Builder 的執行個體上呼叫 setBytes() 和 setKey()，將使用者的憑證儲存至來源裝置。使用 Block Store 儲存權杖後，權杖會經過加密並儲存在裝置本機上。

以下範例說明如何將驗證權杖儲存至本機裝置：

Java

  BlockstoreClient client = Blockstore.getClient(this);
  byte[] bytes1 = new byte[] { 1, 2, 3, 4 };  // Store one data block.
  String key1 = "com.example.app.key1";
  StoreBytesData storeRequest1 = StoreBytesData.Builder()
          .setBytes(bytes1)
          // Call this method to set the key value pair the data should be associated with.
          .setKeys(Arrays.asList(key1))
          .build();
  client.storeBytes(storeRequest1)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this)

  val bytes1 = byteArrayOf(1, 2, 3, 4) // Store one data block.
  val key1 = "com.example.app.key1"
  val storeRequest1 = StoreBytesData.Builder()
    .setBytes(bytes1) // Call this method to set the key value with which the data should be associated with.
    .setKeys(Arrays.asList(key1))
    .build()
  client.storeBytes(storeRequest1)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "Stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

使用預設權杖

透過 StoreBytes 儲存的資料時，若無金鑰，系統會使用預設的 BlockstoreClient.DEFAULT_BYTES_DATA_KEY。

Java

  BlockstoreClient client = Blockstore.getClient(this);
  // The default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  byte[] bytes = new byte[] { 9, 10 };
  StoreBytesData storeRequest = StoreBytesData.Builder()
          .setBytes(bytes)
          .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener(result -> Log.d(TAG, "stored " + result + " bytes"))
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

  val client = Blockstore.getClient(this);
  // the default key BlockstoreClient.DEFAULT_BYTES_DATA_KEY.
  val bytes = byteArrayOf(1, 2, 3, 4)
  val storeRequest = StoreBytesData.Builder()
    .setBytes(bytes)
    .build();
  client.storeBytes(storeRequest)
    .addOnSuccessListener { result: Int ->
      Log.d(TAG,
            "stored $result bytes")
    }
    .addOnFailureListener { e ->
      Log.e(TAG, "Failed to store bytes", e)
    }

擷取權杖

之後，當使用者在新裝置上執行還原流程時，Google Play 服務會先驗證使用者，然後再擷取 Block Store 資料。使用者已同意在還原流程中還原應用程式資料，因此不需要額外同意聲明。使用者開啟應用程式時，您可以呼叫 retrieveBytes()，向 Block Store 要求權杖。接著，就能使用擷取到的權杖讓使用者在新裝置上保持登入狀態。

以下範例說明如何根據特定金鑰擷取多個符記。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Retrieve data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to retrieve data stored without a key

List requestedKeys = Arrays.asList(key1, key2, key3); // Add keys to array
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(requestedKeys)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(requestedKeys)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

正在擷取所有權杖，

以下範例說明如何擷取儲存在 BlockStore 的所有符記。

Java

BlockstoreClient client = Blockstore.getClient(this)

// Retrieve all data.
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setRetrieveAll(true)
    .build();

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry entry : blockstoreDataMap.entrySet()) {
            Log.d(TAG, String.format(
                "Retrieved bytes %s associated with key %s.",
                new String(entry.getValue().getBytes()), entry.getKey()));
          }
        })
    .addOnFailureListener(e -> Log.e(TAG, "Failed to store bytes", e));

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setRetrieveAll(true)
  .build()

client.retrieveBytes(retrieveRequest)
  .addOnSuccessListener { result: RetrieveBytesResponse ->
    val blockstoreDataMap =
      result.blockstoreDataMap
    for ((key, value) in blockstoreDataMap) {
      Log.d(ContentValues.TAG, String.format(
        "Retrieved bytes %s associated with key %s.",
        String(value.bytes), key))
    }
  }
  .addOnFailureListener { e: Exception? ->
    Log.e(ContentValues.TAG,
          "Failed to store bytes",
          e)
  }

以下範例說明如何擷取預設金鑰。

Java

BlockStoreClient client = Blockstore.getClient(this);
RetrieveBytesRequest retrieveRequest = new RetrieveBytesRequest.Builder()
    .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
    .build();
client.retrieveBytes(retrieveRequest);

Kotlin

val client = Blockstore.getClient(this)

val retrieveRequest = RetrieveBytesRequest.Builder()
  .setKeys(Arrays.asList(BlockstoreClient.DEFAULT_BYTES_DATA_KEY))
  .build()
client.retrieveBytes(retrieveRequest)

刪除權杖

基於下列原因，您可能需要從 BlockStore 刪除權杖：

使用者完成登出流程。
憑證已遭撤銷或無效。

與擷取符記類似，您可以透過設定需要刪除的金鑰陣列，來指定需要刪除的權杖。

以下範例說明如何刪除特定金鑰。

Java

BlockstoreClient client = Blockstore.getClient(this);

// Delete data associated with certain keys.
String key1 = "com.example.app.key1";
String key2 = "com.example.app.key2";
String key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY; // Used to delete data stored without key

List requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array
DeleteBytesRequest deleteRequest = new DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build();
client.deleteBytes(deleteRequest)

Kotlin

val client = Blockstore.getClient(this)

// Retrieve data associated with certain keys.
val key1 = "com.example.app.key1"
val key2 = "com.example.app.key2"
val key3 = BlockstoreClient.DEFAULT_BYTES_DATA_KEY // Used to retrieve data stored without a key

val requestedKeys = Arrays.asList(key1, key2, key3) // Add keys to array

val retrieveRequest = DeleteBytesRequest.Builder()
      .setKeys(requestedKeys)
      .build()

client.deleteBytes(retrieveRequest)

刪除所有權杖

以下範例會刪除目前儲存至 BlockStore 的所有權杖：

Java

// Delete all data.
DeleteBytesRequest deleteAllRequest = new DeleteBytesRequest.Builder()
      .setDeleteAll(true)
      .build();
client.deleteBytes(deleteAllRequest)
.addOnSuccessListener(result -> Log.d(TAG, "Any data found and deleted? " + result));

Kotlin

  val deleteAllRequest = DeleteBytesRequest.Builder()
  .setDeleteAll(true)
  .build()
client.deleteBytes(deleteAllRequest)
  .addOnSuccessListener { result: Boolean ->
    Log.d(TAG,
          "Any data found and deleted? $result")
  }

端對端加密

如要提供端對端加密功能，裝置必須搭載 Android 9 以上版本，且使用者已設定裝置的螢幕鎖定 (PIN 碼、解鎖圖案或密碼)。您可以呼叫 isEndToEndEncryptionAvailable() 來確認裝置是否支援加密功能。

以下範例說明如何確認雲端備份期間是否可使用加密功能：

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { result ->
          Log.d(TAG, "Will Block Store cloud backup be end-to-end encrypted? $result")
        }

啟用雲端備份

如要啟用雲端備份，請將 setShouldBackupToCloud() 方法新增至 StoreBytesData 物件。將 setShouldBackupToCloud() 設為 true 時，Block Store 會定期將儲存的位元組備份至雲端。

以下範例顯示如何僅在雲端備份經過端對端加密時啟用雲端備份：

val client = Blockstore.getClient(this)
val storeBytesDataBuilder = StoreBytesData.Builder()
        .setBytes(/* BYTE_ARRAY */)

client.isEndToEndEncryptionAvailable()
        .addOnSuccessListener { isE2EEAvailable ->
          if (isE2EEAvailable) {
            storeBytesDataBuilder.setShouldBackupToCloud(true)
            Log.d(TAG, "E2EE is available, enable backing up bytes to the cloud.")

            client.storeBytes(storeBytesDataBuilder.build())
                .addOnSuccessListener { result ->
                  Log.d(TAG, "stored: ${result.getBytesStored()}")
                }.addOnFailureListener { e ->
                  Log.e(TAG, “Failed to store bytes”, e)
                }
          } else {
            Log.d(TAG, "E2EE is not available, only store bytes for D2D restore.")
          }
        }

測試方法

請在開發期間使用下列方法，測試還原流程。

解除安裝/重新安裝同一部裝置

如果使用者啟用了備份服務 (可依序前往「設定」>「Google」>「備份」查看)，則區塊商店資料會保留在應用程式解除安裝/重新安裝中。

測試步驟如下：

將 BlockStore API 整合至測試應用程式。
使用測試應用程式來叫用 BlockStore API，儲存資料。
解除安裝測試應用程式，然後在同一部裝置上重新安裝應用程式。
請使用測試應用程式來叫用 BlockStore API，以便擷取資料。
確認擷取的位元組與解除安裝前儲存的位元組相同。

裝置間

在大多數情況下，你必須將目標裝置恢復原廠設定。接著，您可以進入 Android 無線還原流程或 Google 傳輸線還原流程 (適用於支援的裝置)。

雲端還原

將 Blockstore API 整合至測試應用程式。您必須將測試應用程式提交至 Play 商店。
在來源裝置上，使用測試應用程式叫用 Blockstore API 以儲存資料，並將 shouldBackUpToCloud 設為 true。
對於 O 以上版本裝置，您可以手動觸發 Block Store 雲端備份：依序前往「設定」>「Google」>「備份」，然後按一下「立即備份」按鈕。
1. 如要確認 Block Store 雲端備份是否成功，你可以採取下列做法：
  1. 備份完成後，請搜尋含有「CloudSyncBpTkSvc」標記的記錄行。
  2. 您應該會看到類似下方的幾行內容：「......, CloudSyncBpTkSvc: sync 結果: SUCCESS, ..., upload size: XXX 個位元組 ...」
2. 區塊儲存庫雲端備份作業結束後，會有 5 分鐘的「等待期」。在這 5 分鐘內，點選「立即備份」按鈕並不會觸發另一個 Block Store 雲端備份。
將目標裝置恢復原廠設定，然後完成雲端還原流程。選取即可在還原流程中還原測試應用程式。如要進一步瞭解雲端還原流程，請參閱支援的雲端還原流程。
在目標裝置上，使用測試應用程式叫用 Blockstore API 擷取資料。
確認擷取的位元組與來源裝置上儲存的位元組相同。

裝置需求

端對端加密

搭載 Android 9 (API 29) 以上版本的裝置均支援端對端加密功能。
您必須在裝置上設定設有 PIN 碼、解鎖圖案或密碼的螢幕鎖定，才能啟用端對端加密功能，並正確加密使用者的資料。

裝置對裝置還原流程

如要還原裝置，您必須擁有來源裝置和目標裝置。這兩部裝置將負責轉移資料。

來源裝置必須搭載 Android 6 (API 23) 以上版本才能進行備份。

指定搭載 Android 9 (API 29) 以上版本的裝置才能還原資料。

如要進一步瞭解裝置還原裝置的程序，請參閱這篇文章。

雲端備份與還原流程

如要使用雲端備份與還原功能，則需要來源裝置和目標裝置。

來源裝置必須搭載 Android 6 (API 23) 以上版本才能進行備份。

系統可根據供應商的供應商支援指定裝置。Pixel 裝置可透過 Android 9 (API 29) 以上版本使用這項功能，而所有其他裝置則必須搭載 Android 12 (API 31) 以上版本。