如何配置Zap日志输出结构体的所有字段（含零值）

我正在构建如下日志工具：

config := zap.NewDevelopmentConfig()

logger, err := config.Build()
if err != nil {
    log.Fatal(err)
}

我定义了如下Request结构体（由Protobuf生成）：

type Request struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    Name    string `protobuf:"bytes,1,opt,name=name"`
    Surname string `protobuf:"bytes,2,opt,name=surname"`
}

当我尝试打印不含Surname字段的gRPC请求时，执行代码：

logger.Infof("got request: %v", request)

得到的日志输出为：

got request: name:"Bob"

我希望日志能输出结构体的所有字段（包括零值字段），例如：

got request: name:"Bob" surname:""

请问Zap是否有相关配置可以实现该需求？

解决方案 #

要让Zap打印出Protobuf结构体的所有字段（包括零值），可以通过以下两种方式实现：

1. 手动用Protobuf Text序列化并指定包含零值 #

Protobuf的textproto包支持序列化时输出零值字段，你可以先将结构体序列化为带零值的文本，再传入Zap日志：

import "google.golang.org/protobuf/encoding/textproto"

// 配置序列化选项，启用零值字段输出
marshaler := textproto.MarshalOptions{
    EmitUnpopulated: true,
    Multiline: false,
}

reqText, err := marshaler.Marshal(request)
if err != nil {
    logger.Error("failed to marshal request", zap.Error(err))
    return
}

logger.Info("got request", zap.String("request", string(reqText)))

2. 自定义Zap编码器全局生效 #

如果希望所有Protobuf结构体日志都自动输出零值字段，可以自定义Zap的编码器逻辑，替换默认的Protobuf处理方式：

import (
    "fmt"
    "log"
    "go.uber.org/zap"
    "go.uber.org/zap/zapcore"
    "google.golang.org/protobuf/encoding/textproto"
    "google.golang.org/protobuf/reflect/protoreflect"
)

func main() {
    config := zap.NewDevelopmentConfig()
    
    // 重写值编码器，处理Protobuf消息
    config.EncoderConfig.EncodeValues = func(value zapcore.Value, encoder zapcore.PrimitiveArrayEncoder) {
        // 判断是否为Protobuf消息类型
        if msg, ok := value.Interface().(interface{ ProtoReflect() protoreflect.Message }); ok {
            marshaler := textproto.MarshalOptions{
                EmitUnpopulated: true,
                Multiline: false,
            }
            text, err := marshaler.Marshal(msg)
            if err != nil {
                encoder.AppendString(fmt.Sprintf("<proto marshal error: %v>", err))
                return
            }
            encoder.AppendString(string(text))
            return
        }
        // 其他类型沿用默认编码逻辑
        zapcore.DefaultEncodeValues(value, encoder)
    }

    logger, err := config.Build()
    if err != nil {
        log.Fatal(err)
    }

    logger.Info("got request", zap.Any("request", request))
}

注意：不要直接使用logger.Infof配合%v，因为Protobuf结构体的默认String()方法本身就会忽略零值字段，改用Zap的结构化日志字段（如zap.Any）才能实现需求。

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