JsonFormat.printer().print()工作原理及Proto序列化异常问题咨询

一、先聊聊JsonFormat.printer().print() 到底怎么工作 #

JsonFormat.printer()是Protobuf Java库里专门用来把Proto消息转成JSON字符串的工具，它的工作逻辑其实挺直白的：

• 挨个扫消息里的字段：不管是基本类型、嵌套消息还是枚举，它会递归地把所有被你主动设置过、且值不是默认值的字段都过一遍。
• 做类型转换适配：把Protobuf的原生类型对应转成JSON能识别的类型，比如Protobuf的bool转JSON的布尔值，数字类型直接转成JSON数字，字符串就原样保留。
• 按JSON规矩拼格式：最后把这些字段按标准JSON的语法打包成字符串，比如给键加引号、用逗号分隔键值对、嵌套结构用大括号包裹之类的。
• 默认不碰默认值字段：这一点特别重要，也是你遇到问题的核心——默认情况下，它不会序列化那些保持默认值的字段。

二、你的布尔字段“异常”其实是默认规则在搞鬼 #

你定义的ChargeCardResponse里，success是布尔类型，而Protobuf里布尔类型的默认值就是false。JsonFormat.printer()的默认逻辑是：只有字段值不等于默认值的时候，才会把它放进输出的JSON里。

所以当你调用builder.setSuccess(true).build()时，success的值是true（和默认值false不一样），自然会被正常序列化成{ "success": true }；但如果你设置的是setSuccess(false)，或者干脆没调用这个set方法（因为builder刚创建时success就是默认的false），这个字段就会被工具忽略，输出的JSON就变成空的{}了——看起来像是出了问题，但其实这是它的默认行为。

怎么解决？强制输出所有字段就行 #

如果想要不管字段是不是默认值，都把它序列化到JSON里，你只需要在创建printer的时候加上includingDefaultValueFields()这个配置：

// 开启默认值字段序列化功能
JsonFormat.Printer printer = JsonFormat.printer().includingDefaultValueFields();
ChargeCardResponse.Builder builder2 = ChargeCardResponse.newBuilder();
System.out.println(printer.print(builder2.setSuccess(false).build()));

这样不管success是true还是false，都会被正常输出成对应的JSON键值对啦。

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