Chặn cửa hàng

Nhiều người dùng vẫn quản lý thông tin xác thực của riêng họ khi thiết lập một thiết bị mới chạy Android. Quy trình thủ công này có thể trở nên khó khăn và thường dẫn đến trải nghiệm người dùng kém. Block Store API (một thư viện do Dịch vụ Google Play cung cấp) sẽ giải quyết vấn đề này bằng cách cung cấp một cách để ứng dụng lưu thông tin đăng nhập của người dùng mà không gây phức tạp hoặc rủi ro bảo mật liên quan đến việc lưu mật khẩu của người dùng.

Block Store API cho phép ứng dụng của bạn lưu trữ dữ liệu mà sau này ứng dụng có thể truy xuất để xác thực lại người dùng trên thiết bị mới. Điều này giúp mang đến cho người dùng một trải nghiệm liền mạch hơn, vì họ không cần phải thấy màn hình đăng nhập khi mở ứng dụng của bạn lần đầu tiên trên thiết bị mới.

Sau đây là các lợi ích của việc sử dụng Block Store:

  • Giải pháp lưu trữ thông tin xác thực được mã hoá dành cho nhà phát triển. Thông tin xác thực được mã hoá hai đầu khi có thể.
  • Lưu mã thông báo thay vì tên người dùng và mật khẩu.
  • Loại bỏ sự phiền hà trong quy trình đăng nhập.
  • Giúp người dùng không phải lo lắng về việc quản lý mật khẩu phức tạp.
  • Google xác minh danh tính của người dùng.

Trước khi bắt đầu

Để chuẩn bị cho ứng dụng của bạn, hãy hoàn tất các bước trong những phần sau.

Định cấu hình ứng dụng

Trong tệp build.gradle cấp dự án, hãy thêm kho lưu trữ Maven của Google vào cả hai mục buildscriptallprojects:

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

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

Thêm phần phụ thuộc Dịch vụ Google Play dành cho API Block Store vào tệp bản dựng Gradle của mô-đun, thường là app/build.gradle:

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

Cách hoạt động

Block Store cho phép nhà phát triển lưu và khôi phục tối đa 16 mảng byte. Điều này cho phép bạn lưu thông tin quan trọng liên quan đến phiên người dùng hiện tại và cho phép bạn linh hoạt lưu thông tin này theo cách bạn muốn. Dữ liệu này có thể được mã hoá hai đầu và cơ sở hạ tầng hỗ trợ Block Store được xây dựng dựa trên cơ sở hạ tầng Sao lưu và khôi phục.

Hướng dẫn này sẽ đề cập đến trường hợp sử dụng của việc lưu mã thông báo của người dùng vào Block Store. Các bước sau đây trình bày cách hoạt động của một ứng dụng sử dụng Block Store:

  1. Trong quy trình xác thực của ứng dụng hoặc bất cứ lúc nào sau đó, bạn có thể lưu trữ mã thông báo xác thực của người dùng vào Block Store để truy xuất sau này.
  2. Mã thông báo sẽ được lưu trữ cục bộ và cũng có thể được sao lưu vào đám mây, được mã hoá hai đầu khi có thể.
  3. Dữ liệu được chuyển khi người dùng bắt đầu quy trình khôi phục trên một thiết bị mới.
  4. Nếu người dùng khôi phục ứng dụng của bạn trong quy trình khôi phục, thì ứng dụng của bạn có thể truy xuất mã thông báo đã lưu từ Block Store trên thiết bị mới.

Lưu mã thông báo

Khi người dùng đăng nhập vào ứng dụng, bạn có thể lưu mã thông báo xác thực mà bạn tạo cho người dùng đó vào Block Store. Bạn có thể lưu trữ mã thông báo này bằng cách sử dụng một giá trị cặp khoá duy nhất có kích thước tối đa 4kb cho mỗi mục nhập. Để lưu trữ mã thông báo, hãy gọi setBytes()setKey() trên một thực thể của StoreBytesData.Builder để lưu trữ thông tin xác thực của người dùng vào thiết bị nguồn. Sau khi bạn lưu mã thông báo bằng Block Store, mã thông báo sẽ được mã hoá và lưu trữ cục bộ trên thiết bị.

Mẫu sau đây cho biết cách lưu mã xác thực vào thiết bị cục bộ:

JavaKotlin
  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));
  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)
    }

Sử dụng mã thông báo mặc định

