ผู้ใช้หลายคนยังคงจัดการข้อมูลเข้าสู่ระบบของตนเองเมื่อตั้งค่าอุปกรณ์ Android เครื่องใหม่ กระบวนการที่ต้องดําเนินการด้วยตนเองอาจทําได้ยากและมักจะทําให้ผู้ใช้ได้รับประสบการณ์ที่ไม่ดี API ของบล็อกสโตร์เป็นไลบรารีที่ขับเคลื่อนโดยบริการ Google Play ซึ่งต้องการแก้ปัญหานี้ด้วยวิธีที่ช่วยให้แอปบันทึกข้อมูลเข้าสู่ระบบของผู้ใช้โดยไม่มีความซับซ้อนหรือความเสี่ยงด้านความปลอดภัยที่เกี่ยวข้องกับการบันทึกรหัสผ่านของผู้ใช้
API ของ Store Store ช่วยให้แอปของคุณจัดเก็บข้อมูลที่แอปสามารถตรวจสอบสิทธิ์ผู้ใช้อีกครั้งในอุปกรณ์เครื่องใหม่ได้ภายหลัง วิธีนี้จะช่วยให้ผู้ใช้ได้รับประสบการณ์การใช้งานที่ราบรื่นยิ่งขึ้น เนื่องจากผู้ใช้ไม่จําเป็นต้องเห็นหน้าจอลงชื่อเข้าใช้เมื่อเปิดแอปเป็นครั้งแรกในอุปกรณ์เครื่องใหม่
การใช้บล็อกร้านค้ามีประโยชน์ดังนี้
- โซลูชันพื้นที่เก็บข้อมูลเข้าสู่ระบบที่เข้ารหัสสําหรับนักพัฒนาซอฟต์แวร์ ข้อมูลเข้าสู่ระบบจะได้รับการเข้ารหัสจากต้นทางถึงปลายทางเมื่อเป็นไปได้
- บันทึกโทเค็นแทนชื่อผู้ใช้และรหัสผ่าน
- กําจัดจุดติดขัดในขั้นตอนการลงชื่อเข้าใช้
- บันทึกผู้ใช้จากภาระในการจัดการรหัสผ่านที่ซับซ้อน
- Google ยืนยันตัวตนของผู้ใช้
ข้อควรทราบก่อนที่จะเริ่มต้น
ทําตามขั้นตอนต่อไปนี้เพื่อเตรียมแอป
กําหนดค่าแอป
ในไฟล์ build.gradle
ระดับโปรเจ็กต์ ให้ใส่ที่เก็บ Maven ของ Google ทั้งในส่วน buildscript
และ allprojects
buildscript {
repositories {
google()
mavenCentral()
}
}
allprojects {
repositories {
google()
mavenCentral()
}
}
เพิ่มทรัพยากร Dependency ของ 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 ในอุปกรณ์ใหม่ได้
กําลังบันทึกโทเค็น
เมื่อผู้ใช้ลงชื่อเข้าใช้แอปของคุณ คุณสามารถบันทึกโทเค็นการตรวจสอบสิทธิ์ที่สร้างขึ้นสําหรับผู้ใช้นั้นใน "บล็อกร้านค้า" คุณสามารถจัดเก็บโทเค็นนี้โดยใช้ค่าคู่คีย์ที่ไม่ซ้ํากันซึ่งมีค่าสูงสุด 4KB ต่อรายการ
หากต้องการจัดเก็บโทเค็น ให้เรียกใช้ setBytes()
และ 'setKey(/android/reference/com/google/android/gms/auth/blockstore/StoreBytesData.Builder.html#setKey(java.lang.String)' บนอินสแตนซ์ของ 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 โดยไม่มีคีย์จะใช้คีย์เริ่มต้น StorestoreClient.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 จะยืนยันผู้ใช้ก่อน แล้วจึงดึงข้อมูล "บล็อก" ใน 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
ส่วน "บล็อกร้านค้า" จะสํารองข้อมูลไปยังไบต์ที่จัดเก็บไว้เป็นระยะๆ เมื่อ 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 เพื่อเก็บข้อมูล โดยตั้งค่า ShoBackUpToCloud เป็น "จริง"
- สําหรับอุปกรณ์ O ขึ้นไป คุณทริกเกอร์การสํารองข้อมูลระบบคลาวด์ของ Block Store ด้วยตนเองได้
โดยไปที่การตั้งค่า > Google > การสํารองข้อมูล คลิกปุ่ม "สํารองข้อมูลเลย"
- หากต้องการยืนยันว่าการสํารองข้อมูลระบบคลาวด์ของ Store Store สําเร็จ คุณจะทําสิ่งต่อไปนี้ได้
- หลังจากสํารองข้อมูลเรียบร้อยแล้ว ให้ค้นหาบรรทัดบันทึกที่มีแท็ก "CloudSyncBpTkSvc"
- คุณควรจะเห็นบรรทัดดังนี้ "......, CloudSyncBpTkSvc: Sync result: SUCCESS, ..., uploaded size: XXX bytes ..."
- หลังจากการสํารองข้อมูลในระบบคลาวด์ของบล็อกร้านค้าแล้ว จะมีระยะเวลา "พัก" 5 นาที การคลิกปุ่ม "สํารองข้อมูลเลย" ภายใน 5 นาทีจะไม่ทริกเกอร์การสํารองข้อมูลระบบคลาวด์ของบล็อกร้านค้าอื่น
- หากต้องการยืนยันว่าการสํารองข้อมูลระบบคลาวด์ของ Store 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) ขึ้นไป