如何编写Model层代码实现从FirebaseDatabase获取对应数据

1. 对齐数据库结构定义Model类 #

• 类属性必须和Firebase数据库的节点字段完全对应，字段类型匹配，必须添加无参构造方法，这是Firebase序列化反序列化的强制要求
• 需要的字段要配套添加get/set方法，Kotlin开发可以直接定义data class简化代码，Java开发需要手动补全构造方法和get/set逻辑

示例代码（Java）：

public class UserModel {
    private String uid;
    private String username;
    private int age;
    // 必须保留无参构造方法
    public UserModel() {}
    public UserModel(String uid, String username, int age) {
        this.uid = uid;
        this.username = username;
        this.age = age;
    }
    // 此处省略所有字段对应的get、set方法
}

2. 封装数据库引用操作层 #

• 统一管理FirebaseDatabase实例和对应节点的DatabaseReference，避免业务层到处重复初始化实例
  示例代码：

public class FirebaseDbHelper {
    private static volatile FirebaseDbHelper INSTANCE;
    private final DatabaseReference rootRef;
    private FirebaseDbHelper() {
        rootRef = FirebaseDatabase.getInstance().getReference();
    }
    public static FirebaseDbHelper getInstance() {
        if (INSTANCE == null) {
            synchronized (FirebaseDbHelper.class) {
                if (INSTANCE == null) {
                    INSTANCE = new FirebaseDbHelper();
                }
            }
        }
        return INSTANCE;
    }
    // 对外暴露对应业务节点的引用，比如用户信息节点
    public DatabaseReference getUserRef(String uid) {
        return rootRef.child("users").child(uid);
    }
}

3. 封装数据拉取逻辑 #

• 数据请求、解析逻辑统一放在Model层，不要耦合到Activity、Fragment等视图层
• 拉取到数据快照后直接调用getValue(Model类.class)即可自动反序列化为对应Model对象
  示例代码：

public class UserRepository {
    private final DatabaseReference userRef;
    public UserRepository(String uid) {
        userRef = FirebaseDbHelper.getInstance().getUserRef(uid);
    }
    public void fetchUserData(OnFetchDataListener<UserModel> listener) {
        userRef.addListenerForSingleValueEvent(new ValueEventListener() {
            @Override
            public void onDataChange(@NonNull DataSnapshot snapshot) {
                UserModel user = snapshot.getValue(UserModel.class);
                if (user != null) {
                    listener.onSuccess(user);
                } else {
                    listener.onFailure("未匹配到对应数据");
                }
            }
            @Override
            public void onCancelled(@NonNull DatabaseError error) {
                listener.onFailure(error.getMessage());
            }
        });
    }
    // 自定义回调接口透传结果
    public interface OnFetchDataListener<T> {
        void onSuccess(T data);
        void onFailure(String errorMsg);
    }
}

4. 异常排查方案 #

• 若拉取到的Model对象所有字段为空，优先检查Model类字段名是否和数据库节点完全匹配，注意大小写、拼写是否正确
• 确认Model类已经添加无参构造方法，所有字段的get/set方法齐全
• 可在Logcat中打印DataSnapshot的原始返回值，先确认数据库侧返回数据正常，再排查序列化相关问题

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