Xử lý lỗi xác minh số điện thoại Firebase trên Android

Khi lệnh gọi đến thư viện Firebase PNV không thành công, thư viện sẽ báo cáo FirebasePhoneNumberVerificationException. Trang này liệt kê mọi mã lỗi mà ngoại lệ có thể mang theo, thời điểm xảy ra từng mã lỗi và những việc ứng dụng của bạn nên làm.

Trang này giả định rằng bạn đã tích hợp Firebase PNV như mô tả trong phần Bắt đầu sử dụng Firebase Phone Number Verification trên Android.

Cách báo cáo lỗi

• Các phương thức không đồng bộ (getVerificationSupportInfo(), getVerifiedPhoneNumber() và các phương thức quy trình tuỳ chỉnh) trả về một Task. Khi các lệnh này không thành công, Task sẽ không thành công kèm theo FirebasePhoneNumberVerificationException mà bạn nhận được trong addOnFailureListener.

• enableTestSession() có tính đồng bộ. Thao tác này sẽ trực tiếp tạo một FirebasePhoneNumberVerificationException.

Đọc errorCode của ngoại lệ để tìm hiểu xem có vấn đề gì. Mã Firebase PNV là hằng số trong lớp FirebasePnvStatusCodes. Nếu lỗi là do Dịch vụ Google Play, thì errorCode cũng có thể là một giá trị CommonStatusCodes, chẳng hạn như NETWORK_ERROR.

Thiết bị hoặc SIM không được hỗ trợ không phải là lỗi. getVerificationSupportInfo() thành công và báo cáo isSupported() là false cho SIM đó, còn getReason() cho bạn biết lý do. Xem Thiết bị và SIM không được hỗ trợ.

Mã lỗi

Thiết lập phiên kiểm thử

enableTestSession() sẽ gửi các lỗi này một cách đồng bộ.

Xác minh

Những lỗi này khiến Task do getVerifiedPhoneNumber() trả về không thành công.

Kiểm tra khả năng hỗ trợ

Task do getVerificationSupportInfo() trả về chỉ không thành công nếu bản thân quy trình kiểm tra không thể chạy. Trong trường hợp đó, errorCode là giá trị CommonStatusCodes của Dịch vụ Google Play hoặc CARRIER_NOT_SUPPORTED. Coi thiết bị là không được hỗ trợ và quay lại một phương thức xác minh khác, chẳng hạn như SMS.

Khi một phiên kiểm thử được bật, getVerificationSupportInfo() sẽ không liên hệ với phần phụ trợ Firebase PNV và luôn báo cáo SIM kiểm thử là được hỗ trợ, ngay cả khi mã thông báo kiểm thử đã hết hạn.

Quy trình tuỳ chỉnh

Nếu bạn sử dụng quy trình tuỳ chỉnh thay vì getVerifiedPhoneNumber():

• getDigitalCredentialPayload() không thành công với PREFLIGHT_CHECK_FAILED hoặc với INVALID_TEST_NUMBER_ID nếu phần phụ trợ từ chối mã thông báo kiểm thử của bạn.
• exchangeCredentialResponseForPhoneNumber() không thành công với INVALID_DIGITAL_CREDENTIAL_RESPONSE hoặc với INVALID_TEST_NUMBER_ID nếu phần phụ trợ từ chối mã thông báo kiểm thử của bạn.
• Lệnh gọi của riêng bạn đến Trình quản lý thông tin xác thực sẽ gửi một GetCredentialException mà bạn xử lý trực tiếp.

Thiết bị và SIM không được hỗ trợ

Khi isSupported() là false cho một SIM, getReason() sẽ trả về một trong các giá trị VerificationSupportStatus sau:

Trong mỗi trường hợp, hãy sử dụng một phương thức xác minh khác, chẳng hạn như SMS, cho SIM đó.

Ví dụ

Ví dụ sau đây xử lý các lỗi mà một ứng dụng thông thường cần phân biệt khi gọi 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()
        }
    }
}

Trong ví dụ này, showSmsVerification() là quy trình xác minh số điện thoại hiện có của ứng dụng.

Các bước tiếp theo

• Để biết thông tin chi tiết về từng lớp và hằng số, hãy xem Tài liệu tham khảo API Firebase PNV.
• Để xác minh mã thông báo trên máy chủ, hãy xem bài viết Xác minh mã thông báo Firebase PNV.