块店

注意：为了提升用户体验和其他改进，请考虑改为 将通行密钥与 Credential Manager 搭配使用 。

许多用户在设置新的 Android 设备时仍会管理自己的凭据。这种手动流程可能极具挑战性，并且通常会导致糟糕的用户体验。Block Store API 是一个由 Google Play 服务提供支持的库，旨在解决此问题，它使应用能够保存用户凭据，而不会降低与保存用户密码相关的复杂性或安全风险。

Block Store API 允许您的应用存储数据，以便稍后检索，以便在新设备上对用户重新进行身份验证。这有助于为用户提供更顺畅的体验，因为用户在新设备上首次启动您的应用时不需要看到登录屏幕。

使用 Block Store 的好处包括：

• 面向开发者的加密凭据存储解决方案。系统会尽可能对凭据进行端到端加密。
• 保存令牌，而不是用户名和密码。
• 消除登录流程中的不便。
• 让用户不必再费心管理复杂的密码。
• Google 会验证用户的身份。

注意 ：使用块存储不会限制用户能够使用哪些类型的凭据。用户可以使用自己的用户名和密码、Google 账号或任何其他联合身份提供方服务登录，并且 Block Store 仍然正常运行。

准备工作

为了让您的应用做好准备，请完成以下部分中的步骤。

配置您的应用

在项目级 build.gradle 文件中，同时在 buildscript 和 allprojects 部分添加 Google 的 Maven 制品库：

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

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

将 Block Store API 的 Google Play 服务依赖项添加到模块的 Gradle build 文件（通常为 app/build.gradle）中：

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

运作方式

Block Store 允许开发者保存和恢复最多 16 个字节数组。这样，您就可以保存有关当前用户会话的重要信息，并且可以按照自己的喜好灵活地保存这些信息。这些数据可以进行端到端加密，支持 Block Store 的基础架构建立在“备份和恢复”基础架构之上。

本指南将介绍将用户的令牌保存到 Block Store 的用例。以下步骤概述了使用 Block Store 的应用的运作方式：

1. 在应用的身份验证流程中或之后的任何时间，您都可以将用户的身份验证令牌存储到 Block Store，以供日后检索。
2. 令牌将存储在本地，还可以备份到云端，并尽可能进行端到端加密。
3. 当用户在新设备上启动恢复流程时，系统会传输数据。
4. 如果用户在恢复流程中恢复应用，则应用随后可以从新设备上的 Block Store 中检索已保存的令牌。

保存令牌

当用户登录您的应用时，您可以将为该用户生成的身份验证令牌保存到 Block Store。您可以使用唯一密钥对值存储此令牌，每个条目的大小不得超过 4kb。如需存储令牌，请对 StoreBytesData.Builder 实例调用 setBytes() 和 setKey()，以将用户的凭据存储到源设备。使用块存储保存令牌后，令牌会被加密并存储在设备本地。

以下示例展示了如何将身份验证令牌保存到本地设备：

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() API 保存数据，建议您开始使用密钥保存令牌。 之前使用 StoreBytes 保存的数据现在使用键 BlockstoreClient.DEFAULT_BYTES_DATA_KEY 保存。

使用默认令牌

通过没有键的 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)
    }

设备上的数据是如何存储的？谁可以访问这些数据？

在设备上，BlockStore 数据存储在 Google Play 服务的本地私有数据目录中。其他应用无法直接访问数据文件。它们只能通过 retrieveBytes() API 访问 BlockStore 数据，而应用只能检索自行存储的数据。Google Play 服务会检查软件包名称和签名。

检索令牌

之后，当用户在新设备上执行恢复流程时，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)
  }

retrieveBytes() 弃用。

已废弃 retrieveBytes()，如需检索字节，可以在 RetrieveBytesRequest 实例中使用键 BlockstoreClient.DEFAULT_BYTES_DATA_KEY，以获取保存的数据

以下示例展示了如何检索默认密钥。

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 时，块存储会定期将存储的字节备份到云端。

以下示例展示了如何仅在云端备份经过端到端加密时启用云端备份：

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.")
          }
        }

注意： 如果调用 storeBytes 时未使用 shouldBackupToCloud 或设置为 false，则之前备份到云端的字节将在下次定期同步时从云端删除。

测试方法

您可以在开发期间使用以下方法测试恢复流程。

卸载/重新安装同一设备

如果用户启用了备份服务（可以通过依次点击设置 > Google > 备份进行检查），在卸载/重新安装应用时保留 Block Store 数据。

您可以按照以下步骤进行测试：

1. 将 BlockStore API 集成到您的测试应用。
2. 使用测试应用调用 BlockStore API，以存储您的数据。
3. 卸载测试应用，然后在同一设备上重新安装应用。
4. 使用测试应用调用 BlockStore API，以检索您的数据。
5. 确认检索到的字节与卸载前存储的字节相同。

注意 ：由于测试跨设备恢复功能需要执行更多步骤，因此建议您先使用卸载/重新安装情形来验证应用与 BlockStore API 的集成。

设备到设备

在大多数情况下，这需要将目标设备恢复出厂设置。然后，您可以进入 Android 无线恢复流程或 Google 数据线恢复（适用于受支持的设备）。

注意 ：如果目标设备是 Samsung Galaxy，您可以通过在设置流程之外启动智能开关来进入恢复流程。

云端恢复

1. 将 Blockstore API 集成到您的测试应用。您需要将测试应用提交到 Play 商店。
2. 在源设备上，在 shouldBackUpToCloud 设置为 true 的情况下，使用测试应用调用 Blockstore API 来存储您的数据。
3. 对于 Android O 及更高版本的设备，您可以手动触发 Block Store 云备份：依次前往设置 > Google > 备份，然后点击“立即备份”按钮。
   1. 如需验证 Block Store 云备份是否成功，您可以：
      1. 备份完成后，搜索带有“CloudSyncBpTkSvc”标记的日志行。
      2. 您应该会看到如下所示的行：“......, CloudSyncBpTkSvc: sync result: SUCCESS, ..., uploaded size: XXX bytes ...”
   2. 在 Block Store 云备份之后，会有 5 分钟的“冷却”期。 在这 5 分钟内，点击“立即备份”按钮不会触发另一次 Block Store 云备份。
4. 将目标设备恢复出厂设置，然后执行云端恢复流程。选择即可在恢复流程中恢复您的测试应用。如需详细了解云恢复流程，请参阅支持的云恢复流程。
5. 在目标设备上，使用测试应用调用 Blockstore API 来检索您的数据。
6. 验证检索到的字节数是否与源设备中存储的字节数相同。

设备要求

端到端加密

• 搭载 Android 9 (API 29) 及更高版本的设备支持端到端加密。
• 设备必须设置了 PIN 码、图案或密码屏锁，才能启用端到端加密并正确加密用户数据。

注意 ：如果不满足上述任何条件，isEndtoEndEncryptionAvailable() 将返回 false。

设备间恢复流程

如要进行设备到设备恢复，您必须拥有源设备和目标设备。这两个设备将用来传输数据。

源设备必须搭载 Android 6 (API 23) 及更高版本才能进行备份。

定位搭载 Android 9 (API 29) 及更高版本的设备，以便能够进行恢复。

如需详细了解设备到设备的恢复流程，请点击此处。

云端备份和恢复流程

云端备份和恢复功能将需要使用源设备和目标设备。

源设备必须搭载 Android 6 (API 23) 及更高版本才能进行备份。

目标设备取决于其供应商。Pixel 设备可以从 Android 9 (API 29) 开始使用此功能，并且所有其他设备必须搭载 Android 12 (API 31) 或更高版本。