解析JSON到Protobuf消息时如何忽略类型不匹配并保留有效字段？

环境与定义 #

使用Protobuf 3.21.12版本，proto文件定义如下：

syntax = "proto2";

message MyBidRequest {
  optional string req_id = 1;
  optional int32 tmax = 2;
}

原解析代码：

// Read JSON string from a file or any source
std::string json_string = R"( 
{
  "req_id": 1,
  "tmax": 777
}
)";

// Create an instance of the protobuf message
MyBidRequest my_bid_request;

// Parse the JSON string into the protobuf message
google::protobuf::util::Status myStatus = google::protobuf::util::JsonStringToMessage(json_string, &my_bid_request);

std::cout << "Jsonstring to Message Status string:" << myStatus.ToString() << std::endl;

// Access the fields of the protobuf message
std::cout << "1:Field req_id: " << my_bid_request.req_id() << std::endl;
std::cout << "1:Field tmax: " << my_bid_request.tmax() << std::endl;

运行输出：

Jsonstring to Message Status string:INVALID_ARGUMENT:(req_id): invalid value 1 for type TYPE_STRING
1:Field req_id: 
1:Field tmax: 0

问题与需求 #

当前单个字段类型不匹配时，整个JSON解析失败，有效字段（如示例中的tmax）也无法保留。需求如下：

• 字段类型不匹配时，丢弃该字段（或设默认值），保留其余有效字段
• 解析结果由应用层决定是否丢弃整个JSON，而非Protobuf库直接判定失败

解决方案 #

通过配置Protobuf的JsonParseOptions，开启忽略不匹配字段的选项即可实现需求：

修改后的解析代码 #

// Read JSON string from a file or any source
std::string json_string = R"( 
{
  "req_id": 1,
  "tmax": 777
}
)";

// Create an instance of the protobuf message
MyBidRequest my_bid_request;

// 配置JSON解析选项
google::protobuf::util::JsonParseOptions options;
// 忽略类型不匹配或未知的字段，避免单个字段问题导致整体解析失败
options.ignore_unknown_fields = true;
// 可选：开启自动类型转换（如将数字转为字符串），按需启用
// options.allow_numbers_as_strings = true;

// 使用带配置的解析方法
google::protobuf::util::Status myStatus = google::protobuf::util::JsonStringToMessage(json_string, &my_bid_request, options);

std::cout << "Jsonstring to Message Status string:" << myStatus.ToString() << std::endl;

// 访问解析后的字段，通过has_xxx()判断字段是否有效
std::cout << "1:Field req_id: " << (my_bid_request.has_req_id() ? my_bid_request.req_id() : "未设置（类型不匹配被忽略）") << std::endl;
std::cout << "1:Field tmax: " << my_bid_request.tmax() << std::endl;

代码说明 #

1. ignore_unknown_fields = true：核心配置，让Protobuf忽略所有无法匹配的字段（包括类型不匹配的字段），保证有效字段正常解析，不会因单个字段问题导致整体失败。
2. allow_numbers_as_strings = true（可选）：如果希望Protobuf自动尝试类型转换（比如把JSON中的数字1转为字符串类型的req_id），可以开启此选项，此时req_id会被赋值为"1"而非被忽略。
3. 应用层可通过has_xxx()方法判断字段是否成功解析，进而决定是否丢弃整个消息。

修改后运行输出 #

仅开启ignore_unknown_fields时：

Jsonstring to Message Status string:OK
1:Field req_id: 未设置（类型不匹配被忽略）
1:Field tmax: 777

同时开启allow_numbers_as_strings时：

Jsonstring to Message Status string:OK
1:Field req_id: 1
1:Field tmax: 777

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