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内置的反序列化方式了。

总结

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