Newtonsoft.Json自定义转换Google.Protobuf.Timestamp报错问题
问题描述
测试gRPC调用时,需要将JSON请求体转换为Proto对象:
int32、string等普通类型属性转换正常- 当属性为
Google.Protobuf.WellKnownTypes.Timestamp类型时触发转换异常 - 已编写自定义
TimeStampConverter但未生效
复现代码
using System; using Newtonsoft.Json; using Newtonsoft.Json.Converters; public class Program { public class MyProtobufObject { public Google.Protobuf.WellKnownTypes.Timestamp openingDatetime {get;set;} } public class TimeStampConverter : DateTimeConverterBase { public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { DateTime date = DateTime.Parse(reader.Value.ToString()); return Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(date).ToString(); } public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { writer.WriteValue(((Google.Protobuf.WellKnownTypes.Timestamp)value).ToString()); } } public static void Main() { string sDate = Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(DateTime.UtcNow).ToString(); Console.WriteLine(sDate); string myJsonBodyRequest = "{\"openingDatetime\":"+sDate+"}"; Console.WriteLine(myJsonBodyRequest); MyProtobufObject myObjectWithConverter = JsonConvert.DeserializeObject<MyProtobufObject>(myJsonBodyRequest, new TimeStampConverter()); MyProtobufObject myObjectWithoutConverter = JsonConvert.DeserializeObject<MyProtobufObject>(myJsonBodyRequest); } }
运行输出
"2021-02-24T17:28:52.391136Z" {"openingDatetime":"2021-02-24T17:28:52.391136Z"} Unhandled exception. Newtonsoft.Json.JsonSerializationException: Error converting value 02/24/2021 17:28:52 to type 'Google.Protobuf.WellKnownTypes.Timestamp'. Path 'openingDatetime', line 1, position 48. ---> System.ArgumentException: Could not cast or convert from System.DateTime to Google.Protobuf.WellKnownTypes.Timestamp.
问题定位与修正
核心错误点
- 转换器继承基类错误:自定义的
TimeStampConverter继承了DateTimeConverterBase,该基类仅处理DateTime/DateTimeOffset类型的转换,完全不会被应用到Timestamp类型上,这是转换器不生效的根本原因。 - ReadJson返回值类型错误:就算基类正确,当前
ReadJson方法返回的是string类型(调用Timestamp.FromDateTime(date).ToString()得到的是字符串),和属性要求的Timestamp类型完全不匹配,即使转换器触发也会报类型错误。 - 未显式绑定转换器:如果不想用全局注册的方式,需要给
Timestamp类型的属性添加[JsonConverter]特性,否则Newtonsoft.Json不会自动识别自定义转换器。
修正后的实现
1. 重写自定义转换器
直接继承JsonConverter基类,正确处理类型匹配与返回值:
public class TimeStampConverter : JsonConverter { // 指定该转换器仅处理Timestamp类型 public override bool CanConvert(Type objectType) { return objectType == typeof(Google.Protobuf.WellKnownTypes.Timestamp); } public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { // 处理空值场景 if (reader.Value == null) return null; // 必须转成UTC时间,否则Timestamp.FromDateTime会抛异常 DateTime utcDate = DateTime.Parse(reader.Value.ToString()).ToUniversalTime(); return Google.Protobuf.WellKnownTypes.Timestamp.FromDateTime(utcDate); } public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { var timestamp = (Google.Protobuf.WellKnownTypes.Timestamp)value; writer.WriteValue(timestamp.ToString()); } }
2. 转换器绑定方式
二选一即可:
- 属性级绑定:给Proto属性加特性,优先级最高
public class MyProtobufObject { [JsonConverter(typeof(TimeStampConverter))] public Google.Protobuf.WellKnownTypes.Timestamp openingDatetime {get;set;} }
- 全局注册:反序列化时把转换器加到序列化设置中
var jsonSettings = new JsonSerializerSettings(); jsonSettings.Converters.Add(new TimeStampConverter()); MyProtobufObject myObject = JsonConvert.DeserializeObject<MyProtobufObject>(myJsonBodyRequest, jsonSettings);
额外说明
无转换器时报的Could not cast or convert from System.DateTime to Google.Protobuf.WellKnownTypes.Timestamp错误,是因为Newtonsoft.Json默认会先把JSON里的时间字符串解析为DateTime类型,再尝试强转成Timestamp,两者无继承关系,自然触发转换失败。
内容的提问来源于stack exchange,提问作者Waldrich
相关产品推荐
相关产品推荐

