slog.Handler 怎样让 source 字段只在调试开启

如果希望 Go 的 slog 日志只在调试时带上 source 字段，关键不是在输出字符串里再做一次判断，而是在创建 slog.Handler 时决定是否启用 HandlerOptions.AddSource。调试开关在进程启动时就确定，直接把它绑定到 AddSource；如果开关会运行时变化，则让 AddSource 保持为 true，再用 ReplaceAttr 按当前状态丢弃或保留 source。

两种方案的取舍很明确：启动时配置的方式在生产环境连源码位置计算都省掉，适合大多数服务；运行时过滤方式不需要重建 Handler，但关闭调试时仍可能付出计算 source 的成本。

AddSource 决定 source 是否被生成，ReplaceAttr 决定已经生成的属性是否进入最终输出。调试状态不会自动改变 Handler，必须在这两个位置之一显式绑定。

AddSource 才是 source 字段的开关

slog.HandlerOptions 同时服务于 JSONHandler 和 TextHandler。AddSource 为 true 时，Handler 会计算日志调用位置，并把它作为内置的 source 属性交给输出处理；默认值为 false，因此普通日志不会凭空出现源码文件和行号。

这也解释了一个常见误区：ReplaceAttr 不是 source 的生成开关。只有 AddSource 开启时，内置的 source 才会进入属性替换回调；若 AddSource 为 false，回调无法“补出”调用位置。

启动时已经知道调试状态：直接绑定 AddSource

如果调试模式来自启动参数、环境变量或配置文件，并且进程启动后不会频繁切换，推荐让构造函数接收一个 debug 布尔值。调试关闭时，Handler 从源头不生成 source；这比先生成再删除更省，也让生产日志的字段集合更稳定。

package logging

import (
	"io"
	"log/slog"
)

// NewLogger 按启动时的调试开关创建日志器。
func NewLogger(w io.Writer, debug bool) *slog.Logger {
	options := &slog.HandlerOptions{
		// 调试时计算调用文件和行号，生产时完全关闭 source。
		AddSource: debug,
	}

	// JSONHandler 也可以替换为 TextHandler，开关语义不变。
	return slog.New(slog.NewJSONHandler(w, options))
}

调用方不需要在每一条日志上写 if debug。配置被封装在 Handler 中后，普通业务代码继续使用 logger.Info、logger.Error 即可。调试模式下输出会带有 source，生产模式下不会包含这个字段。

运行时要切换：用 ReplaceAttr 保留一个 Handler

有些服务会通过管理接口或动态配置临时打开调试。如果每次切换都重建全局 Logger，容易让并发请求拿到不同实例。此时可以让 AddSource 一直为 true，并在 ReplaceAttr 中只处理键名为 source 的内置属性。

package logging

import (
	"io"
	"log/slog"
	"sync/atomic"
)

// RuntimeMode 保存可并发读取的调试状态。
type RuntimeMode struct {
	debug atomic.Bool
}

// NewRuntimeLogger 创建可动态隐藏 source 的 Logger。
func NewRuntimeLogger(w io.Writer, mode *RuntimeMode) *slog.Logger {
	options := &slog.HandlerOptions{
		// 必须先生成 source，ReplaceAttr 才能看到这个内置属性。
		AddSource: true,
		ReplaceAttr: func(_ []string, attr slog.Attr) slog.Attr {
			// 关闭调试时删除 source，其余字段保持原样。
			if attr.Key == "source" && !mode.debug.Load() {
				return slog.Attr{}
			}
			return attr
		},
	}

	return slog.New(slog.NewJSONHandler(w, options))
}

// SetDebug 只更新开关，不重建 Logger。
func (m *RuntimeMode) SetDebug(enabled bool) {
	m.debug.Store(enabled)
}

这里返回零值 slog.Attr{}，表示丢弃当前属性。ReplaceAttr 还会接收到 time、level、msg 等内置属性，因此必须只判断 attr.Key == "source"，不能把所有内置属性一并删除。

两种方案怎么选

如果服务的日志量较大，生产环境关闭 AddSource 的收益不只是在 JSON 里少一个字段，还包括少一次调用位置计算。运行时方案的优势是配置切换简单，但不能把它误认为完全等价的性能方案。

source 不出现或不该出现时检查四件事

第一，确认真正使用的是带选项的 Handler，而不是另一个默认创建的 slog.Default()。第二，检查是否误把 ReplaceAttr 当成生成开关：AddSource 未打开时，它不会提供 source。第三，确认回调判断的是内置键名 source，而不是把它当成自定义分组后的完整路径。第四，若配置是运行时切换，确保状态读取是并发安全的，并且所有组件共享同一个 Handler 策略。

func hideSource(groups []string, attr slog.Attr, debug bool) slog.Attr {
	// 分组路径不是判断 source 是否存在的必要条件，先匹配内置键名。
	if attr.Key == "source" && !debug {
		return slog.Attr{}
	}

	// 其他属性原样返回，避免误删 level、msg 或业务字段。
	return attr
}

若使用了 WithGroup，可以根据业务需要查看 groups，但不要为了判断 source 而硬编码某个业务分组。日志输出格式或分组名称变化时，按键名过滤通常更容易维护。

结论

调试开关与 slog.Handler 的关系可以归纳为一句话：AddSource 控制是否产生源码位置，ReplaceAttr 控制已经产生的属性是否保留下来。固定配置选择前者，动态切换选择后者；不要在每一条业务日志中重复判断，也不要用默认 Logger 覆盖掉带选项的 Handler。

相关问题

为什么只写 ReplaceAttr 仍然没有 source？ 因为 AddSource 默认为 false，没有生成的内置属性不会进入替换回调。

TextHandler 和 JSONHandler 的配置方式不同吗？ 不同的只是输出格式，二者都读取 HandlerOptions.AddSource 和 ReplaceAttr。

运行时切换调试时一定要重建 Logger 吗？ 不一定。用 AddSource: true 配合并发安全的状态和 ReplaceAttr 可以复用 Handler，但要承担 source 计算成本。