三状态问题

我们提供了一些API给客户使用，并要求将数据以JSON格式发给我们。由于业务上的需求，我们需要允许客户在JSON中表达这样三种信息：“有key且有值”, “有key但值为null”和“key不存在”。

例如，某API中需要客户提供“a”, “b”, “c”三个属性的值，而客户发出请求的JSON数据可能是： { "b":"xxx", "c":null } 这里表达的含义是“a”不存在，“b”的值是“xxx”, “c”的值是null，在业务逻辑中，它们代表着不同的处理方式。

如何表达两种状态：“有key且有值”与“有key但值为null”

首先来看看如何表达两种状态，这可能是多数人使用gRPC或者Protobuf3时会遇到的。

常见的有下面四种办法。

方案一：使用oneof

oneof是Protobuf的一个关键字，在官方介绍中，oneof的用途是：“如果你的Message中有很多可选的（Optional）属性，并且这些属性在同一时刻最多只有一个有值，那么你可以使用oneof功能做到，同时还能节省存储空间。”

所以，如果被oneof限制的属性只有一个，表达的含义就等于“这个属性可能有值，也可能没值（相当于null）”。

比如有Message定义如下：

        message Request {
          oneof body_oneof {
            string body = 1;
          }
        }

生成的代码中会有方法“GetBodyOneof（）”，返回类型是接口，可以通过判断该接口的实际类型是否是“Request_Body”，来判断值是否是null，比如：

        if x,  ok := GetBodyOneof().(＊Request_Body);  ok {
            // body不为null
        }

可见，虽然功能上能够做到，但oneof从设计本意上来说并不是为了“值可以为null”这种需求，而且这些代码也显得比较啰嗦，所以总的来说不是一个很好的办法。

方案二：使用标记map

在GitHub的一个有很长评论列表的Issue中，有人提出了这个方案。

简单来说，就是利用一个map来记录Message中哪些属性被赋了值，map的key为属性自己的编号，如果被赋值，则在map中将对应编号key的值为true。因此，想知道某个属性的值是否是null，只需要检查这个map中对应的key的值是否为true。

具体实现来说，可以自己写一个Protobuf的插件，该插件可以对每个Message生成一个map，还可以顺便生成一个HasXXX（）方法来方便编码做判断。

似乎很美，是么？

注意，Protobuf生成的Struct的属性都是“导出”的（也就是大写字母开头），相当于Java中的“public”成员变量，而SetXXX（）方法更是压根儿没有。这可能是Go语言的风格，好坏在此暂且不论。至少对这个方案来说，运行程序时，需要在每次给属性赋值后手动去修改这个map，取值前也要专门做判断，这是很容易出错的，所以也不是一个很好的方案。

当然，你也可以进一步修改代码生成的结果，干脆将属性的名字改成“未导出”的，生成对应的Setter方法，并修改Getter方法的逻辑，然而这样做的代价太大了，也不符合Go的风格，而不符合大家一致遵守的风格的后果，可能就是你的代码与一些第三方库不兼容，这会是一个更让人头疼的问题。

方案三：使用Wrapper

可能是因为在Protobuf3中这个问题太常见了，为了平息“众怒”，谷歌官方“丢”了“wrappers.proto”这么个东西出来，里面定义了各种基本类型的包装器，有点儿像Java中的int与“Integer”的关系，比如：

        message Int64Value {
          int64 value = 1;
        }

你可以用“Int64Value”这个“message”，来替换掉“Int64”这个“基本类型”，而Message在Go中的零值（Zero Value）是nil，问题也就解决了。不管怎么说，与前面两种方案比起来，这个方案至少看起来更合理一些，而且毕竟是谷歌自己提出的方案，官方“钦定”的感觉总是能让人不好拒绝。

前面的三个方案中，多数人最终选择的是第三种，Wrapper方案。

如何表达第三种状态：“key不存在”

好了，再往前进一步，看看再增加一种状态该怎么办。

方案一：在Wrapper方案的基础上做扩展

自然而然的，在Wrapper方案的基础上，如果要做扩展，就会是这样的：

        message Int64Value {
          int64 value = 1;
          bool exist = 2;
        }

添加一个布尔类型的属性，为true时表示key存在，否则表示key不存在。可以看到有一些第三方库也是这么做的。

这么做的优点很明显，容易实现并且容易理解。而缺点也很明显——这一次，没有一个像谷歌这样的组织来带头提出一份定义文件。所以，你需要自己定义这个“包装器”。而你自己定义的“包装器”是绝对不会有第三方项目支持的，这会在未来给你造成一些兼容性方面的不便利，这一点需要你自己去衡量。

结合我们自己的情况考虑，最终选择的是这个方案。

方案二：通过额外的数据传递第三种状态

这种思路的目的是，在只使用基本类型的基础上解决“三状态”问题，如此一来也就不会有前一种方案中的兼容性问题了。

该方案最终没有被采用，原因是在权衡了复杂度和风险，与比较紧迫的进度安排之后，决定放弃，但我认为仍然值得一提。

gRPC支持通过Header和Trailer在Client和Server端传递Metadata，我们可以利用这个功能。

我们知道，在将用户输入的JSON转成Protobuf对象的时候，会丢失一些信息，使得无法表示“三种状态”。“丢失的信息”包括两部分，分别是“哪些key的值是null”和“哪些key在JSON中不存在”。通过对比输入的JSON和Protobuf Message定义，可以拿到这些丢失的信息，之后就可以利用Metadata将Protobuf对象与这些信息一起发给后端，后端得到的实际就是完整的数据了。这时只要再提供一个封装好的方法，将Protobuf对象与Metadata中的数据组合到一起，就能够方便地拿到与Client端输入的相同的数据。

从Server端到Client端，反之亦然。

实现该方案时，相对复杂一点的地方是“对比用户输入JSON与Message定义，拿到丢失的信息”，需要递归得利用反射来得到，但只要多花些时间，相信并不难。

与前一种方案相比，这个方案的优点是不定义新的基本类型。至于缺点，就是给不同服务间通过gRPC调用增加了额外的复杂度，每一个服务都需要使用一个专门的方法来调用其他服务的接口，其中封装了前面提到的对比和组合过程。

上一章目录下一章