C#中如何将MongoDB->RunCommand结果映射到业务类的方法总结

前言

一直没实际用过mongodb，最近有个项目中用了用，踩了一些坑。这篇文章会介绍将mongodb->runcommand结果映射到业务类时碰到的问题，以及对各种方法的探索。

collection中的数据是这样的：

使用find命令查询数据：

db.runcommand({"find":"test", limit:2, sort:{addtime:-1}})

查询返回的数据结构是这样的，需要的数据在firstbatch中：

{
 "cursor" : {
 "firstbatch" : [ 
  {
  "_id" : objectid("5ad0042944fd3929db6b869f"),
  "name" : "李四",
  "addtime" : isodate("2018-04-12t01:13:18.965z")
  }, 
  {
  "_id" : objectid("5ad003e844fd3929db6b869e"),
  "name" : "张三",
  "addtime" : isodate("2018-04-02t01:11:18.965z")
  }
 ],
 "id" : numberlong(0),
 "ns" : "test.test"
 },
 "ok" : 1.0
}

下面将在c#中运行find命令来执行查询，并将结果映射到自定义的personinfo类。

 private class personinfo
 {
  public string id { get; set; }
  public string name { get; set; }
  public datetime addtime { get; set; }
 }

需要注意personinfo中的属性id和document中的名称_id有些不一样，需要进行映射。因为不同的反序列化方法，采用的方式也会不同，所以下面会有相关介绍。

使用json.net

因为json.net用的比较多，基本思路就是用它来反序列化bson，但是json和bson是不同的，不能用jsonconvert。

不过json.net提供了一个新的包newtonsoft.json.bson来解析bson数据，并且提供了一个例子。

https://www.newtonsoft.com/json/help/html/deserializefrombson.htm

这个例子有点过时了，里边用的bsonreader我已替换为bsondatareader。

byte[] data = convert.frombase64string("mqaaaajoyw1laa8aaabnb3zpzsbqcmvtawvyzqaju3rhcnreyxrlamdgkwe8aqaaaa==");
memorystream ms = new memorystream(data);
using (bsondatareader reader = new bsondatareader(ms))
{
 jsonserializer serializer = new jsonserializer();
 
 event e = serializer.deserialize<event>(reader);
 
 console.writeline(e.name);
 // movie premiere
}

看样子有个byte数组就可以了，然后再看bsondocument正好有个方法tobson，获取到的就是byte[]。

思路：先将runcommand的结果映射为bsondocument，然后查找到firstbatch，然后将其tobson，然后使用newtonsoft.json.bson反序列化。

一切看起来很easy！

马上码起来：

  var findcommand = bsondocument.parse("{\"find\":\"test\", limit:2, sort:{addtime:-1}}");
  var findresult = database.runcommand<bsondocument>(findcommand)
  .getelement("cursor").value.tobsondocument()
  .getelement("firstbatch").tobsondocument()
  .tobson();
  var personlist = deserializebson<personlist>(findresult);

数组不能是bson的根元素，所以这里定义了一个personlist类：

 private class personlist
 {
  public string name { get; set; }
  [jsonproperty(propertyname = "value")]
  public personinfo[] list { get; set; }
 }

需要注意的是上边代码中 getelement(“firstbatch”).tobsondocument() 返回的数据格式是这样的：

这里用了jsonproperty将value映射为list。

还有person类中的属性名称和document中的也有不同，也需要映射：

 private class personinfo
 {
  [jsonproperty(propertyname = "_id")]
  [jsonconverter(typeof(objectidconverter))]
  public string id { get; set; }
  public string name { get; set; }
  public datetime addtime { get; set; }
 }

这里还用了一个 jsonconverter(typeof(objectidconverter)) ，因为objectid不能直接转换为string，所以定义了一个objectidconverter类：

 public class objectidconverter : jsonconverter
 {
  public override bool canconvert(type objecttype)
  {
   return objecttype == typeof(objectid);
  }
 
  public override object readjson(jsonreader reader, type objecttype, object existingvalue, jsonserializer serializer)
  {
   if (reader.value != null)
   {
    var value = (byte[])reader.value;
 
    var result = bitconverter.tostring(value).replace("-", string.empty).tolowerinvariant();
 
    return result;
   }
 
   return string.empty;
  }
 
  public override void writejson(jsonwriter writer, object value, jsonserializer serializer)
  {
   throw new notimplementedexception();
  }
 }

还有一个重要的方法，反序列化：

  public static t deserializebson<t>(byte[] data)
  {
   memorystream ms = new memorystream(data);
   using (bsondatareader reader = new bsondatareader(ms, false, datetimekind.local))
   {
    jsonserializer serializer = new jsonserializer();
 
    t e = serializer.deserialize<t>(reader);
    return e;
   }
  }

现在运行程序看看吧：

但是感觉好复杂，过了一弯又一弯。

使用mongodb .net driver内置

话说这么常用的功能，sdk应该内置了才对，何必舍近求远，。

既然runcommand可以传递一个类型，那么sdk应该是支持反序列化自定义类型的。

尝试根据返回的结果定义一个新的类：

  [bsonignoreextraelements]
  private class findcommandresult
  {
   [bsonelement("cursor")]
   public resultcursor cursor { get; set; }
  }
 
  [bsonignoreextraelements]
  private class resultcursor
  {
   [bsonelement("firstbatch")]
   public personinfo[] batch { get; set; }
  }
 
  private class personinfo
  {
   [bsonid]
   [bsonrepresentation(bsontype.objectid)]
   public string id { get; set; }
   public string name { get; set; }
   public datetime addtime { get; set; }
  }

bsonignoreextraelements、bsonelement、bsonid、bsonrepresentation这些都是sdk内置的attribute，相关作用大家应该能够一目了然。

再看看查询这块的代码：

   var findcommand = bsondocument.parse("{\"find\":\"test\", limit:1, sort:{addtime:-1}}");
   var findresult = database.runcommand<findcommandresult>(findcommand);

代码跑起来：

这个方式相比json.net更直接，更简单。

使用查找赋值的方式

为了反序列化，适应mongodb，定义了一些没有业务意义的类型，加了很多的属性注解，感觉还不够直接显性。

也许只需要数据中的某几个字段，或者根本就没必要定义类型，只需要放到一个列表中。

又查看了bsondocument的定义，发现可以在运行命令时先反序列化为bsondocument，然后再根据返回的数据结构使用getelement获取相关字段的值。

代码如下：

   var findcommand = bsondocument.parse("{\"find\":\"test\", limit:2, sort:{addtime:-1}}");
   var findresult = database.runcommand<bsondocument>(findcommand)
    .getelement("cursor").value.tobsondocument()
    .getelement("firstbatch").value.asbsonarray.select(d =>
    {
     var dbd = d.asbsondocument;
     return new personinfo()
     {
      id = dbd.getelement("_id").value.asobjectid.tostring(),
      addtime = dbd.getelement("addtime").value.tolocaltime(),
      name = dbd.getelement("name").value.tostring(),
     };
    }).tolist();

运行后直接返回list<personinfo> ，更贴近业务需求。

这是本文中最简单的方式了。

如果做的更通用点，可以在这里通过反射自动实例化相关类型，不过这不如直接使用sdk内置的反序列化方式了。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对的支持。