Dữ liệu được lưu bằng StoreBytes mà không có khoá sẽ sử dụng khoá mặc định BlockstoreClient.DEFAULT_BYTES_DATA_KEY.

JavaKotlin
  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));
  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)
    }

Truy xuất mã thông báo

Sau đó, khi người dùng thực hiện quy trình khôi phục trên thiết bị mới, trước tiên, các dịch vụ của Google Play sẽ xác minh người dùng, sau đó truy xuất dữ liệu Block Store của bạn. Người dùng đã đồng ý khôi phục dữ liệu ứng dụng của bạn trong quy trình khôi phục, vì vậy, bạn không cần phải yêu cầu thêm sự đồng ý. Khi người dùng mở ứng dụng, bạn có thể yêu cầu mã thông báo từ Block Store bằng cách gọi retrieveBytes(). Sau đó, bạn có thể sử dụng mã thông báo đã truy xuất để giữ cho người dùng đăng nhập trên thiết bị mới.

Mẫu sau đây cho thấy cách truy xuất nhiều mã thông báo dựa trên các khoá cụ thể.

JavaKotlin
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<String, BlockstoreData> blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry<String, BlockstoreData> 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));
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)
  }

Truy xuất tất cả mã thông báo.

Dưới đây là ví dụ về cách truy xuất tất cả mã thông báo đã lưu vào BlockStore.

JavaKotlin
BlockstoreClient client = Blockstore.getClient(this)

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

client.retrieveBytes(retrieveRequest)
    .addOnSuccessListener(
        result -> {
          Map<String, BlockstoreData> blockstoreDataMap = result.getBlockstoreDataMap();
          for (Map.Entry<String, BlockstoreData> 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));
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)
  }

Dưới đây là ví dụ về cách truy xuất khoá mặc định.

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

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

Xoá mã thông báo

Bạn có thể phải xoá mã thông báo khỏi BlockStore vì những lý do sau:

  • Người dùng thực hiện quy trình đăng xuất.
  • Mã thông báo đã bị thu hồi hoặc không hợp lệ.

Tương tự như việc truy xuất mã thông báo, bạn có thể chỉ định mã thông báo cần xoá bằng cách đặt một mảng các khoá cần xoá.

Ví dụ sau đây minh hoạ cách xoá một số khoá nhất định:

JavaKotlin
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)
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)

Xoá tất cả mã thông báo

Ví dụ sau đây cho thấy cách xoá tất cả mã thông báo hiện được lưu vào BlockStore:

JavaKotlin
// 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));

  val deleteAllRequest = DeleteBytesRequest.Builder()
  .setDeleteAll(true)
  .build()
retrieve bytes, the key BlockstoreClient.DEFAULT_BYTES_DATA_KEY can be used
in the RetrieveBytesRequest instance in order to get your saved data

The following example shows how to retrieve the default key.

Java

End-to-end encryption

In order for end-to-end encryption to be made available, the device must be running Android 9 or higher, and the user must have set a screen lock (PIN, pattern, or password) for their device. You can verify if encryption will be available on the device by calling isEndToEndEncryptionAvailable().

The following sample shows how to verify if encryption will be available during cloud backup:

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

Bật tính năng sao lưu trên đám mây

Để bật tính năng sao lưu trên đám mây, hãy thêm phương thức setShouldBackupToCloud() vào đối tượng StoreBytesData. Block Store sẽ định kỳ sao lưu vào đám mây các byte được lưu trữ khi setShouldBackupToCloud() được đặt thành true.

Mẫu sau đây cho biết cách bật tính năng sao lưu trên đám mây chỉ khi tính năng sao lưu trên đám mây được mã hoá hai đầu:

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

Cách kiểm thử

Sử dụng các phương thức sau trong quá trình phát triển để kiểm thử quy trình khôi phục.

Gỡ cài đặt/cài đặt lại trên cùng một thiết bị

Nếu người dùng bật Dịch vụ sao lưu (bạn có thể kiểm tra tại Cài đặt > Google > Sao lưu), thì dữ liệu Block Store sẽ được lưu giữ sau khi gỡ cài đặt/cài đặt lại ứng dụng.

