Flutter BSON数据处理插件bson的使用

bson库简介

bson 是一个用于Dart编程语言的Bson库。版本5.0.0引入了破坏性API更改，详情请参阅变更日志。

这个包允许将Dart元素的地图转换为二进制Bson表示形式，反之亦然。输入可以是标准的Dart地图（键名为值和值本身），或者是ejson表示的值，或混合源。它还可以序列化使用BsonSerializable混入的对象。

存在一个Codec类，可以根据来源定义要执行的序列化类型，以及三个预设参数的专门类：BsonCodec、EjsonCodec和ObjectCode。

BSON转换

支持的数据类型

序列化和反序列化示例代码

import 'package:bson/bson.dart';
import 'package:fixnum/fixnum.dart';

void main() {
  var objectId = ObjectId.parse('51c87a81a58a563d1304f4ed');
  var document = <String, dynamic>{
    '_id': objectId,
    'int32': 78954,
    'int64': Int64(-1),
    'date': DateTime(2020),
    'map': {
      'a': 99,
      'subList': [Int64(1), Int64(2), Int64(3)]
    },
    'list': [
      1,
      2,
      3,
      {'b': 29}
    ]
  };

  // 序列化
  var bsonBinary = BsonCodec.serialize(document);

  // 反序列化
  var result = BsonCodec.deserialize(bsonBinary);

  // 检查结果是否正确
  var checkValue = result['list'][3]['b'] == document['list'][3]['b'];
  print('The result is ${checkValue ? 'correct' : 'uncorrect'}');
}

EJSON转换

EJSON支持从格式为ejson的文档转换为BSON格式，仅支持ejson版本2。支持的数据类型与BSON类似，但有一些特定的EJSON表示方法，如$numberDouble、$oid等。

序列化和反序列化示例代码

import 'package:bson/bson.dart';
import 'package:fixnum/fixnum.dart';

void main() {
  var ejsonMap = <String, dynamic>{
    '_id': {'$oid': '51c87a81a58a563d1304f4ed'},
    'int32': {'$numberInt': '78954'},
    'int64': {'$numberLong': '-1'},
    'date': {'$date': '2020-01-01T00:00:00Z'},
    'map': {
      'a': 99,
      'subList': [{'$numberLong': '1'}, {'$numberLong': '2'}, {'$numberLong': '3'}]
    },
    'list': [
      1,
      2,
      3,
      {'b': 29}
    ]
  };

  // 序列化
  var bsonBinary = EJsonCodec.serialize(ejsonMap);

  // 反序列化
  var result = EJsonCodec.deserialize(bsonBinary, relaxed: true);

  // 检查结果是否正确
  var checkValue = result['list'][3]['b'] == ejsonMap['list'][3]['b'];
  print('The result is ${checkValue ? 'correct' : 'uncorrect'}');
}

Dart对象转换

可以通过实现BsonSerializable混入来将Dart对象转换为BSON格式。需要满足以下条件：

• 对象必须使用BsonSerializable混入。
• 覆盖toBson方法，在其中为每个字段提供相应的值。
• 注册类，并提供用于重新创建实例的方法。

示例代码

import 'package:bson/bson.dart';
import 'package:fixnum/fixnum.dart';

class MyObject with BsonSerializable {
  final ObjectId id;
  final int value;

  MyObject(this.id, this.value);

  @override
  Map<String, dynamic> toBson() => {
        '_id': id,
        'value': value,
      };

  static MyObject fromBson(Map<String, dynamic> bson) {
    return MyObject(
      bson['_id'] as ObjectId,
      bson['value'] as int,
    );
  }
}

void main() {
  var myObject = MyObject(ObjectId(), 42);
  ObjectCodec.registerClass(MyObject.fromBson, 1);

  // 序列化
  var bsonBinary = myObject.serialize();

  // 反序列化
  var result = ObjectCodec.deserialize(bsonBinary) as MyObject;

  // 检查结果是否正确
  var checkValue = result.value == myObject.value;
  print('The result is ${checkValue ? 'correct' : 'uncorrect'}');
}

通过上述内容，您可以了解如何在Flutter项目中使用bson插件进行BSON数据的处理。希望这些信息对您有所帮助！