MongoDB C＃：如何将包含DateTime的JSON反序列化为正确的BsonDocument DateTime值

目录

介绍

背景

使用代码

兴趣点

---

如果您的Json包含日期时间值如“2018-11-23T20：56：05.3117673Z”并且您需要将其作为正确的BsonDateTime值放在BsonDocument中，该怎么办？

介绍

这是我的第一篇文章，最后我发现了一个问题，我认为在这个领域（JSON，DateTime和使用BsonDocument的MongoDb）中有很多人都有值得发表的问题！我很高兴与您分享解决方案！

大多数时候，人们使用Json作为序列化格式在应用程序之间传输数据。MongoDB有内置的序列化器，可以从Json转换为Bson。问题是生成的Bson不会将预期的DateTime 字符串处理为BsonType.DateTime ，而是将其处理为BsonType.String。我想给你一个关于如何构建东西的选项，将Json字符串值（具有给定DateTime格式）正确地反序列化为BsonDateTime值。

背景

MongoDb中内置的序列化程序可以在满足给定格式时处理“Json”中的datetime字符串表示，即：

{
  "myDate": ISODate("2018-11-23T20:56:05.311Z")
}

但这不是一个有效的Json格式，并且没有Json序列化程序（如Json.NET）能够正确地序列化或反序列化（无需任何修改）。大多数人都希望拥有以下Json格式：

{
  "myDate": "2018-11-23T20:56:05.311Z"
}

通常，您可以使用以下代码将Json反序列化为Bson：

var bson = BsonSerializer.Deserialize<BsonDocument>(json);

你会看到结果是BsonType.String。

当您检查BsonSerializer源代码时，您将找到以下代码：

public static TNominalType Deserialize<TNominalType>
    (string json, Action<BsonDeserializationContext.Builder> configurator = null)
{
   using (var bsonReader = new JsonReader(json))
   {
      return Deserialize<TNominalType>(bsonReader, configurator);
   }
}

所以在幕后，MongoDb使用某种JsonReader，只是解析任何string值为BsonType.String。

这是我们将扩展JsonReader的地方，以便能够正确地解析上面提到的datetime模式，从而产生一个BsonType.DateTime。

使用代码

让我们创建自己的DateTimeAwareJsonReader，只是扩展现有的JsonReader并尝试确定给定string值是否可以是有效的日期时间。但我们要记住，我们希望它尽可能高效。我们知道我们必须调查Json值的每个string表示，无论它是否是datetime。让我们开始吧：

public class DateTimeAwareJsonReader : JsonReader
{
    public DateTimeAwareJsonReader(string json) : base(json)
    {
    }

    public DateTimeAwareJsonReader(TextReader textReader) : base(textReader)
    {
    }

    public DateTimeAwareJsonReader(string json, JsonReaderSettings settings) : base(json, settings)
    {
    }

    public DateTimeAwareJsonReader(TextReader textReader, JsonReaderSettings settings) : 
                                   base(textReader, settings)
    {
    }
}

序列化引擎使用IBsonReader.ReadBsonType()以确定当前正在解析哪种类型，因此我们必须挂钩并在此处进行调查，无论我们是否想告诉引擎给定的值是 string或datetime。所以让我们添加一个重写方法：

private string _currentStringValue;
private BsonDateTime _currentDateTime;

public override BsonType ReadBsonType()
{
    _currentDateTime = null;
    var currentBsonType = base.ReadBsonType();
    if (currentBsonType == BsonType.String)
    {
        var previousState = State;
        _currentStringValue = ReadString();
        State = previousState;
        // date pattern is YYYY-MM-dd, if this pattern is met, 
        // we assume it is a DateTime and try to parse.
        // kind of like duck typing..if it walks like a duck and talks like a duck, 
        // it must be a duck.. :D
        if (_currentStringValue.Length > 9)
        {
            if (char.IsDigit(_currentStringValue[0]) &&
                char.IsDigit(_currentStringValue[1]) &&
                char.IsDigit(_currentStringValue[2]) &&
                char.IsDigit(_currentStringValue[3]) &&
                _currentStringValue[4].Equals('-') &&
                char.IsDigit(_currentStringValue[5]) &&
                char.IsDigit(_currentStringValue[6]) &&
                _currentStringValue[7].Equals('-') &&
                char.IsDigit(_currentStringValue[8]) &&
                char.IsDigit(_currentStringValue[9]))
            {
                // looks like a date string
                if (DateTime.TryParse(_currentStringValue, out var parsedDateTime))
                {
                    _currentDateTime = new BsonDateTime(parsedDateTime);
                    CurrentBsonType = BsonType.DateTime; // we have to set also the 
                                                         // current bson type and return it.
                    return BsonType.DateTime;
                }
            }
        }
    }
    return currentBsonType;
}

基础的JsonReader将告诉我们，我们的“ myDate”属性是BsonType.String。在这种情况下，我们想要拦截并进一步的调查。为了提高效率，我们只检查至少给定大小的值。我希望序列化datetime的格式至少为“ YYYY-MM-dd”（例如“ 2018-05-02”）。如果您有其他要求，可以根据需要在此处调整逻辑。所以一旦我们在这里涉及到数字，并且所有内容看起来都像是string表示的datetime，我们将告诉序列化器这个值是BsonType.DateTime，否则我们想要回退到序列化器必须决定的情况。

一旦我们认为给定的值是DateTime，我们必须重写另一个方法：

public override long ReadDateTime()
{
    if (_currentDateTime == null)
    {
        return base.ReadDateTime();
    }
            
    if (Disposed) { ThrowObjectDisposedException(); }
    VerifyBsonType("ReadDateTime", BsonType.DateTime);
    State = BsonReaderState.Type;
    return _currentDateTime.AsBsonDateTime.MillisecondsSinceEpoch;
}

如果我们的逻辑开始，该字段_currentDateTime将具有解析的值，我们将返回它。

这就是它！您现在有一个可以正确计算datetime 字符串表示的工作解决方案，并告诉MongoDb它将其作为一个DateTime处理。

要测试它，你可以做一个简单的控制台应用程序：

class Program
{
    public class SomeModel
    {
        [JsonProperty("id")]
        public int Id { get; set; }
        [JsonProperty("test")]
        public string Test { get; set; }
        [JsonProperty("today")]
        public DateTime Today { get; set; }
        [JsonProperty("inner")]
        public SomeModel Inner { get; set; }
    }

    static void Main(string[] args)
    {
        var model = new SomeModel
        {
            Id = 1,
            Test = "Model",
            Today = DateTime.UtcNow.Date,
            Inner = new SomeModel
            {
                Id = 2,
                Test = "Inner",
                Today = DateTime.UtcNow
            }
        };

        var json = JsonConvert.SerializeObject(model);
        using (var reader = new DateTimeAwareJsonReader(json))
        {
            var bson = BsonSerializer.Deserialize<BsonDocument>(reader);
            Console.WriteLine("Models today property is: {0}", bson["today"].BsonType);
        }
        Console.ReadLine();
    }
}

兴趣点

一旦我弄清楚MongoDb序列化是如何工作的，就很容易构建一个拦截机制来告诉底层的序列化框架datetime应该是什么。我还没有在高效的环境中测试它，但我很快就会做到。更有趣的部分是以一种精益的方式来猜测一个string值是否可以是datetime最有效的方式，而不会过多地干扰MongoDb客户端库。我认为这个解决方案适用于大多数用例。期待您的意见！;-)

 

原文地址：https://www.codeproject.com/Tips/1268019/MongoDB-Csharp-How-to-Deserialize-a-JSON-Containin