登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go问答

自定义 slog Handler 为什么会重复输出属性

来源:17golang原创

时间:2026-10-09 15:29:41 341浏览 收藏

自定义 slog.Handler 时,属性重复通常不是 log/slog 自动追加了两遍,而是 Handler 同时把“预置属性”和当前 slog.Record 属性写入了两次。最常见的触发点是 WithAttrs 修改了接收者自身,或者 WithGroup 已经把属性展开后,Handle 又按原始属性再展开一次。

要点速览
  • WithAttrs 和 WithGroup 都应返回新的 Handler,不能污染原对象。
  • Handle 只负责一次性合并预置属性与 Record 属性,组路径只展开一次。
  • 排查时先区分 Logger.With、日志调用参数和分组属性,再检查切片别名。

先把重复属性定位到三条输入路径

下面这段调用同时包含了三类属性:With 放入的固定字段、LogAttrs 放入的事件字段,以及 WithGroup 形成的分组字段。Handler 如果把它们都存进同一个切片,却在 Handle 中再遍历一次 Record,就很容易出现重复。

base := slog.New(customHandler)
service := base.With("service", "billing")
request := service.WithGroup("request")
request.LogAttrs(ctx, slog.LevelInfo, "paid",
    slog.String("id", "p-42"), // 当前事件属性只应进入 Record 一次
)

正确的心智模型是:With 产生的属性属于 Handler 状态,LogAttrs 的参数属于本次 Record;WithGroup 只改变后续键的限定路径。先在自定义 Handler 的 WithAttrs、WithGroup 和 Handle 各打印一次调试计数,通常马上能看到是哪一步把数量翻倍。

Go slog 自定义 Handler 中 WithAttrs、WithGroup 与 Record 属性的输入边界说明图
图1:slog 属性来源边界说明图,展示预置属性、分组作用域和当前 Record 的一次性汇合关系。

WithAttrs 必须复制状态而不是追加到原切片

slog.Handler 的派生方法可以被同一个 Logger 多次调用。若直接对接收者的 attrs 做 append,先创建的子 Logger 可能看到后续调用留下的字段;若底层数组容量足够,还会出现“偶尔重复、换个顺序又不重复”的假象。

func (h *handler) WithAttrs(attrs []slog.Attr) slog.Handler {
    next := &handler{out: h.out}
    // 复制已有属性,避免派生 Logger 共享可变切片。
    next.attrs = append([]slog.Attr(nil), h.attrs...)
    // 再复制调用方切片,Handler 不接管外部切片的后续修改。
    next.attrs = append(next.attrs, attrs...)
    // 返回新状态,原 Handler 仍可作为公共基线继续复用。
    return next
}

这里的关键不是“多写了几行复制”,而是遵守派生对象语义。官方 Handler 示例也会在 WithAttrs 中复制状态;如果为了性能做预格式化,同样要把新状态和旧状态隔离开。

WithGroup 只记录作用域,Handle 统一展开一次

重复的另一来源是把组名当成普通属性保存。例如 WithGroup("request") 先把 id 改成 request.id,Handle 又根据 groups 再加一次前缀,最终会得到 request.request.id,甚至在 JSON 输出中出现两层同名对象。

func (h *handler) WithGroup(name string) slog.Handler {
    if name == "" {
        return h
    }
    next := *h
    // 组名延迟到 Handle 展开,避免预置属性和事件属性各展开一次。
    next.groups = append([]string(nil), h.groups...)
    next.groups = append(next.groups, name)
    return &next
}

在 Handle 中,把 h.attrs 追加一次,再遍历 r.Attrs 追加一次;每个 Attr 先 Resolve,然后交给同一个带 group 栈的写出函数。不要同时保留“已经加过前缀的字符串”和“原始 Attr”两份数据。

Go slog Handler 在 Handle 中一次展开 group 路径并输出属性的结构图
图2:Handler 分组展开结构图,说明组路径应在一次 Handle 中统一应用,避免重复前缀或重复对象。

Handle 的合并顺序决定是否会写两遍

一个稳定的实现顺序是“打开输出状态—写内置字段—写 Handler 属性—写 Record 属性—关闭分组”。如果 WithAttrs 已经预格式化了一部分字段,Handle 就只能写剩余部分,不能把原 Attr 再遍历一次。

func (h *handler) Handle(ctx context.Context, r slog.Record) error {
    _ = ctx // 仅示例:自定义 Handler 可按需读取上下文。
    attrs := make([]slog.Attr, 0, len(h.attrs)+r.NumAttrs())
    attrs = append(attrs, h.attrs...)
    // Record 属性只收集一次;后续统一 Resolve 和分组写出。
    r.Attrs(func(a slog.Attr) bool {
        attrs = append(attrs, a)
        return true
    })
    for _, attr := range attrs {
        resolved := attr.Resolve()
        if resolved.Equal(slog.Attr{}) {
            continue // 零值属性不应制造空字段。
        }
        if err := h.writeAttr(resolved); err != nil {
            return err // 保留输出错误,避免静默丢失日志。
        }
    }
    return nil
}

这段骨架省略了具体编码格式,但保留了排查重复最重要的边界:属性只有一个汇合点。JSON Handler 还要遵守组为空时不输出空对象、空组名内联属性等规则;不要为了“看起来方便”把同一 Attr 同时写入扁平键和值对象。

用四组场景确认修复没有副作用

场景应观察的结果重点检查
base.With 再派生两个 Logger两个子 Logger 各有自己的字段WithAttrs 是否改了原切片
WithGroup 后 LogAttrs组名只出现一次Handle 是否重复加前缀
空组或空 Attr不出现空对象、空键Resolve 后的过滤规则
多个 goroutine 共用基础 Logger字段不串线、不增长派生状态是否不可变

如果只有并发场景才重复,优先怀疑共享切片或复用的缓冲区;如果只有 JSON 重复,检查组打开和关闭计数;如果文本和 JSON 都重复,则先回到 WithAttrs 与 Handle 的合并次数。

相关问题

WithAttrs 返回原 Handler 会一定重复吗?

不一定;当 attrs 为空或 Handler 是不可变值类型时可以返回原对象。但只要需要追加可变状态,就应复制后返回新 Handler。

为什么不能只在 Handle 里去重键名?

键名去重会掩盖状态污染,还可能误删同一事件中有意出现的字段。应先修复属性来源和分组边界,再按格式规则处理冲突。

自定义 Handler 是否应该直接照抄 JSONHandler?

不建议。可以参考官方 Handler 设计和示例,保留自己的输出格式,但必须实现 Enabled、Handle、WithAttrs、WithGroup 的完整语义。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>