C#中用 protobuf Struct 实现弱类型的json 序列化/反序列化

目标

    在.net 大力支持使用 gRPC 的背景下，通过 jsontranscoding 可以实现 gRPC/WebAPI 一鱼两吃。有时候不想把json对象的所有属性都在 proto 中定义出来，比如设备对象，不同设备有不同的属性，要都强类型那C#里面的对象属性会很多，不如把这些属性打包成一个json字符串，在后端作为整体进行读写，数据库里面只需要一列(如Attrs)，里面存储这个json对象即可。

    简而言之，我们需要一个相当于object的 protobuf 类型。

map 不行

    protobuf 里面的 map等价于 repeated MapFieldEntry，因此不支持 repeated map，即不能表达List<object>，另外map 里面值的类型不能混，因此map ≠ object。

Any 不行

    Any应该被视为C#里的强类型，只能pack/unpack另一个message，本身不能添加属性，也不能直接进行json的反序列化。我理解Any=IMessage，需要你提供一个具体的message类型，因此也不是弱类型。

Struct 正解

     官网上说，“Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. ”

    这正是我要找的弱类型！

    在proto文件中，我们定义一个类型 Device，把除Id, Name之外的属性都放到 google.protobuf.Struct attrs 中，注意前面需要 import "google/protobuf/struct.proto" 才能使用Struct 。

syntax = "proto3";

import "google/protobuf/struct.proto";

option csharp_namespace = "StructExample";

message Device {
  int32 id = 1;
  string name = 2;
  google.protobuf.Struct attrs=3;
}

    之后会得到一个类，不过Attrs对象默认值为null，使用前要先赋值为 new Struct()。

public class Device
{
    public int Id{get;set;}
    
    public string Name{get;set;}

    public Struct Attrs{get;set;}
}

    然后我们可以创建一个对象，通过 Fields来添加属性，通过Value.For... 赋值。

var device1 = new Device()
{
    Id = 1,
    Name = "设备1",
    Attrs = new Struct()
};

device1.Attrs.Fields["生产厂家"] = Value.ForString("海尔");

     然后我们可以简单的用device1.ToString()获得对象的json字符串，也可以用这个字符串Device.Parser.ParseJson 得到对象，后端保存时Attrs字段就保存这个json 字符串。

var jsonString = device1.ToString();
//{ "id": 1, "name": "设备1", "attrs": { "生产厂家": "海尔" } }
var deviceCopy = Device.Parser.ParseJson(jsonString);

实现动态对象WebApi

    有了Attrs 这个Struct，我们什么都可以往里装，为了让前端完全不需要知道我们的实现机制，可以在rpc 服务实现时，把 Id, Name 两列也添加到Fields里，返回Attrs作为一个完整的json 对象。

    在proto文件中，可以定义一个GetDetail，区别于Get返回Device，GetDetail返回Struct，学问就在这了。

service DeviceRPC {
  rpc Get (RequestId) returns (Device){
	option(google.api.http)={
	  get:"/device/{id}"
	};
  }
  rpc GetDetail (RequestId) returns (google.protobuf.Struct){
	option(google.api.http)={
	  get:"/device/detail/{id}"
	};
  }
}

    后端实现时，可以这样构造GetDetail的返回值 

var result = new Struct();
result["id"] = Value.ForNumber(device1.Id);
result["name"] = Value.ForString(device1.Name);
if(device1.Attrs != null && device1.Attrs.Fields.Count > 0)
{
    foreach (var field in device1.Attrs.Fields)
    {
        result.Fields[field.Key] = field.Value;
    }
}

    /device/1 返回 { "id": 1, "name": "设备1", "attrs": { "生产厂家": "海尔" } }

    /device/detail/1 返回 { "id": 1, "name": "设备1",  "生产厂家": "海尔"  }

    我们也可以提供 repeated Struct 来返回多条结果，其中一个技巧是在返回的response_body中指定层级到items，这样返回的就是不带 items: 的干净json字符串了。

  rpc GetDeviceDetail(Request) returns(AttrsList){
	option(google.api.http)={
	  post:"/device/detail",
      response_body: "items"
	};
  }
  

message AttrsList{
  repeated google.protobuf.Struct items = 1;
}