Flutter多功能模型插件omnimodel的使用

本包引入了一个类，该类基本上是一个可以表示为 <code>Map<String, dynamic></code> 的数据包装器。

<strong>OmniModel</strong> 允许以简单且安全的方式访问结构内的数据。该包旨在开发一个简单且模块化的界面，用于与任何非关系型、基于Json的数据库通信。

功能

• OmniModel 可以将数据包裹起来，并允许轻松且安全地访问。
• 包含一些有用的工具，如可抑制的自动日志记录行为，当开发者键入错误时，会建议最接近的匹配项。算法使用了非常精确的相似度卷积算法。

使用方法

步骤

1. 使用各种工厂之一创建 <code>OmniModel</code>。
2. 以受控方式访问条目。
3. 通过递归解析带有 <code>OmniModel.tokenAsModel()</code> 的模型以模块化方式访问嵌套模型。

高级用法可以在 <code>/example</code> 文件夹中找到。

示例

假设有一个包含以下数据的 <code>Map</code>:

data = {
    "name": "Mario",
    "surname": "Rossi",
    "meta":{
        "age": 25,
        "birth_date": null,
        "address": "Via Prima 12",
    },    
    "interests": [
        "Computer Science",
        "Physics",
        "Food",
        "Outdoor",
    ]
}

<strong>OmniModel</strong> 允许安全地包装数据结构，并轻松处理缺失值和默认情况。创建模型并开始使用它：

var model = OmniModel.fromMap(data);

可以通过连接键来访问嵌套字段（默认分隔符为 <code>"."</code>）:

//--> 返回空默认值
var age = model.tokenOrNull<num>("meta.age");

//--> 返回默认值
var birth_date = model.tokenOr<String>("meta.birth_date", "01/01/1970");

//--> 返回不同类型的值
var interests = model.tokenOr<List<String>>("interests", List.empty());

//--> 访问嵌套模型
var metaModel = model.tokenAsModel("meta");
// metaModel 现在是:
//{
//    "age": 25,
//    "birth_date": null,
//    "address": "Via Prima 12",
//}

//--> 用副作用编辑模型，不用担心不存在的嵌套模型，它们会被自动创建
model.edit({
    "birth_date": "08/08/1998",
    "meta.phones": {"mobile":"+39 3331234567"}
});
// 添加兴趣
model.edit({
    "interests": model.tokenOr<List<String>>("interests", List.empty())..add("Maths")
});

//--> 或者获取新的模型实例
var newModel = model.copyWith({
    "birth_date": "08/08/1998",
    "meta.phone": {"mobile":"+39 3331234567"}
});

//--> 获取最接近提供的键的匹配项。使用相似度卷积算法
var closeMatch = model.similar("metadata"); //<--- 将返回 "meta"

Flutter 中的使用

<code>OmniModel</code> 包在声明式编程环境中非常有用。在 <strong>Flutter</strong> 中，防止对每个数据键进行空检查的可能性使代码变得更小且更不易出错。

if(data["meta"] != null && data["meta"]["birth_date"] != null)
    Text(
        data["meta"]["birth_date"]
    );
else
    Text(
        "Birth date not provided"
    );

//---> 使用 OmniModel，代码更简洁且易于维护。
// 通用的 tokenOr 方法还允许强制执行静态类型

Text(
    model.tokenOr<String>("meta.birth_date","Birth date not provided")
);

完整示例

以下是在 <code>example/omnimodel_example.dart</code> 中提供的完整示例代码：

import "dart:convert";

import "package:omnimodel/omnimodel.dart";
import "package:omnimodel/src/common/logger.dart";

void showStringDistances(String s1, String s2) {
  var distance = s1.similarityConvolution(s2);
  printInfo("■ 相似度卷积距离 ($s1) - ($s2) > $distance");
  distance = s1.levenshtein(s2);
  printInfo("■ 编辑距离 ($s1) - ($s2) > $distance");
}

