在 Realm 中使用动态键名对和值的正确数据类型

在 Realm 中使用动态键名对和值的正确数据类型

本文旨在解决在 react native 中使用 Realm Flexible Sync 时,如何为键名动态变化的 json 数据定义 Schema 的问题。我们将探讨如何使用 Realm 的 ArrayObject 类型来正确存储和管理此类数据,并提供代码示例和注意事项,帮助开发者更好地理解和应用。

理解问题

在使用 Realm Flexible Sync 处理 JSON 数据时,如果 JSON 对象的键名是动态的,例如由 ObjectId 组成,并且每个键对应的值又是一个包含多个属性的对象,那么直接使用 mixed 类型可能无法很好地表达数据的结构。我们需要找到一种更精确的方式来定义 Schema,以便 Realm 能够正确地存储和查询数据。

解决方案:使用 Array 和 Object 类型

问题的关键在于将 group_taxes 视为一个包含对象的列表(array),而不是一个简单的键值对集合。每个对象代表一个税种的信息,包含 tax_id、tax_name、tax_rate 等属性。

Schema 定义

以下是一个可能的 Schema 定义示例:

{   "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:你的父对象名称。
  • _id:父对象的唯一标识符
  • group_taxes:一个数组,用于存储税种信息。
  • items:定义了数组中每个元素的类型,这里是 object。
  • properties:定义了每个税种对象的属性,包括 tax_id、tax_name 等。

代码示例

以下是一个使用 Realm 代码定义 Schema 的示例:

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'     },   }; }  class YourParentObject extends Realm.Object {   static schema = {     name: 'YourParentObject',     primaryKey: '_id',     properties: {       _id: 'objectId',       group_taxes: {         type: 'list',         objectType: 'TaxObject',       },     },   }; }

解释:

  1. TaxObject 类: 定义了每个税种对象的数据结构,包括 tax_id、tax_name 等属性。
  2. YourParentObject 类: 定义了包含 group_taxes 属性的父对象。group_taxes 属性的 type 设置为 list,objectType 设置为 TaxObject,表示它是一个包含 TaxObject 对象的列表。
  3. primaryKey: 建议为每个 Realm Object 设置一个主键,便于查找和更新。

插入数据

假设你已经从 API 获取了 JSON 数据,你需要将其转换为 Realm 可以接受的格式。以下是一个示例:

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"         }     } };  const realm = new Realm({ schema: [YourParentObject, TaxObject] });  realm.write(() => {   const taxObjects = [];   for (const key in jsonData.group_taxes) {     const taxData = jsonData.group_taxes[key];     taxObjects.push(realm.create('TaxObject', {       tax_id: taxData.tax_id.$oid,       tax_name: taxData.tax_name,       tax_rate: taxData.tax_rate,       calculated_tax: taxData.calculated_tax,       tax_calculation: taxData.tax_calculation,     }));   }    realm.create('YourParentObject', {     _id: new Realm.BSON.ObjectId(), // 创建一个新的 ObjectId     group_taxes: taxObjects,   }); });

解释:

  1. 循环遍历 JSON 数据: 遍历 jsonData.group_taxes 对象,将每个税种的信息提取出来。
  2. 创建 TaxObject 对象: 使用 realm.create(‘TaxObject’, …) 创建 TaxObject 实例,并将从 JSON 数据中提取的属性值赋给相应的属性。
  3. 创建 YourParentObject 对象: 使用 realm.create(‘YourParentObject’, …) 创建 YourParentObject 实例,并将 taxObjects 列表赋给 group_taxes 属性。

注意事项

  • 数据类型匹配: 确保 Schema 中定义的数据类型与实际数据的类型匹配。例如,如果 tax_id 实际上是一个 ObjectId,则应将其定义为 objectId 类型。
  • 主键: 为每个 Realm Object 设置一个主键,可以提高查询和更新的效率。
  • 开发模式: 在 Realm console 中,如果应用处于开发模式,你可以直接在代码中构建 Realm 模型,Schema 会自动创建。这可以简化开发流程。
  • BSON.ObjectId: 使用 new Realm.BSON.ObjectId() 创建新的 ObjectId。

总结

通过将 group_taxes 视为一个包含对象的列表,并使用 array 和 object 类型定义 Schema,我们可以有效地解决在 Realm 中处理动态键名 JSON 数据的问题。 结合代码示例和注意事项,你可以更好地理解和应用这种方法,从而更高效地使用 Realm Flexible Sync。

© 版权声明
THE END
喜欢就支持一下吧
点赞15 分享