golang

Go 入门：用 slog 写可检索的结构化日志

日志不是程序最后随手加的一行 。线上排查问题时，日志经常是第一证据：哪个用户触发了请求、参数是什么、调用下游花了多久、错误发生在哪一层。纯文本日志能看，但不方便检索。结构化日志把关键信息放到字段里，日志平台可以按字段过滤、聚合和统计。

plumephp 11 分钟阅读 5233 字

日志不是程序最后随手加的一行 fmt.Println。线上排查问题时，日志经常是第一证据：哪个用户触发了请求、参数是什么、调用下游花了多久、错误发生在哪一层。纯文本日志能看，但不方便检索。结构化日志把关键信息放到字段里，日志平台可以按字段过滤、聚合和统计。

Go 标准库从 1.21 开始提供 log/slog。它不追求复杂功能，但足够覆盖大多数入门项目。

创建 JSON Logger

服务端程序通常使用 JSON 日志：

package main

import (
	"log/slog"
	"os"
)

func main() {
	logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
	logger.Info("server started", "addr", ":8080")
}

输出类似：

{"time":"2025-07-28T08:54:00+08:00","level":"INFO","msg":"server started","addr":":8080"}

字段 addr 可以被日志系统索引。以后想找某个端口的启动记录，不需要全文搜索。

字段要稳定

结构化日志最怕字段名一会儿叫 user_id，一会儿叫 uid，一会儿又叫 userId。团队要尽量统一命名。

logger.Info("order created",
	"user_id", userID,
	"order_id", orderID,
	"amount", amount,
)

字段值也要选对类型。金额如果是分，就叫 amount_cents，不要只叫 amount 让人猜单位。耗时可以用 duration_ms，便于统计。

带上下文的 logger

一组日志共享字段时，可以用 With：

reqLogger := logger.With(
	"request_id", requestID,
	"user_id", userID,
)

reqLogger.Info("load profile")
reqLogger.Info("profile loaded", "duration_ms", 12)

这样每条日志都会带上 request_id 和 user_id。排查一次请求时，只要按 request_id 过滤，就能看到完整路径。

HTTP 请求日志中间件

一个简单中间件：

func accessLog(logger *slog.Logger, next http.Handler) http.Handler {
	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		start := time.Now()
		next.ServeHTTP(w, r)
		logger.Info("http request",
			"method", r.Method,
			"path", r.URL.Path,
			"duration_ms", time.Since(start).Milliseconds(),
			"remote", r.RemoteAddr,
		)
	})
}

这个版本还拿不到状态码，因为 http.ResponseWriter 默认不会记录。可以包一层：

type statusWriter struct {
	http.ResponseWriter
	status int
}

func (w *statusWriter) WriteHeader(code int) {
	w.status = code
	w.ResponseWriter.WriteHeader(code)
}

中间件里使用：

sw := &statusWriter{ResponseWriter: w, status: http.StatusOK}
next.ServeHTTP(sw, r)
logger.Info("http request", "status", sw.status)

这样访问日志能按状态码筛选。看到 500 增多时，可以快速定位路径。

错误日志不要重复打

新手常在每一层都打印错误：repo 打一次，service 打一次，handler 再打一次。结果同一个错误出现三条日志，排查时反而混乱。通常在边界处记录一次，比如 HTTP handler 或 worker 入口。

if err := svc.Create(ctx, req); err != nil {
	logger.Error("create order failed",
		"error", err,
		"user_id", req.UserID,
		"sku", req.SKU,
	)
	http.Error(w, "create order failed", http.StatusInternalServerError)
	return
}

下层函数负责用 %w 包装错误，上层负责记录上下文。这样日志既有业务字段，也保留错误链。

级别怎么选

日志级别没有绝对标准，但可以有团队约定：

logger.Debug("cache miss", "key", key)
logger.Info("job finished", "job_id", id)
logger.Warn("retry third party", "attempt", attempt, "error", err)
logger.Error("job failed", "job_id", id, "error", err)

Debug 给开发和临时排查；Info 记录正常关键事件；Warn 表示出现异常但程序还能恢复；Error 表示请求或任务失败，需要关注。不要把用户输错密码记成 error，也不要把数据库写入失败记成 info。

隐私和脱敏

结构化日志很方便，也更容易把敏感信息稳定地送进日志系统。密码、token、身份证号、完整手机号不要记录。必要时只记录后四位或哈希。

func maskPhone(s string) string {
	if len(s) < 4 {
		return "***"
	}
	return "***" + s[len(s)-4:]
}

日志是排查工具，不是数据仓库。能不记录敏感字段，就不要记录。尤其是第三方回调、登录请求、支付参数，写日志前要多想一步。

设置默认 logger

如果项目里很多地方使用 slog.Info，可以设置默认 logger：

