在 Realm 中处理动态键名和值的最佳实践

本文档旨在指导开发者如何在 Realm 数据库中有效地处理具有动态键名和值的 JSON 数据结构，特别是在 React Native 环境下使用 Realm Flexible Sync 时。我们将探讨如何定义 Realm 的 schema，以便能够灵活地存储和检索包含动态对象 ID 作为键的嵌套数据，并提供代码示例和注意事项，帮助开发者构建健壮且可维护的数据模型。

理解问题背景

在处理来自 API 或其他数据源的 JSON 数据时，我们经常会遇到键名是动态生成的情况，例如对象 ID。直接将这些数据映射到静态的 Realm schema 可能会遇到挑战。例如，一个包含 group_taxes 属性的 JSON 对象，其内部的键名是动态的对象 ID，每个 ID 对应一组税务属性。

解决方案：使用 Realm 列表存储对象

Realm 本身并不直接支持动态键名的字典结构，但我们可以通过将数据结构转换为列表来解决这个问题。具体来说，我们可以将 group_taxes 属性定义为一个 Realm 列表，列表中的每个元素都是一个包含税务信息的对象。

1. 定义 Realm 对象模型

首先，我们需要定义一个 Realm 对象模型来表示每个税务条目。这个模型将包含 tax_id、tax_name、tax_rate、calculated_tax 和 tax_calculation 等属性。

import Realm from 'realm';

class TaxObject extends Realm.Object {
  static schema = {
    name: 'TaxObject',
    properties: {
      tax_id: 'string', // 使用字符串存储 ObjectId
      tax_name: 'string',
      tax_rate: 'double',
      calculated_tax: 'double',
      tax_calculation: 'string', // 可以使用 enum，例如 'PERCENTAGE' 或 'FLAT_VALUE'
    },
  };
}

在这个模型中，tax_id 字段被定义为字符串类型，因为 Realm 不直接支持动态的 ObjectId 作为键名。

2. 定义包含列表的父对象模型

接下来，我们需要定义一个父对象模型，该模型包含一个 group_taxes 属性，该属性是一个 TaxObject 对象的列表。

class YourParentObject extends Realm.Object {
  static schema = {
    name: 'YourParentObject',
    primaryKey: '_id', // 建议添加主键
    properties: {
      _id: 'objectId',
      group_taxes: { type: 'list', objectType: 'TaxObject' },
    },
  };
}

在这个模型中，group_taxes 属性被定义为 TaxObject 对象的列表。这意味着我们可以将 JSON 数据中的每个税务条目转换为一个 TaxObject 实例，并将它们添加到这个列表中。

Convai Technologies Inc.

对话式 AI API，用于设计游戏和支持端到端的语音交互

下载

3. 将 JSON 数据转换为 Realm 对象

现在，我们需要将 JSON 数据转换为 Realm 对象。以下是一个示例函数，演示了如何将 JSON 数据转换为 YourParentObject 实例。

function convertJsonToRealmObject(jsonData) {
  const realm = new Realm({ schema: [YourParentObject, TaxObject] });

  realm.write(() => {
    const parentObject = realm.create('YourParentObject', {
      _id: new Realm.BSON.ObjectId(), // 创建一个新的 ObjectId
      group_taxes: [],
    });

    for (const taxId in jsonData.group_taxes) {
      if (jsonData.group_taxes.hasOwnProperty(taxId)) {
        const taxData = jsonData.group_taxes[taxId];
        const taxObject = realm.create('TaxObject', {
          tax_id: taxId, // 存储原始的 ObjectId 字符串
          tax_name: taxData.tax_name,
          tax_rate: taxData.tax_rate,
          calculated_tax: taxData.calculated_tax,
          tax_calculation: taxData.tax_calculation,
        });

        parentObject.group_taxes.push(taxObject);
      }
    }
  });

  return realm.objectForPrimaryKey('YourParentObject', parentObject._id);
}

