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

Go log/slog Handler.WithAttrs 怎样附加公共字段

来源:17golang原创

时间:2026-10-25 09:26:56 101浏览 收藏

如果想给后续日志统一附加请求号、服务名或租户字段,优先使用 logger.With(...)。它会把属性交给底层 Handler.WithAttrs,得到一个带公共属性的新 Handler;原来的 Logger 和 Handler 仍可独立使用。真正要注意的是:WithAttrs 返回的是新 Handler,不是把属性写回接收者。

官方地址:https://pkg.go.dev/log/slog#Handler

  • 公共字段放在 Logger.With,单条事件字段放在 Info 或 LogAttrs。
  • 自定义 Handler 必须保留原 Handler 的行为,并返回带附加属性的新实例。
  • 属性可以被预格式化,但不能因为复用切片而让两个 Logger 互相污染。

Logger.With 为什么不会污染原 Handler

Logger.With 适合表达“从这里开始,后续日志都带上这些字段”。底层 Handler 可以保存属性,也可以提前把属性格式化好;接口要求是返回一个新的 Handler,接收者本身保持不变。这样,同一个基础 Logger 可以派生出多个带不同上下文的 Logger。

Logger With 调用 Handler WithAttrs 后新旧 Handler 与 Record 的静态关系说明图
图1:结构说明图,查看 Logger.With 产生新 Handler 后与原 Handler 的边界;这是静态说明图,不是运行截图。
package main

import (
	"log/slog"
	"os"
)

func main() {
	base := slog.New(slog.NewTextHandler(os.Stdout, nil))
	requestLogger := base.With(
		slog.String("service", "checkout"),
		slog.String("request_id", "req-42"),
	)

	// 派生 Logger 只增加公共字段,base 仍可记录没有 request_id 的日志。
	requestLogger.Info("开始处理订单", slog.Int("order_id", 7))
	base.Info("基础日志")
}

这里的 order_id 是单条记录属性,而 service 与 request_id 属于派生 Logger 的公共属性。不要把所有字段都放进 With:每次请求都变化的值应在创建请求 Logger 时加入,事件专属值仍应留在具体日志调用上。

把公共字段放在哪一层更清楚

可以把属性分成三层:服务级字段、请求级字段和事件级字段。服务级字段通常在初始化 Logger 时附加;请求级字段随请求上下文派生;事件级字段只描述当前动作。这样的分层不依赖某个输出格式,TextHandler 和 JSONHandler 都会按自己的规则呈现。

字段层级推荐位置典型内容
服务级base.Withservice、version
请求级requestLogger := base.Withrequest_id、tenant
事件级LogAttrs 或单次日志调用order_id、result、err

如果一个派生 Logger 被多个请求共享,就不要把请求级字段写到它上面;字段本身虽然不会修改原 Handler,但共享错误的 Logger 仍会让日志语义混乱。隔离实例和隔离业务生命周期是两件事。

自定义 Handler 要守住哪些属性边界

当内置 Handler 不满足格式或采样需求时,才需要实现 slog.Handler。其中 WithAttrs 与 WithGroup 都应该返回新的 Handler,Handle 再把已保存属性与当前 Record 组合。实现时不要直接修改接收者里的 slice,也不要假定属性已经被解析成最终字符串。

自定义 slog Handler 的 WithAttrs WithGroup Handle Record 与 LogValuer 静态关系说明图
图2:结构说明图,查看自定义 Handler 的构造、记录处理和值解析边界;这是静态说明图,不是运行截图。
type attrsHandler struct {
	inner slog.Handler
	attrs []slog.Attr
}

func (h *attrsHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
	// 复制切片,避免调用方后续复用底层数组影响当前 Handler。
	merged := make([]slog.Attr, 0, len(h.attrs)+len(attrs))
	merged = append(merged, h.attrs...)
	merged = append(merged, attrs...)

	// 返回新实例,原 h 保持可复用且语义不变。
	return &attrsHandler{inner: h.inner, attrs: merged}
}

func (h *attrsHandler) WithGroup(name string) slog.Handler {
	// 分组语义交给内部 Handler,避免自定义实现重新猜测键名规则。
	return &attrsHandler{inner: h.inner.WithGroup(name), attrs: h.attrs}
}

func (h *attrsHandler) Handle(ctx context.Context, r slog.Record) error {
	// 先复制记录,再追加公共属性,避免改变调用方持有的 Record。
	copyRecord := r.Clone()
	copyRecord.AddAttrs(h.attrs...)
	return h.inner.Handle(ctx, copyRecord)
}

这个骨架只展示边界关系,实际实现还应按输出需求处理空属性、分组和错误。Record 中的值可能实现 LogValuer,需要在合适的输出阶段通过 Value.Resolve 解析;不要在 WithAttrs 阶段把所有值强行转换为字符串,否则会丢失结构化语义。

最小检查:字段是否真的按预期出现

可以用两个派生 Logger 做最小核对:它们共享基础 Handler,但各自加入不同的请求字段。检查重点不是某一种文本排版,而是公共字段是否只出现在对应 Logger 的记录中,事件字段是否没有意外变成全局字段。

func checkLoggerIsolation(logger *slog.Logger) {
	left := logger.With(slog.String("request_id", "left"))
	right := logger.With(slog.String("request_id", "right"))

	// 两个派生 Logger 使用不同请求上下文,不能互相看到对方的 request_id。
	left.Info("left event")
	right.Info("right event")
}

如果自定义 Handler 在实现 WithAttrs 时复用了可变 slice,问题通常会表现为后创建的 Logger 改变了先创建 Logger 的字段。优先检查 slice 复制、Handler 是否返回新实例,以及 WithGroup 是否仍由底层 Handler 维护分组规则。

常见问题

Handler.WithAttrs 会修改原 Handler 吗?

接口语义要求返回一个带附加属性的新 Handler,原 Handler 应保持不变。自定义实现如果需要保存属性,应复制可变容器或采用不可变结构。

公共字段和单次字段都能放在 LogAttrs 里吗?

可以,但每次调用都重复传公共字段会增加样板代码。稳定字段适合放到 With 派生 Logger,当前事件字段再用 LogAttrs 补充。

记住一条边界即可:With 描述 Logger 的上下文,WithAttrs 描述 Handler 的派生关系,Handle 才负责把属性与记录交给最终输出。

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