จัดการข้อผิดพลาดในการยืนยันหมายเลขโทรศัพท์ของ Firebase ใน Android

เมื่อการเรียกใช้ไลบรารี Firebase PNV ล้มเหลว ไลบรารีจะรายงาน FirebasePhoneNumberVerificationException หน้านี้จะแสดงรหัสข้อผิดพลาดทั้งหมดที่ข้อยกเว้นอาจมี เมื่อเกิดข้อผิดพลาดแต่ละรายการ และสิ่งที่แอปควรทำเกี่ยวกับข้อผิดพลาดนั้น

หน้านี้ถือว่าคุณได้ผสานรวม Firebase PNV ตามที่อธิบายไว้ในเริ่มต้นใช้งาน Firebase Phone Number Verification ใน Android แล้ว

วิธีรายงานข้อผิดพลาด

• เมธอดแบบอะซิงโครนัส (getVerificationSupportInfo(), getVerifiedPhoneNumber() และเมธอดขั้นตอนที่กำหนดเอง) จะแสดงผล Task เมื่อการตรวจสอบล้มเหลว Task จะล้มเหลวพร้อมกับ FirebasePhoneNumberVerificationException ซึ่งคุณจะได้รับใน addOnFailureListener

• enableTestSession() เป็นแบบซิงโครนัส โดยจะปาFirebasePhoneNumberVerificationExceptionใส่โดยตรง

อ่าน errorCode ของข้อยกเว้นเพื่อดูว่าเกิดข้อผิดพลาดใดขึ้น รหัส Firebase PNV เป็นค่าคงที่ในคลาส FirebasePnvStatusCodes หากความล้มเหลวมาจากบริการ Google Play errorCode อาจเป็นค่า CommonStatusCodes เช่น NETWORK_ERROR ได้ด้วย

อุปกรณ์หรือซิมที่ไม่รองรับไม่ใช่ข้อผิดพลาด getVerificationSupportInfo() สำเร็จและรายงาน isSupported() เป็น false สำหรับซิมนั้น และ getReason() จะบอกเหตุผลให้คุณทราบ ดูอุปกรณ์และซิมที่ไม่รองรับ

รหัสข้อผิดพลาด

การตั้งค่าเซสชันการทดสอบ

ข้อผิดพลาดเหล่านี้จะแสดงพร้อมกันโดย enableTestSession()

การยืนยัน

ข้อผิดพลาดเหล่านี้ทำให้ Task ที่ getVerifiedPhoneNumber() แสดงผลไม่สำเร็จ

การตรวจสอบการสนับสนุน

Task ที่แสดงผลโดย getVerificationSupportInfo() จะไม่สำเร็จก็ต่อเมื่อการตรวจสอบไม่สามารถทำงานได้ ในกรณีนี้ errorCode จะเป็นค่า CommonStatusCodes ของบริการ Google Play หรือ CARRIER_NOT_SUPPORTED ถือว่าอุปกรณ์ไม่รองรับและเปลี่ยนไปใช้วิธีการยืนยันอื่น เช่น SMS

ขณะที่เปิดใช้เซสชันการทดสอบ getVerificationSupportInfo() จะไม่ติดต่อแบ็กเอนด์ Firebase PNV และจะรายงานซิมทดสอบว่ารองรับเสมอ แม้ว่าโทเค็นทดสอบจะหมดอายุแล้วก็ตาม

โฟลว์ที่กำหนดเอง

หากคุณใช้ขั้นตอนที่กำหนดเองแทนgetVerifiedPhoneNumber() ให้ทำดังนี้

• getDigitalCredentialPayload() ดำเนินการไม่สำเร็จโดยมีข้อผิดพลาด PREFLIGHT_CHECK_FAILED หรือ INVALID_TEST_NUMBER_ID หากแบ็กเอนด์ปฏิเสธโทเค็นทดสอบ
• exchangeCredentialResponseForPhoneNumber() ล้มเหลวพร้อมข้อความ INVALID_DIGITAL_CREDENTIAL_RESPONSE หรือ INVALID_TEST_NUMBER_ID หากแบ็กเอนด์ปฏิเสธโทเค็นทดสอบ
• การเรียกใช้ Credential Manager ของคุณเองจะแสดง GetCredentialException ซึ่งคุณจะจัดการโดยตรง

อุปกรณ์และซิมที่ไม่รองรับ

เมื่อ isSupported() เป็น false สำหรับซิม getReason() จะแสดงผลค่า VerificationSupportStatus ค่าใดค่าหนึ่งต่อไปนี้

ในแต่ละกรณี ให้ใช้วิธีการยืนยันอื่น เช่น SMS สำหรับซิมนั้น

ตัวอย่าง

ตัวอย่างต่อไปนี้จะจัดการข้อผิดพลาดที่แอปทั่วไปต้องแยกแยะเมื่อเรียกใช้ getVerifiedPhoneNumber()

import android.util.Log
// Credential Manager is included with the Firebase PNV library.
import androidx.credentials.exceptions.GetCredentialCancellationException
import com.google.firebase.pnv.FirebasePhoneNumberVerification
import com.google.firebase.pnv.FirebasePhoneNumberVerificationException
import com.google.firebase.pnv.FirebasePnvStatusCodes

private const val TAG = "PhoneVerification"

// In your Activity:
private fun verifyPhoneNumber() {
    FirebasePhoneNumberVerification.getInstance()
        .getVerifiedPhoneNumber(this)
        .addOnSuccessListener { result ->
            // Send result.getToken() to your backend.
        }
        .addOnFailureListener { e -> handleFpnvError(e) }
}

private fun handleFpnvError(e: Exception) {
    if (e !is FirebasePhoneNumberVerificationException) {
        Log.w(TAG, "Firebase PNV failed", e)
        showSmsVerification()
        return
    }
    when (e.errorCode) {
        FirebasePnvStatusCodes.CREDENTIAL_MANAGER_ERROR -> {
            if (e.cause is GetCredentialCancellationException) {
                // The user dismissed the consent screen.
            }
            showSmsVerification()
        }
        FirebasePnvStatusCodes.INVALID_TEST_NUMBER_ID -> {
            // Test mode only: generate a new test token.
            Log.e(TAG, "Firebase PNV test token rejected", e)
        }
        FirebasePnvStatusCodes.ACTIVITY_CONTEXT_REQUIRED -> {
            // App bug: pass an Activity to getVerifiedPhoneNumber().
            Log.e(TAG, "Firebase PNV needs an Activity context", e)
        }
        else -> {
            // Carrier not supported, network errors, and other failures.
            Log.w(TAG, "Firebase PNV failed with error code ${e.errorCode}", e)
            showSmsVerification()
        }
    }
}

ในตัวอย่างนี้ showSmsVerification() คือขั้นตอนการยืนยันหมายเลขโทรศัพท์ที่มีอยู่ของแอป

ขั้นตอนถัดไป

• ดูรายละเอียดเกี่ยวกับคลาสและค่าคงที่แต่ละรายการได้ที่เอกสารอ้างอิง API ของ Firebase PNV
• หากต้องการยืนยันโทเค็นในเซิร์ฟเวอร์ โปรดดูยืนยันโทเค็น Firebase PNV