ผู้ใช้หลายคนยังคงจัดการข้อมูลเข้าสู่ระบบของตนเองเมื่อตั้งค่าอุปกรณ์ Android ใหม่ กระบวนการที่ดำเนินการด้วยตนเองนี้อาจเป็นเรื่องท้าทายและมักทำให้ผู้ใช้ได้รับประสบการณ์ที่ไม่ดี Block Store API ซึ่งเป็นไลบรารีที่ขับเคลื่อนโดยบริการ Google Play ต้องการแก้ไขปัญหานี้ด้วยการนำเสนอวิธีที่แอปสามารถบันทึกข้อมูลเข้าสู่ระบบของผู้ใช้ได้โดยไม่มีความซับซ้อนหรือความเสี่ยงด้านความปลอดภัยที่เกี่ยวข้องกับการบันทึกรหัสผ่านของผู้ใช้
Block Store API ช่วยให้แอปของคุณสามารถเก็บข้อมูลที่ดึงมาในภายหลังเพื่อตรวจสอบสิทธิ์ผู้ใช้อีกครั้งในอุปกรณ์ใหม่ วิธีนี้ช่วยให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ราบรื่นยิ่งขึ้น เนื่องจากไม่จำเป็นต้องเห็นหน้าจอลงชื่อเข้าใช้เมื่อเปิดแอปเป็นครั้งแรกในอุปกรณ์เครื่องใหม่
ประโยชน์ของการใช้ Block Store มีดังนี้
- โซลูชันที่จัดเก็บข้อมูลรับรองที่เข้ารหัสสำหรับนักพัฒนาซอฟต์แวร์ ข้อมูลเข้าสู่ระบบจะเข้ารหัสจากต้นทางถึงปลายทางเมื่อเป็นไปได้
- บันทึกโทเค็นแทนชื่อผู้ใช้และรหัสผ่าน
- ขจัดความติดขัดในขั้นตอนการลงชื่อเข้าใช้
- ช่วยผู้ใช้ไม่ต้องเสียเวลาจัดการรหัสผ่านที่ซับซ้อน
- Google ยืนยันตัวตนของผู้ใช้
ก่อนเริ่มต้น
ทําตามขั้นตอนในส่วนต่อไปนี้เพื่อเตรียมแอป
กำหนดค่าแอป
ในไฟล์ build.gradle
ระดับโปรเจ็กต์ ให้ใส่ที่เก็บ Maven ของ Google ไว้ทั้งในส่วน buildscript
และ allprojects
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
เพิ่มการอ้างอิงบริการ Google Play สำหรับ Block Store API ไปยังไฟล์บิลด์ Gradle ของโมดูล ซึ่งโดยทั่วไปคือ 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
- ระหว่างขั้นตอนการตรวจสอบสิทธิ์ของแอปหรือหลังจากนั้น คุณสามารถจัดเก็บโทเค็นการตรวจสอบสิทธิ์ของผู้ใช้ไว้ในบล็อกร้านค้าเพื่อดึงข้อมูลในภายหลังได้
- ระบบจะจัดเก็บโทเค็นไว้ในเครื่องและสำรองข้อมูลไปยังระบบคลาวด์ได้ด้วย โดยจะเข้ารหัสจากต้นทางถึงปลายทางเมื่อเป็นไปได้
- ระบบจะโอนข้อมูลเมื่อผู้ใช้เริ่มขั้นตอนการคืนค่าในอุปกรณ์ใหม่
- หากผู้ใช้กู้คืนแอปในระหว่างขั้นตอนการกู้คืน แอปจะเรียกข้อมูลโทเค็นที่บันทึกไว้จาก Block Store ในอุปกรณ์ใหม่ได้
กำลังบันทึกโทเค็น
เมื่อผู้ใช้ลงชื่อเข้าใช้แอป คุณสามารถบันทึกโทเค็นการตรวจสอบสิทธิ์ที่คุณสร้างไว้ให้กับผู้ใช้ดังกล่าวเพื่อบล็อกร้านค้าได้ คุณสามารถจัดเก็บโทเค็นนี้โดยใช้ค่าคู่คีย์ที่ไม่ซ้ำกันซึ่งมีขนาดไม่เกิน 4 KB ต่อรายการ
หากต้องการจัดเก็บโทเค็น ให้เรียกใช้ setBytes()
และ setKey()
บนอินสแตนซ์ของ StoreBytesData.Builder
เพื่อจัดเก็บข้อมูลเข้าสู่ระบบของผู้ใช้ลงในอุปกรณ์ต้นทาง หลังจากที่บันทึกโทเค็นด้วย 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 ของคุณ ผู้ใช้ได้ตกลงที่จะกู้คืนข้อมูลแอปของคุณในขั้นตอนการกู้คืนแล้ว จึงไม่จำเป็นต้องได้รับความยินยอมเพิ่มเติม เมื่อผู้ใช้เปิดแอป คุณจะขอโทเค็นจาก Block Store โดยโทรไปที่ retrieveBytes()
ได้
จากนั้นโทเค็นที่ดึงมาจะใช้เพื่อคงผู้ใช้ลงชื่อเข้าใช้ในอุปกรณ์ใหม่ต่อไป
ตัวอย่างต่อไปนี้แสดงวิธีเรียกโทเค็นหลายรายการตามคีย์ที่เฉพาะเจาะจง
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 ListrequestedKeys = 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 -> { MapblockstoreDataMap = 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 ListrequestedKeys = 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
Block Store จะสำรองข้อมูลไบต์ที่จัดเก็บในระบบคลาวด์เป็นระยะๆ เมื่อมีการตั้งค่า setShouldBackupToCloud()
เป็น "จริง"
ตัวอย่างต่อไปนี้แสดงวิธีเปิดใช้การสำรองข้อมูลในระบบคลาวด์เมื่อข้อมูลสำรองในระบบคลาวด์เข้ารหัสจากต้นทางถึงปลายทางเท่านั้น
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 Store
- ในอุปกรณ์ต้นทาง ให้ใช้แอปทดสอบเพื่อเรียกใช้ Blockstore API เพื่อจัดเก็บข้อมูลของคุณ โดย setBackUpToCloud เป็น "จริง"
- สำหรับอุปกรณ์ O และที่สูงกว่า คุณสามารถทริกเกอร์การสำรองข้อมูลในระบบคลาวด์ของ Block Store ได้ด้วยตนเอง ให้ไปที่การตั้งค่า > Google > การสำรองข้อมูล คลิกปุ่ม "สำรองข้อมูลทันที"
- หากต้องการยืนยันว่าการสำรองข้อมูลในระบบคลาวด์ของ Block Store สำเร็จแล้ว คุณสามารถทำสิ่งต่อไปนี้ได้
- หลังจากสำรองข้อมูลเสร็จแล้ว ให้ค้นหาบรรทัดบันทึกที่มีแท็ก "CloudSyncBpTkSvc"
- คุณควรจะเห็นบรรทัดดังนี้ “......, CloudSyncBpTkSvc:sync result: SUCCESS, ..., ขนาดที่อัปโหลด: XXX ไบต์ ...”
- หลังจากสำรองข้อมูลในระบบคลาวด์ของ Block Store แล้ว ระบบจะ "พัก" เป็นเวลา 5 นาที ภายใน 5 นาทีนั้น การคลิกปุ่ม "สำรองข้อมูลทันที" จะไม่เรียกใช้การสำรองข้อมูลระบบคลาวด์ของบล็อกสโตร์อีก
- หากต้องการยืนยันว่าการสำรองข้อมูลในระบบคลาวด์ของ Block Store สำเร็จแล้ว คุณสามารถทำสิ่งต่อไปนี้ได้
- รีเซ็ตอุปกรณ์เป้าหมายเป็นค่าเริ่มต้นและทําตามขั้นตอนการคืนค่าในระบบคลาวด์ เลือกเพื่อคืนค่าแอปทดสอบในระหว่างขั้นตอนการกู้คืน โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนการคืนค่าระบบคลาวด์ที่หัวข้อขั้นตอนการคืนค่าระบบคลาวด์ที่รองรับ
- ในอุปกรณ์เป้าหมาย ให้ใช้แอปทดสอบเพื่อเรียกใช้ Blockstore API เพื่อดึงข้อมูลของคุณ
- ยืนยันว่าจำนวนไบต์ที่ดึงมาตรงกับไบต์ที่เก็บไว้ในอุปกรณ์ต้นทาง
ข้อกำหนดของอุปกรณ์
การเข้ารหัสจากต้นทางถึงปลายทาง
- ระบบรองรับการเข้ารหัสจากต้นทางถึงปลายทางในอุปกรณ์ที่ใช้ Android 9 (API 29) ขึ้นไป
- อุปกรณ์ต้องตั้งค่าการล็อกหน้าจอด้วย PIN, รูปแบบ หรือรหัสผ่านสำหรับการเปิดใช้การเข้ารหัสจากต้นทางถึงปลายทางเพื่อให้เข้ารหัสข้อมูลของผู้ใช้ได้อย่างถูกต้อง
ขั้นตอนการคืนค่าอุปกรณ์ไปยังอุปกรณ์
คุณจะต้องมีอุปกรณ์ต้นทางและอุปกรณ์เป้าหมายในการคืนค่าอุปกรณ์ไปยังอุปกรณ์ อุปกรณ์เหล่านี้คืออุปกรณ์ 2 เครื่องที่กำลังโอนข้อมูล
อุปกรณ์ต้นทางต้องใช้ Android 6 (API 23) ขึ้นไปเพื่อสำรองข้อมูล
กำหนดเป้าหมายให้อุปกรณ์ที่ใช้ Android 9 (API 29) ขึ้นไปสามารถคืนค่าได้
ดูข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนการคืนค่าอุปกรณ์ไปยังอุปกรณ์ได้ที่นี่
ขั้นตอนการสำรองข้อมูลและคืนค่าระบบคลาวด์
การสำรองและกู้คืนข้อมูลในระบบคลาวด์จะต้องมีอุปกรณ์ต้นทางและอุปกรณ์เป้าหมาย
อุปกรณ์ต้นทางต้องใช้ Android 6 (API 23) ขึ้นไปเพื่อสำรองข้อมูล
ระบบรองรับอุปกรณ์ที่กำหนดเป้าหมายโดยพิจารณาจากผู้ให้บริการ อุปกรณ์ Pixel จะใช้ฟีเจอร์นี้จาก Android 9 (API 29) และอุปกรณ์อื่นๆ ทั้งหมดต้องใช้ Android 12 (API 31) ขึ้นไป