logger := slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
	Level: slog.LevelInfo,
}))
slog.SetDefault(logger)

然后：

slog.Info("started")

小项目这样很方便。较大的项目里，我更倾向显式把 *slog.Logger 传给组件，依赖关系更清楚，也更容易在测试里替换。

测试日志输出

测试时可以把日志写到 buffer：

var buf bytes.Buffer
logger := slog.New(slog.NewJSONHandler(&buf, nil))
logger.Info("created", "id", 12)

if !strings.Contains(buf.String(), `"id":12`) {
	t.Fatalf("missing id field: %s", buf.String())
}

通常不需要测试每条日志，但关键审计日志、任务状态日志可以测，避免重构时把重要字段改没了。

给组件注入 Logger

服务变大后，不建议每个包都直接用全局 slog.Default()。把 logger 作为依赖传进去，组件边界更清楚。

type OrderService struct {
	logger *slog.Logger
	repo   OrderRepo
}

func NewOrderService(logger *slog.Logger, repo OrderRepo) *OrderService {
	return &OrderService{logger: logger, repo: repo}
}

func (s *OrderService) Create(ctx context.Context, order Order) error {
	if err := s.repo.Save(ctx, order); err != nil {
		s.logger.Error("save order failed", "order_id", order.ID, "error", err)
		return err
	}
	return nil
}

测试时可以传一个写到 io.Discard 的 logger，避免测试输出被日志淹没。线上则可以在组装依赖时统一加上服务名、版本和环境字段。

日志字段不要塞整包对象

结构化日志不是把整个请求对象都丢进去。对象里可能有密码、token、长文本，也可能让日志变得巨大。更好的做法是挑选排查需要的字段。

logger.Info("payment callback",
	"payment_id", req.PaymentID,
	"merchant_id", req.MerchantID,
	"status", req.Status,
)

字段少而稳定，日志平台更容易建索引，排查时也更快。真正需要完整原文的回调，可以保存到受控的审计表或对象存储，而不是长期写入普通应用日志。

小结

slog 让 Go 标准库具备了结构化日志能力。入门时先做到：使用 JSON handler，字段名稳定，错误只在边界记录一次，日志级别有明确含义，敏感信息不进日志。

日志写得好，线上排查会轻很多；日志写得乱，数据越多越像噪音。结构化日志的价值不在“看起来高级”，而在于它能被检索、统计和关联。每加一个字段，都应该想清楚以后会怎样使用它。

常见问题与解答

slog 和第三方日志库怎么选？

Go 1.21+ 的标准库 log/slog 已经足够大多数项目使用。它的 JSON handler 输出稳定，API 简单。如果项目需要更高级功能（如异步写入、日志轮转、多输出目标），再考虑 zap、zerolog 等第三方库。

日志级别怎么选？

  • Debug：开发调试信息，生产环境通常关闭
  • Info：正常业务流程记录，请求完成、任务启动
  • Warn：异常但可恢复的情况，重试、降级
  • Error：请求失败、任务失败，需要关注和排查

不要把所有日志都打到 Info，也不要把用户输入错误记成 Error。

怎么处理日志量太大？

logger := slog.New(slog.NewJSONHandler(os.Stdout, &slog.HandlerOptions{
    Level: slog.LevelInfo,
    ReplaceAttr: func(groups []string, a slog.Attr) slog.Attr {
        if a.Key == "spam_field" {
            return slog.Attr{}
        }
        return a
    },
}))

日志采样

高频路径上的日志可以采样：

func sampledLogger(base *slog.Logger, fraction int) *slog.Logger {
    return slog.New(&samplingHandler{
        base:     base.Handler(),
        fraction: fraction,
        rand:     rand.New(rand.NewSource(time.Now().UnixNano())),
    })
}

集中式日志服务集成

JSON 日志可以直接发送到 Fluentd、Logstash 或云日志服务。或者先把日志写到本地文件，再用 sidecar 收集到日志服务。

日志脱敏最佳实践

func maskEmail(email string) string {
    parts := strings.Split(email, "@")
    if len(parts) != 2 {
        return "***"
    }
    local := parts[0]
    if len(local) > 2 {
        local = local[:1] + "***" + local[len(local)-1:]
    }
    return local + "@" + parts[1]
}

敏感字段脱敏应该在记录日志前处理好，不要依赖下游日志服务来过滤。

实践练习

完成以下练习以巩固所学知识：

  1. 阅读 Go 官方文档相关章节
  2. 编写一个完整的示例程序
  3. 为示例程序编写单元测试
  4. 使用 go test 和 go benchmark 验证实现
  5. 尝试优化内存分配和运行时间

推荐阅读

真实项目用例

在实际团队协作中，下面是几个推荐的工作流：

