Kotlin编写Firestore用户名存在性校验逻辑时报错该如何排查

核心报错点排查 #

• 接口方法未加override关键字：Kotlin中实现接口方法必须显式添加override修饰符，原代码中onEvent方法未加修饰符，会触发编译错误。
• 回调参数顺序倒置：Firebase Firestore的EventListener回调参数顺序为先异常、后快照，原代码把QuerySnapshot放在第一个参数位，运行时会触发类型匹配错误。
• 循环变量引用错误：遍历documentSnapshots得到的单文档变量是ds，原代码中错误调用了不存在的document变量读取字段，会触发未定义变量报错。
• 缺失异常判断逻辑：未对回调返回的FirebaseFirestoreException做非空判断，请求失败时会直接触发空指针异常。
• 字段名不匹配：查询条件用的是nickname字段匹配，读取时却取username字段，会导致读取到空值，逻辑不统一。
• 不必要的实时监听：仅校验用户名是否存在的场景不需要使用SnapshotListener实时监听，该接口会持续驻留内存，不及时销毁会引发内存泄漏，更适合用一次性查询接口get()实现。

修正后可运行代码 #

一次性查询版（推荐） #

val mQuery: Query = firestore.collection("users")
    .whereEqualTo("nickname", mUserName)

mQuery.get()
    .addOnSuccessListener { snapshots ->
        if (!snapshots.isEmpty) {
            // 存在匹配用户名
            Log.d(TAG, "checkingIfusernameExist: FOUND A MATCH: $mUserName")
            Toast.makeText(
                this@SignUpActivity,
                "该用户名已存在",
                Toast.LENGTH_SHORT
            ).show()
        }
    }
    .addOnFailureListener { e ->
        Log.w(TAG, "查询用户名失败", e)
    }

实时监听修正版（如有实时监听需求使用） #

val mQuery: Query = firestore.collection("users")
    .whereEqualTo("nickname", mUserName)

// 保存监听注册引用，页面销毁时需调用remove()释放
val listenerRegistration = mQuery.addSnapshotListener { e, documentSnapshots ->
    // 优先处理异常
    if (e != null) {
        Log.w(TAG, "监听用户名查询失败", e)
        return@addSnapshotListener
    }
    documentSnapshots?.let { snapshots ->
        if (!snapshots.isEmpty) {
            Log.d(TAG, "checkingIfusernameExist: FOUND A MATCH: $mUserName")
            Toast.makeText(
                this@SignUpActivity,
                "该用户名已存在",
                Toast.LENGTH_SHORT
            ).show()
        }
    }
}

额外注意事项 #

• 请确保已在Firestore控制台为users集合的nickname字段添加了单字段索引，否则查询会触发索引缺失错误。
• 若使用实时监听版本，务必在Activity的onStop/onDestroy生命周期中调用listenerRegistration.remove()移除监听，避免内存泄漏。

内容的提问来源于stack exchange，提问作者Grigroviska