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

在实际项目中，我此前一直未使用过MongoDB，最近在一个项目中初次尝试，也因此踩了不少坑。本文将详细介绍在将MongoDB RunCommand 结果映射到业务类时所遇到的问题，以及对各种映射方法的探索。

数据结构与查询示例

集合数据情况

在MongoDB的集合中，数据结构如下。我们使用 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#中，我们定义一个 PersonInfo 类来映射数据：

private class PersonInfo
{
public string Id { get; set; }
public string Name { get; set; }
public DateTime AddTime { get; set; }
}

需要注意的是，PersonInfo 类中的属性 Id 与文档中的 _id 名称不同，因此需要进行映射。由于不同的反序列化方法采用的映射方式也不同，下面将详细介绍。

使用Json.NET进行反序列化

基本思路与问题

Json.NET是一个常用的JSON处理库，我们的基本思路是使用它来反序列化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
}

从示例来看，只要有一个字节数组就可以进行反序列化。而 BsonDocument 正好有一个 ToBson 方法，调用该方法可以获取到字节数组。

具体实现步骤

具体思路是：先将 RunCommand 的结果映射为 BsonDocument，然后查找 firstBatch，将其转换为字节数组，最后使用 Newtonsoft.Json.Bson 进行反序列化。示例代码如下：

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; }
}

这里使用了 JsonProperty 将 Value 映射为 List。同时，PersonInfo 类中的属性名称与文档中的名称不同，也需要进行映射：

private class PersonInfo
{
[JsonProperty(PropertyName = "_id")]
[JsonConverter(typeof(ObjectIdConverter))]
public string Id { get; set; }
public string Name { get; set; }
public DateTime AddTime { get; set; }
}

由于 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内置方法进行反序列化

思路分析

对于这样常用的功能，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 内置的特性，其作用一目了然。

查询代码示例

查询代码如下：

var findCommand = BsonDocument.Parse("{\"find\":\"test\", limit:1, sort:{AddTime:-1}}");
var findResult = database.RunCommand<FindCommandResult>(findCommand);

这种方式相比使用 Json.NET 更加直接和简单。

使用查找赋值的方式进行反序列化

思路分析

为了进行反序列化，我们定义了一些没有业务意义的类型，并添加了很多属性注解，感觉不够直接和显性。有时我们可能只需要数据中的某几个字段，或者根本没必要定义类型，只需要将数据放到一个列表中。通过查看 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 内置的反序列化方式。

综上所述，在将MongoDB RunCommand 结果映射到业务类时，我们可以根据具体需求选择合适的方法。使用 MongoDB .NET Driver 内置方法通常是较为推荐的方式，因为它更加直接和简单；而查找赋值的方式则更适合只需要部分字段的场景。