如何在gRPC .Net中实现可空DateTime属性？

1. 用官方Timestamp类型替代DateTime #

Protobuf本身没有内置DateTime类型，官方标准方案是使用google.protobuf.Timestamp来表示日期时间，首先在proto文件中导入依赖包：

import "google/protobuf/timestamp.proto";

2. 定义可空字段（Protobuf 3.12+） #

从Protobuf 3.12版本开始支持optional关键字，用它标记字段后，生成的C#类会自动对应可空类型：

message MyClass {
  // 生成的C#类型为Timestamp?，后续可转成业务需要的DateTime?
  optional google.protobuf.Timestamp my_date_time = 1;
}

3. 类型转换：Timestamp? ↔ DateTime? #

生成的C#类里是Timestamp?类型，需要和业务代码中的DateTime?做双向转换，写两个简单的扩展方法即可：

// DateTime?转Timestamp?（发送gRPC请求时用）
public static Timestamp? ToGrpcTimestamp(this DateTime? dateTime)
{
    if (!dateTime.HasValue) return null;
    // Protobuf Timestamp要求使用UTC时间，先转换为UTC
    return Timestamp.FromDateTime(dateTime.Value.ToUniversalTime());
}

// Timestamp?转DateTime?（接收gRPC响应时用）
public static DateTime? ToLocalDateTime(this Timestamp? timestamp)
{
    if (!timestamp.HasValue) return null;
    // 转换为本地时间，可根据业务需求调整时区
    return timestamp.Value.ToDateTime().ToLocalTime();
}

4. 在gRPC服务中填充数据 #

假设从AppService获取到DateTime?类型的业务数据，直接通过扩展方法转换后赋值给Protobuf对象：

// 从AppService获取可空日期时间数据
DateTime? appDateTime = _appService.GetTargetDateTime();

// 转换后赋值给gRPC对应的对象
var grpcMyClass = new MyClass
{
    MyDateTime = appDateTime.ToGrpcTimestamp()
};

旧版Protobuf兼容方案（<3.12） #

如果无法升级Protobuf版本，可以用oneof语法模拟可空字段，写法稍繁琐：

message MyClass {
  oneof my_date_time_oneof {
    google.protobuf.Timestamp my_date_time = 1;
  }
}

生成的C#类会附带MyDateTimeOneofCase枚举，用于判断字段是否有值，转换逻辑和上述扩展方法一致。

内容的提问来源于stack exchange，提问作者Rezzen