代码审查清单

  • 函数是否处理了所有 error 返回值
  • 并发代码是否有明确的退出路径和 WaitGroup
  • 用户输入是否经过校验和清洗
  • 敏感配置是否通过环境变量或加密存储注入
  • 测试是否覆盖了正常路径和至少一个错误路径
  • 日志是否包含足够的上下文信息但不泄露敏感数据
  • 接口设计是否符合最小接口原则

CI/CD 集成建议

  • 每次提交前运行 go fmt ./...
  • CI 中运行 go vet ./... 和 golangci-lint run
  • 单元测试使用 go test -race ./... 检测数据竞争
  • 关键路径的 benchmark 加入回归测试
  • 使用 go mod verify 确保依赖完整性

性能调优检查点

  • 使用 pprof 分析 CPU 和内存使用
  • 关注 benchmark 的 allocs/op，减少高频路径的堆分配
  • 检查数据库查询是否使用索引
  • 确认外部 HTTP 调用有合理的超时设置
  • 缓存热点数据，但注意缓存一致性和过期策略

面试高频考点

如果你正在准备 Go 相关面试，以下概念是高频考点：

  1. goroutine 和线程的区别
  2. channel 的缓冲和非缓冲用法
  3. defer 的执行顺序和与返回值的关系
  4. map 的并发不安全性和解决方案
  5. interface 的隐式实现和类型断言
  6. slice 的底层数组和 append 机制
  7. GC 的基本原理和调优参数
  8. context 的使用场景和超时控制
  9. error 的包装和 errors.Is/errors.As
  10. sync.Mutex vs sync.RWMutex vs atomic

掌握这些概念意味着你具备了独立开发 Go 服务的基础能力。继续在实际项目中磨练，你会越来越熟悉 Go 的工程风格和最佳实践。

常见问题（FAQ）

Q: 这个特性在实际项目中真的有用吗？
A: 是的。本文介绍的技术来源于真实后端开发场景。无论是标准库工具还是工程实践，在日常服务开发中都会反复用到。

Q: Go 版本会影响示例代码吗？
A: 本文代码主要针对 Go 1.20+ 编写。较新版本（如 1.22、1.23）的语法可能有微调，但核心概念保持不变。如有版本差异，文中会特别说明。

Q: 学习 Go 应该先学标准库还是直接上框架？
A: 强烈建议先学标准库。框架是对标准库的封装和扩展。只有理解了标准库的能力边界，才能正确选择和使用框架，也才能在框架出问题时快速定位。

Q: 代码里的错误处理为什么都是显式的 if err != nil？
A: 这是 Go 的设计哲学。显式错误处理让失败路径清晰可见，不会隐藏在任何 try-catch 之后。习惯了之后，你会发现这种写法实际上降低了排查错误的难度。

Q: 并发相关代码怎么测试？
A: 使用 Go 内置的 -race 标志检测数据竞争：go test -race ./...。结合 sync.WaitGroup 和 context.WithTimeout 编写有退出路径的并发测试，避免 goroutine 泄漏。

常见坑与避坑指南

  1. 不要信任用户输入：无论表单、JSON、Cookie 还是 HTTP Header，都当作不可信数据处理，做校验和转义。
  2. 资源要释放：文件、数据库连接、HTTP 响应体都要及时关闭。defer 是一个好习惯。
  3. 不要忽略错误：即使 defer file.Close() 可能返回错误，至少记录日志。完全忽略错误是 bug 的温床。
  4. 不要滥用 goroutine：每个 goroutine 都要有明确的退出路径。使用 sync.WaitGroup 和 context 管理生命周期。
  5. 不要硬编码配置：端口、路径、超时时间、密钥都应该从配置读取，让程序适应不同环境。
  6. 不要过早优化：先让代码正确和可读，再用 benchmark 和 profile 找到真正的热点。

延伸阅读与实践建议

读完本文后，建议完成以下实践：

  1. 把文中所有示例代码在自己的机器上跑一遍
  2. 给示例代码补充错误分支的测试用例
  3. 尝试基于本文内容构建一个小型完整项目
  4. 在 review 他人的 Go 代码时，检查本文提到的边界是否被覆盖
  5. 订阅 Go 官方博客，关注语言演进和最佳实践更新

参考资源

  • Go 官方网站：https://go.dev/
  • Go 标准库文档：https://pkg.go.dev/std
  • Go by Example：https://gobyexample.com/
  • Effective Go：https://go.dev/doc/effective_go
  • Go 常见问题：https://go.dev/doc/faq
  • Go 项目实战社区案例和开源项目源码

本文力求在讲解技术细节的同时兼顾工程实用性。Go 语言的设计简洁但不简单，掌握它需要持续的实践和反思。希望这篇文章能成为你学习道路上的一个可靠参考。

