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

Go 问答:slog.LogValuer 返回自身时为什么会触发递归保护

来源:17golang原创

时间:2026-08-28 02:47:01 196浏览 收藏

给结构化日志接入自定义类型时,最容易误判的一点是:LogValuer.LogValue() 如果返回了包含自身的 slog.Value,程序是不是会一直递归。答案是不会。log/slog 在输出前通过 Value.Resolve 展开 LogValuer,遇到自返回或过深的嵌套会停止继续解析,把当前值当作最终结果交给 Handler。

LogValuer 当成“日志表示转换器”最稳妥:返回普通值、Group 或脱敏值;不要依赖递归展开来拼装对象。自返回不会无限循环,但它也不会替你得到有用的字段。

要点速览
  • LogValuer 的返回值仍可能是另一个 LogValuer,解析入口是 slog.Value.Resolve
  • 返回自身时,解析器用递归深度和自返回判断避免无限循环,最终保留一个可安全处理的值。
  • 日志脱敏应返回 slog.StringValueslog.GroupValue,不要返回原对象。
  • 测试应同时覆盖正常输出、自返回、间接循环和敏感字段不泄露。

LogValuer 到 Handler 之间发生了什么

slog.Any("user", value) 只是把对象放进 slog.Attr,真正写出文本或 JSON 时,Handler 才会解析它。简化后的调用关系可以记成 HandlerRecord.Attrsslog.Value.ResolveLogValuer.LogValue。这也是为什么一个昂贵的日志表示可以延迟到日志级别确认之后再计算。

Go slog Handler 经过 Record.Attrs 和 slog.Value.Resolve 调用 LogValuer.LogValue 的解析链

官方文档明确建议 Handler 作者使用 Value.Resolve,而不是直接调用 LogValue。这样既统一了普通值与自定义值的处理,也把循环和过深嵌套交给标准库的边界逻辑。

一个返回自身的 LogValuer 会得到什么结果

package main

import (
    "log/slog"
    "os"
)

type LoopValue struct{}

func (LoopValue) LogValue() slog.Value {
    return slog.AnyValue(LoopValue{})
}

func main() {
    logger := slog.New(slog.NewTextHandler(os.Stdout, nil))
    logger.Info("probe", "value", LoopValue{})
}

这里的 LoopValue.LogValue 返回的仍是 LoopValue,所以它形成了“值 → LogValuer → 值”的自返回路径。标准库解析器不会无限调用:到达保护边界后停止展开,Handler 可以继续完成一条日志记录。具体输出格式属于 Handler 的职责,不应把它当成业务状态。

Go slog LogValuer 返回自身后由 Value.Resolve 在递归保护边界停止展开

正常实现应该返回什么

如果类型中有密码、令牌或内部字段,最小可靠写法是直接返回一个不含原对象的值。下面的 SessionToken.LogValue 返回固定脱敏文本,解析到这里就结束,不会把底层字符串再次交给日志系统。

type SessionToken string

func (SessionToken) LogValue() slog.Value {
    return slog.StringValue("REDACTED_TOKEN")
}

type RequestInfo struct {
    Method string
    Path   string
}

func (r RequestInfo) LogValue() slog.Value {
    return slog.GroupValue(
        slog.String("method", r.Method),
        slog.String("path", r.Path),
    )
}

slog.GroupValue 适合把稳定字段放到同一组,slog.StringValue 适合脱敏后的单值。两种返回值都比“先转成字符串、再让 Handler 猜结构”清楚。

四种写法的边界怎么判断

实现方式Resolve 行为建议
返回 StringValue一次解析结束适合脱敏、稳定摘要
返回 GroupValue展开为结构化字段适合请求、业务对象的有限字段
返回另一个 LogValuer继续解析下一层只在转换链有明确边界时使用
返回自身或间接循环触发保护并停止继续展开视为实现错误,改为返回终值

“不会死循环”不等于“可以这样写”。自返回最终留下的是保护后的值,日志里通常看不到你想要的字段,而且不同 Handler 对异常值的展示可能不同。生产代码应让每个 LogValue 都在有限步数内落到 String、Bool、Int、Float、Duration、Time 或 Group 等终值。

测试要覆盖输出和安全边界

测试不要只断言日志字符串完全相等,因为 TextHandler 和 JSONHandler 的格式不同。更有价值的是分别验证:SessionToken 的原文不会出现;RequestInfomethodpath 字段存在;LoopValue 能完成一次日志调用且测试不会卡住。若自定义 Handler,直接对 slog.AnyValue(...).Resolve() 做单元测试,还要检查解析后的 kind 和属性。

func TestSessionTokenIsRedacted(t *testing.T) {
    value := slog.AnyValue(SessionToken("secret-123"))
    resolved := value.Resolve()
    if got := resolved.String(); got != "REDACTED_TOKEN" {
        t.Fatalf("resolved token = %q", got)
    }
}

这个断言关注的是脱敏契约,而不是某个 Handler 的排版。对循环值则应设置测试级超时,并把“调用完成”作为结果,避免把保护逻辑误测成无限等待。

常见问题

LogValuer 可以返回 slog.AnyValue 自己吗?

技术上可以返回一个包含同类值的 slog.Value,标准库会在解析时阻止无限递归;工程上不建议这样做,因为它没有提供稳定的最终日志表示。

Resolve 会调用 LogValue 几次?

正常实现应当很快落到终值,嵌套实现会按链条继续解析。不要把调用次数当成业务 API 契约;需要昂贵计算时,应先用日志级别过滤或在类型内部缓存明确结果。

脱敏字段应该返回空 Attr 吗?

如果字段完全不应出现,可以在 Handler 的 ReplaceAttr 中删除;如果需要保留“字段存在但已隐藏”的信号,返回 slog.StringValue("REDACTED_TOKEN") 更直观。

自定义 Handler 还能直接调用 LogValue 吗?

不建议。使用 Value.Resolve 能复用标准库对嵌套 LogValuer、递归和保护边界的处理,Handler 只需要处理解析后的值。

LogValuer 的价值在于把日志表示控制在类型内部,而不是把对象交给递归魔法。返回清晰的终值或有限字段组,再用 Resolve 和脱敏测试验收,日志输出才会稳定、可检索,也不会意外泄露内部数据。

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