Realm动态键值对存储教程详解

还在为 React Native 应用中 Realm Flexible Sync 存储动态键值对而烦恼吗？本文为你带来详细的解决方案！针对 `group_taxes` 等包含动态 ObjectId 键名的 JSON 数据，我们将探讨如何巧妙地定义 Realm Schema，实现高效的数据存储与管理。告别 `mixed` 类型的模糊定义，本文提供清晰的代码示例，展示如何使用 Array 存储对象列表，定义 `tax_id`、`tax_name`、`tax_rate` 等属性，以及如何利用开发模式自动创建 Schema。掌握这些技巧，轻松解决 React Native 中 Realm 动态键值对存储难题，提升应用性能！

本文旨在解决在 React Native 中使用 Realm Flexible Sync 时，如何定义包含动态键名（ObjectId）的 JSON 数据的 Schema。我们将探讨如何使用 Realm 的 Schema 定义来有效地存储和管理具有动态键名和值的键值对数据，并提供代码示例进行说明。

理解问题

在 React Native 应用中使用 Realm Flexible Sync 时，经常会遇到需要存储具有动态键名的 JSON 数据的情况。例如，一个 group_taxes 属性可能包含多个键值对，其中键是动态的 ObjectId，值是包含税务信息的对象。直接使用 mixed 类型可能无法满足需求，需要更精确的 Schema 定义。

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

一种有效的解决方案是将 group_taxes 定义为一个包含对象列表的数组。每个对象代表一个税务信息，包含 tax_id、tax_name、tax_rate 等属性。

Schema 定义示例

以下是一个示例 Schema 定义，展示了如何使用数组来存储 group_taxes 中的对象列表：

{
  "title": "YourParentObject",
  "type": "object",
  "required": [
    "_id"
  ],
  "properties": {
    "_id": {
      "bsonType": "objectId"
    },
    "group_taxes": {
      "bsonType": "array",
      "items": {
        "bsonType": "object",
        "properties": {
          "tax_id": {
            "bsonType": "objectId"
          },
          "tax_name": {
            "bsonType": "string"
          },
          "tax_rate": {
            "bsonType": "double"
          },
          "calculated_tax": {
            "bsonType": "double"
          },
          "tax_calculation": {
            "bsonType": "string"
          }
        }
      }
    }
  }
}

解释：

• YourParentObject 是包含 group_taxes 属性的父对象。
• group_taxes 的 bsonType 设置为 array，表示它是一个数组。
• items 定义了数组中每个元素的类型。 在这里，我们定义每个元素都是一个 object，并详细描述了每个对象包含的属性及其类型。

代码示例（开发模式自动创建 Schema）

如果在 Realm Console 中启用开发模式，可以在代码中构建 Realm 模型，Schema 将自动创建。 以下是一个代码示例：

import Realm from 'realm';

class TaxObject extends Realm.Object {
  static schema = {
    name: 'TaxObject',
    properties: {
      tax_id: 'string', // 或者 'objectId'，取决于你的 tax_id 存储方式
      tax_name: 'string',
      tax_rate: 'double',
      calculated_tax: 'double',
      tax_calculation: 'string',
    },
  };
}

class YourParentObject extends Realm.Object {
  static schema = {
    name: 'YourParentObject',
    properties: {
      _id: 'objectId',
      group_taxes: {
        type: 'list',
        objectType: 'TaxObject',
        optional: true, // 根据实际情况设置是否可选
      },
    },
  };
}

// 初始化 Realm
const realm = new Realm({ schema: [YourParentObject, TaxObject] });

// 使用示例：创建对象并添加税务信息
realm.write(() => {
  const parentObject = realm.create('YourParentObject', {
    _id: new Realm.BSON.ObjectId(),
    group_taxes: [], // 初始化为空数组
  });

  const tax1 = realm.create('TaxObject', {
    tax_id: '63bbb1372aea3a5f887b4d0e',
    tax_name: 'CGST',
    tax_rate: 10,
    calculated_tax: 44,
    tax_calculation: 'PERCENTAGE',
  });

  const tax2 = realm.create('TaxObject', {
    tax_id: '63bbb1372aea3a5f887b4d10',
    tax_name: 'SGST',
    tax_rate: 20,
    calculated_tax: 20,
    tax_calculation: 'FLAT_VALUE',
  });

  parentObject.group_taxes.push(tax1);
  parentObject.group_taxes.push(tax2);
});

console.log(realm.objects('YourParentObject'));

realm.close();

解释：

1. 定义 TaxObject 类: 定义了存储单个税务信息的 Realm 对象。
2. 定义 YourParentObject 类: 定义了包含 group_taxes 属性的父对象。 group_taxes 的 type 设置为 list，objectType 设置为 TaxObject，表示它是一个包含 TaxObject 对象的列表。
3. 创建 Realm 实例: 使用定义的 Schema 初始化 Realm 实例。
4. 创建对象并添加税务信息: 在 Realm 的 write 事务中，创建 YourParentObject 和 TaxObject 对象，并将 TaxObject 对象添加到 YourParentObject 的 group_taxes 列表中。

注意事项

• 确保 Realm 数据库的版本正确，并在每次修改 Schema 后更新版本。
• 在开发模式下，Realm 会自动创建 Schema，但在生产环境中需要手动定义 Schema。
• 根据实际数据类型选择合适的 bsonType，例如 string、int、double、objectId 等。
• 如果 tax_id 确实是 MongoDB 的 ObjectId 类型，请使用 bsonType: 'objectId'。

总结

通过将包含动态键名的对象存储为数组中的元素，可以有效地解决在 Realm 中存储和管理动态键名数据的难题。 通过合理定义 Schema 和使用 Realm 提供的 API，可以轻松地实现数据的存储和检索。 此外，利用开发模式下的自动 Schema 创建功能可以简化开发流程。

以上就是本文的全部内容了，是否有顺利帮助你解决问题？若是能给你带来学习上的帮助，请大家多多支持golang学习网！更多关于文章的相关知识，也可关注golang学习网公众号。