真实项目应用场景

在企业级后端开发中，本技术点通常出现在以下场景：

场景一：服务初始化

在生产环境的服务启动过程中，正确初始化配置、日志、数据库连接和健康检查端点是基本要求。任何一个环节的疏忽都可能导致发布失败或线上故障。

场景二：请求处理链

每个 HTTP 请求都会经历认证、限流、日志记录、业务处理、响应构造等多个阶段。理解每个阶段的职责边界，能帮助你在出现问题时快速定位。

场景三：数据持久化

无论是关系型数据库还是缓存存储，数据的读写一致性、连接池管理和错误处理都需要精心设计。测试替身（stub/mock）是确保数据访问层可测的关键。

场景四：异步任务处理

后台任务如数据同步、报表生成、邮件发送等通常采用异步方式处理。worker 池、任务队列和重试机制是不可或缺的组成部分。

场景五：可观测性建设

日志、指标和追踪是系统的"体检报告"。结构化日志便于检索，关键指标帮助发现趋势，分布式追踪定位跨服务问题。

性能考量

在代码层面，有几个通用的性能原则：

  1. 减少不必要的分配：频繁的小对象分配会增加 GC 压力。使用 sync.Pool 复用缓冲区，预分配切片容量。
  2. 避免反射：反射带来的性能开销在热路径上不可忽视。尽量在编译期确定类型。
  3. 批量操作优于逐条操作：数据库批量插入、Redis pipeline、HTTP 批量请求都能显著减少网络往返。
  4. 懒加载：不是每个请求都需要加载全部数据。按需加载，配合缓存减少重复计算。
  5. 合理超时：网络请求一定要设超时。没有超时的外部调用是隐形炸弹。

安全红线

  • 永远不要信任用户输入，做严格的输入校验和输出转义
  • 敏感信息（密码、密钥、Token）不要硬编码，不要进入日志
  • SQL 查询使用参数化查询，禁止字符串拼接
  • 使用 crypto/rand 生成安全随机数，不要用 math/rand
  • Cookie 设置 HttpOnly、Secure 和合适的 SameSite
  • 生产环境关闭调试接口和详细错误堆栈回显

团队协作约定

统一的代码风格和工程约定能大幅降低维护成本：

  • 包名：简短、有意义，避免 utils、common、helper
  • 接口：由使用方定义，保持小而精
  • 错误：底层包装上下文，上层边界统一记录，不重复打印
  • 测试：核心逻辑必须有测试覆盖，表驱动 + 子测试是推荐方式
  • 文档：公共 API 和关键设计要有注释，复杂业务逻辑要说明为什么
  • 提交信息：说明做了什么和为什么，便于后续回溯

调试技巧

当程序行为不符合预期时：

  1. 先确认输入数据是什么，不是你以为的什么
  2. 用 go test -race 检查是否存在数据竞争
  3. 用 go tool pprof 分析 CPU 和内存热点
  4. 增加结构化日志，打印关键路径的输入输出
  5. 在本地用最小复现案例定位问题，不要在线上试错
  6. 检查环境差异：Go 版本、操作系统、时区、环境变量

持续学习路径

掌握基础后，可以继续深入以下方向：

  • Go 运行时：调度器（GMP 模型）、GC 算法、内存分配
  • 网络编程：TCP/UDP、QUIC、gRPC、WebSocket
  • 系统编程：Linux syscall、BPF、eBPF
  • 云原生：Kubernetes operator、服务网格、可观测性
  • 编译原理：Go 编译器、SSA、逃逸分析

总结

Go 语言的魅力在于简洁与务实之间的平衡。它没有花哨的语法糖，但每一行代码都在为工程可靠性服务。标准库涵盖了大多数日常需求，让你可以用少量依赖构建稳定的系统。

本文介绍的技术点虽然聚焦在入门的某一方面，但它们共同构成了一张可靠后端服务的安全网：从输入校验到错误处理，从资源管理到并发控制，从测试覆盖到可观测性。这些基本功练扎实了，后面学习框架、微服务和云原生都会事半功倍。

希望这篇教程能帮助你写出更清晰、更可靠、更容易维护的 Go 代码。

本文内容力求准确，但技术细节可能随 Go 版本更新而变化。建议以官方文档为准，并在实际项目中验证所有代码示例。

继续阅读

探索更多技术文章

浏览归档，发现更多关于系统设计、工具链和工程实践的内容。

全部文章 返回首页

「golang」更多文章

  1. 熔断、降级与限流：Go 微服务韧性设计完全指南
  2. 事件溯源与 CQRS 在 Go 中的实践：复杂业务系统的架构升级
  3. TinyGo 嵌入式开发与物联网实战：微控制器编程完全指南