Bạn có thể làm theo các bước sau để kiểm thử:

  1. Tích hợp Block Store API vào ứng dụng kiểm thử.
  2. Sử dụng ứng dụng kiểm thử để gọi Block Store API nhằm lưu trữ dữ liệu.
  3. Gỡ cài đặt ứng dụng kiểm thử rồi cài đặt lại ứng dụng trên cùng một thiết bị.
  4. Sử dụng ứng dụng kiểm thử để gọi Block Store API nhằm truy xuất dữ liệu của bạn.
  5. Xác minh rằng các byte được truy xuất giống với những byte được lưu trữ trước khi gỡ cài đặt.

Thiết bị với thiết bị

Trong hầu hết các trường hợp, bạn sẽ phải đặt lại thiết bị mục tiêu về trạng thái ban đầu. Sau đó, bạn có thể vào quy trình khôi phục không dây của Android hoặc khôi phục bằng cáp của Google (đối với các thiết bị được hỗ trợ).

Khôi phục qua đám mây

  1. Tích hợp Block Store API vào ứng dụng kiểm thử. Bạn cần gửi ứng dụng kiểm thử lên Cửa hàng Play.
  2. Trên thiết bị nguồn, hãy sử dụng ứng dụng kiểm thử để gọi Block Store API nhằm lưu trữ dữ liệu của bạn, với shouldBackUpToCloud được đặt thành true.
  3. Đối với các thiết bị chạy Android O trở lên, bạn có thể kích hoạt tính năng sao lưu vào đám mây của Block Store theo cách thủ công: chuyển đến phần Cài đặt > Google > Sao lưu, nhấp vào nút "Sao lưu ngay".
    1. Để xác minh rằng quá trình sao lưu vào đám mây của Block Store đã thành công, bạn có thể:
      1. Sau khi quá trình sao lưu hoàn tất, hãy tìm các dòng nhật ký có thẻ "CloudSyncBpTkSvc".
      2. Bạn sẽ thấy các dòng như sau: “......, CloudSyncBpTkSvc: kết quả đồng bộ hoá: THÀNH CÔNG, ..., kích thước đã tải lên: XXX byte ...”
    2. Sau khi sao lưu Block Store trên đám mây, sẽ có khoảng thời gian "chạy nguội" là 5 phút. Trong vòng 5 phút đó, việc nhấp vào nút "Sao lưu ngay" sẽ không kích hoạt một bản sao lưu Block Store trên đám mây khác.
  4. Đặt lại thiết bị mục tiêu về trạng thái ban đầu và thực hiện quy trình khôi phục trên đám mây. Chọn khôi phục ứng dụng kiểm thử trong quy trình khôi phục. Để biết thêm thông tin về quy trình khôi phục trên đám mây, hãy xem phần Quy trình khôi phục trên đám mây được hỗ trợ.
  5. Trên thiết bị mục tiêu, hãy sử dụng ứng dụng kiểm thử để gọi API Block store nhằm truy xuất dữ liệu của bạn.
  6. Xác minh rằng các byte được truy xuất giống với những byte được lưu trữ trong thiết bị nguồn.

Yêu cầu về thiết bị

Mã hoá hai đầu

  • Tính năng mã hoá hai đầu được hỗ trợ trên các thiết bị chạy Android 9 (API 29) trở lên.
  • Thiết bị phải có phương thức khoá màn hình được đặt bằng mã PIN, hình mở khoá hoặc mật khẩu để bật tính năng mã hoá hai đầu và mã hoá chính xác dữ liệu của người dùng.

Quy trình khôi phục từ thiết bị này sang thiết bị khác

Tính năng khôi phục thiết bị sang thiết bị sẽ yêu cầu bạn có một thiết bị nguồn và một thiết bị đích. Đây sẽ là hai thiết bị đang chuyển dữ liệu.

Thiết bị nguồn phải chạy Android 6 (API 23) trở lên để sao lưu.

Đích đến là các thiết bị chạy Android 9 (API 29) trở lên để có thể khôi phục.

Bạn có thể xem thêm thông tin về quy trình khôi phục từ thiết bị này sang thiết bị khác tại đây.

Quy trình sao lưu và khôi phục trên đám mây

Tính năng sao lưu và khôi phục trên đám mây sẽ yêu cầu một thiết bị nguồn và một thiết bị mục tiêu.

Thiết bị nguồn phải chạy Android 6 (API 23) trở lên để sao lưu.

Các thiết bị Mục tiêu được hỗ trợ dựa trên nhà cung cấp của thiết bị. Các thiết bị Pixel có thể sử dụng tính năng này từ Android 9 (API 29) và tất cả các thiết bị khác phải chạy Android 12 (API 31) trở lên.