如何修复 Android Studio Firebase 模型上的空指针

在使用 Firebase 模型时，可能遇到空指针异常问题。这篇文章将介绍如何修复这个问题。

问题描述

在 Firebase 模型（Firebase Realtime Database 或 Firebase Firestore）中，如果某个字段为空，读取该字段时会返回 null，在亿些场景下，如果没有对 null 进行处理，就会导致空指针异常。

举个例子，在 Firebase Realtime Database 中，我们有以下数据结构：

{
  "user" : {
    "name" : "John",
    "age" : 30
  }
}

在模型中，我们定义了一个 User 类来映射 user 节点。当 age 字段不存在时，读取它的值就会返回 null：

class User {
    String name;
    Integer age;
}

FirebaseDatabase.getInstance().getReference("user").addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        User user = dataSnapshot.getValue(User.class);
        int age = user.age; // 空指针异常
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {

    }
});

解决方法

我们可以通过注解来对 null 进行处理，并指定默认值，这样就可以避免空指针异常问题。

在模型类中使用 @PropertyName 注解

当我们使用 @PropertyName 注解时，可以指定该属性在 Firebase 上的名称，并以此来读写数据。在读取数据时，如果 Firebase 上不存在该名称的属性，就会将该属性设置为 null。

我们可以在 User 类上使用 @PropertyName 注解来给 age 属性指定一个名称：

class User {
    String name;
    @PropertyName("age")
    Integer ageOrNull;
    int age = ageOrNull != null ? ageOrNull : 0;
}

FirebaseDatabase.getInstance().getReference("user").addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        User user = dataSnapshot.getValue(User.class);
        int age = user.age; // 不会再出现空指针异常
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {

    }
});

这里我们将 ageOrNull 设置为 Integer 类型，因为它可以为 null。而 age 属性是 int 类型，不能为 null，我们使用一个三目运算符来判断 ageOrNull 是否为 null，并指定 age 的默认值为 0。

在模型类中使用 @Nullable 注解

在 Firebase 模型中，我们也可以使用 @Nullable 注解来为某个属性指定可为 null。这样在读取该属性时，如果 Firebase 上不存在该属性，也不会出现空指针异常问题。

class User {
    String name;
    @Nullable
    Integer age;
}

FirebaseFirestore.getInstance().collection("users").document("user1").get().addOnSuccessListener(new OnSuccessListener<DocumentSnapshot>() {
    @Override
    public void onSuccess(DocumentSnapshot documentSnapshot) {
        User user = documentSnapshot.toObject(User.class);
        int age = user.age; // 不会再出现空指针异常
    }
});

总结

在 Firebase 模型中使用 @PropertyName 注解或 @Nullable 注解可以避免空指针异常的问题。虽然这两种方式在实现上有所不同，但它们的原理都是为了在读取属性时，给出一个默认值，避免出现 null 的情况。