这个函数首先创建一个新的 YourParentObject 实例，然后遍历 JSON 数据中的 group_taxes 属性。对于每个税务条目，它创建一个新的 TaxObject 实例，并将其添加到 YourParentObject 实例的 group_taxes 列表中。

4. 使用 Flexible Sync

如果您在使用 Realm Flexible Sync，您需要确保您的权限规则允许用户读取和写入 YourParentObject 和 TaxObject 对象。您还需要确保您的订阅包含必要的查询，以便用户可以访问他们需要的数据。

示例代码

以下是一个完整的示例，演示了如何使用上述方法将 JSON 数据存储到 Realm 数据库中。

import Realm from 'realm';

class TaxObject extends Realm.Object {
  static schema = {
    name: 'TaxObject',
    properties: {
      tax_id: 'string', // 使用字符串存储 ObjectId
      tax_name: 'string',
      tax_rate: 'double',
      calculated_tax: 'double',
      tax_calculation: 'string', // 可以使用 enum，例如 'PERCENTAGE' 或 'FLAT_VALUE'
    },
  };
}

class YourParentObject extends Realm.Object {
  static schema = {
    name: 'YourParentObject',
    primaryKey: '_id', // 建议添加主键
    properties: {
      _id: 'objectId',
      group_taxes: { type: 'list', objectType: 'TaxObject' },
    },
  };
}

function convertJsonToRealmObject(jsonData) {
  const realm = new Realm({ schema: [YourParentObject, TaxObject] });

  let parentObject;

  realm.write(() => {
    parentObject = realm.create('YourParentObject', {
      _id: new Realm.BSON.ObjectId(), // 创建一个新的 ObjectId
      group_taxes: [],
    });

    for (const taxId in jsonData.group_taxes) {
      if (jsonData.group_taxes.hasOwnProperty(taxId)) {
        const taxData = jsonData.group_taxes[taxId];
        const taxObject = realm.create('TaxObject', {
          tax_id: taxId, // 存储原始的 ObjectId 字符串
          tax_name: taxData.tax_name,
          tax_rate: taxData.tax_rate,
          calculated_tax: taxData.calculated_tax,
          tax_calculation: taxData.tax_calculation,
        });

        parentObject.group_taxes.push(taxObject);
      }
    }
  });

  return parentObject; // 直接返回 parentObject，不需要再从 Realm 中查找
}


// 示例 JSON 数据
const jsonData = {
    "group_taxes": {
        "63bbb1372aea3a5f887b4d0e": {
            "tax_id": {
                "$oid": "63bbb1372aea3a5f887b4d0e"
            },
            "tax_name": "CGST",
            "tax_rate": 10,
            "calculated_tax": 44,
            "tax_calculation": "PERCENTAGE"
        },
        "63bbb1372aea3a5f887b4d10": {
            "tax_id": {
                "$oid": "63bbb1372aea3a5f887b4d10"
            },
            "tax_name": "SGST",
            "tax_rate": 20,
            "calculated_tax": 20,
            "tax_calculation": "FLAT_VALUE"
        }
    }
};

// 将 JSON 数据转换为 Realm 对象
const realmObject = convertJsonToRealmObject(jsonData);

// 打印 Realm 对象
console.log(realmObject);

注意事项

• 数据类型选择： 根据实际情况选择合适的数据类型。例如，tax_rate 和 calculated_tax 可以使用 double 类型，tax_calculation 可以使用 string 类型，并配合枚举值进行验证。
• 主键： 建议为 YourParentObject 添加主键，以便更轻松地查找和更新对象。
• 性能： 如果 group_taxes 列表非常大，可能会影响性能。可以考虑使用分页或懒加载等技术来优化性能。
• 数据验证： 在将 JSON 数据转换为 Realm 对象之前，应该进行数据验证，以确保数据的完整性和准确性。

总结

通过将动态键名的 JSON 数据结构转换为 Realm 列表，我们可以有效地存储和检索这些数据。这种方法不仅灵活，而且易于维护。在实际应用中，应该根据具体的需求选择合适的数据类型和优化策略，以确保应用的性能和稳定性。