void main() {
  const map = {
    "first": 0,
    "second": "value",
    "third": {
      "key1": true,
      "key2": 0,
      "key3": [0, 1, 2, 3],
    },
    "fourth": [
      "tag1",
      "tag2",
      "tag3",
    ],
  };

  //* 运行命令：
  //* dart run omnimodel_examples.dart

  // 从 map 创建模型
  var model = OmniModel.fromMap(map);

  // 注释掉以禁用提示打印。在生产环境中有条件地禁用打印功能。
  // OmniModelPerferences.enableHints = false;
  // Flutter:
  // OmniModelPreferences.enableHints = kDebugMode;

  printInfo("""
  
███╗░░██╗██╗██╗░██████╗
████╗░██║██║██║██╔════╝
██╔██╗██║██║██║╚█████╗░
██║╚████║██║██║░╚═══██╗
██║░╚███║██║██║██████╔╝
╚═╝░░╚══╝╚═╝╚═╝╚═════╝░

█▀▀ ▀▄▀ ▄▀█ █▀▄▀█ █▀█ █░░ █▀▀ █▀
██▄ █░█ █▀█ █░▀░█ █▀▀ █▄▄ ██▄ ▄█                                                    
""");

  printInfo("map ${JsonEncoder.withIndent(" ").convert(map)}");
  print("■" * 100);
  printInfo("■ map[first] > ${model.tokenOrNull("first")}\n${"-" * 100}");
  printInfo(
    "■ map[first] as String > ${model.tokenOrNull<String>("first")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[second] as String > ${model.tokenOr("second", "not found")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[second] as List > ${model.tokenOr<List>("second", List.empty())}\n${"-" * 100}",
  );
  printInfo(
    "■ map[third] as Map > ${model.tokenOrNull<Map>("third")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[third][key3] with OmniModel concatenation > ${model.tokenAsModel("third").tokenOrNull("key3")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[third][key3] with combined path > ${model.tokenOrNull("third.key3")}\n${"-" * 100}",
  );
  printInfo("■ map[fourth] as Map > ${model.tokenOr("fourth", {"new_key": 1})}\n${"-" * 100}");
  printInfo(
    "■ map[fourth] as List > ${model.tokenOrNull<List>("fourth")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[fifth] (not exists) > ${model.tokenOrNull("fifth")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[fifth] (not exists) with default value > ${model.tokenOr<String>("fifth", "not found")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[fourth1] (mispelled key) > ${model.tokenOrNull("fourth1")}\n${"-" * 100}",
  );
  printInfo(
    "■ map[third][key4] (mispelled key) > ${model.tokenOrNull("third.key4")}\n${"-" * 100}",
  );
  printInfo("■ Similar");
  printInfo("\tmost similar to thirt > ${model.similar("thirt")}");
  printInfo("\tmost similar to secondly > ${model.similar("secondly")}");
  printInfo("\tmost similar to fifth > ${model.similar("fifth")}");

  printInfo("■ Iterate");
  model.json.forEach(
    (key, value) => printInfo("($key, $value)"),
  );
  print("■" * 100);
  printInfo("EXTENSIONS");

  showStringDistances("Hello World!", "Hello mad World!");
  showStringDistances("Hello World!", "Hello World!");
  showStringDistances("Hello World!", "Hello World.");
  showStringDistances("abba", "aaaa");
  showStringDistances("ab ba", "aaaa");

  var mapCopy = OmniModel.fromMap(map).json;
  printInfo("■ Deep update");
  printInfo("\tinitial map = $mapCopy");
  var edited = mapCopy.deepUpdate(["third", "key2"], "string!");
  printInfo('\tdeep updated [third, key2] < "string!" = $edited');
  edited = mapCopy.deepUpdate(["third", "key4"], ":D");
  printInfo('\tdeep updated [third, key4] < ":D" = $edited');
  edited = mapCopy.deepUpdate(["third", "key2", "new_key"], "newkey!");
  printInfo('\tdeep updated [third, key2, new_key] < "newkey!" = $edited');
}