Agent Skillssamber/cc-skills-golang › golang-context

golang-context

GitHub

提供 Go 语言 context.Context 的最佳实践指南,涵盖上下文传播、取消机制、超时处理及值存储规范,旨在帮助开发者避免资源泄漏并设计健壮的 API 边界。

skills/golang-context/SKILL.md samber/cc-skills-golang

Trigger Scenarios

Go 代码中 context 使用不当 需要调试上下文泄漏或超时问题 设计跨层级的上下文传播逻辑

Install

npx skills add samber/cc-skills-golang --skill golang-context -g -y
More Options

Use without installing

npx skills use samber/cc-skills-golang@golang-context

指定 Agent (Claude Code)

npx skills add samber/cc-skills-golang --skill golang-context -a claude-code -g -y

安装 repo 全部 skill

npx skills add samber/cc-skills-golang --all -g -y

预览 repo 内 skill

npx skills add samber/cc-skills-golang --list

SKILL.md

Frontmatter
{
    "name": "golang-context",
    "paths": [
        "**\/*.go"
    ],
    "license": "MIT",
    "metadata": {
        "author": "samber",
        "version": "1.3.1",
        "openclaw": {
            "emoji": "🔗",
            "install": [],
            "homepage": "https:\/\/github.com\/samber\/cc-skills-golang",
            "requires": {
                "bins": [
                    "go"
                ]
            }
        }
    },
    "description": "Idiomatic context.Context usage in Golang — propagation through API boundaries, cancellation, timeouts and deadlines, request-scoped values, context.WithoutCancel for background work outliving requests. Apply when designing context propagation across layers, debugging leaked or unexpired contexts, choosing between context.Background\/TODO\/WithoutCancel, or storing values in context. Not for code that merely accepts ctx as first parameter.",
    "allowed-tools": "Read Edit Write Glob Grep Bash(go:*) Bash(golangci-lint:*) Bash(git:*) Agent",
    "compatibility": "Designed for Claude Code, Codex or similar harness, and for projects using Golang.",
    "user-invocable": true
}

Community default. A company skill that explicitly supersedes samber/cc-skills-golang@golang-context skill takes precedence.

Go context.Context Best Practices

context.Context is Go's mechanism for propagating cancellation signals, deadlines, and request-scoped values across API boundaries and between goroutines. Think of it as the "session" of a request — it ties together every operation that belongs to the same unit of work.

Best Practices Summary

  1. Propagate the same context through the entire request lifecycle: HTTP handler → service → DB → external APIs — any link that starts a fresh context keeps working after the client is gone.
  2. Take ctx as the first parameter, named ctx context.Context — the fixed position is what makes context-aware APIs recognizable at a glance and what linters check.
  3. Pass context through function parameters instead of storing it in a struct — the struct outlives the request that filled it, so later calls reuse a context that is already cancelled or belongs to someone else.
  4. Pass context.TODO() rather than a nil context — nil panics on the first Done() or Value() call, far from the caller that passed it.
  5. Call cancel() on all control-flow paths for WithCancel/WithTimeout/WithDeadline, unless ownership of the context and cancel function is explicitly returned or transferred — an uncalled cancel() keeps the child attached to its parent and leaks its timer until the parent finishes.
  6. Create context.Background() only at top-level entry points (main, init, tests). Deeper in the call chain — especially mid-request — it detaches the work from the caller's deadline and cancellation, the propagation break shown below.
  7. Use context.TODO() as a placeholder when a context is needed but none exists yet — it marks the gap for a later fix instead of hiding it behind a Background() that looks deliberate.
  8. Declare context value keys as unexported types — with a plain string key, two packages using "user" silently overwrite each other.
  9. Carry only request-scoped metadata in context values, never function parameters — values retrieved through Value() lose compile-time typing and disappear from the function signature.
  10. Use context.WithoutCancel (Go 1.21+) when spawning background work that must outlive the parent request — otherwise the handler returning cancels the audit log or cleanup just started.

Creating Contexts

Situation Use
Entry point (main, init, test) context.Background()
Function needs context but caller doesn't provide one yet context.TODO()
Inside an HTTP handler r.Context()
Need cancellation control context.WithCancel(parentCtx)
Need a deadline/timeout context.WithTimeout(parentCtx, duration)

Context Propagation: The Core Principle

The most important rule: propagate the same context through the entire call chain. When you propagate correctly, cancelling the parent context cancels all downstream work automatically.

// ✗ Bad — creates a new context, breaking the chain
func (s *OrderService) Create(ctx context.Context, order Order) error {
    return s.db.ExecContext(context.Background(), "INSERT INTO orders ...", order.ID)
}

// ✓ Good — propagates the caller's context
func (s *OrderService) Create(ctx context.Context, order Order) error {
    return s.db.ExecContext(ctx, "INSERT INTO orders ...", order.ID)
}

Deep Dives

  • Cancellation, Timeouts & Deadlines — How cancellation propagates: WithCancel for manual cancellation, WithTimeout for automatic cancellation after a duration, WithDeadline for absolute time deadlines. Patterns for listening (<-ctx.Done()) in concurrent code, AfterFunc callbacks, and WithoutCancel for operations that must outlive their parent request (e.g., audit logs).

  • Context Values & Cross-Service Tracing — Safe context value patterns: unexported key types to prevent namespace collisions, when to use context values (request ID, user ID) vs function parameters. Trace context propagation: OpenTelemetry trace headers, correlation IDs for log aggregation, and marshaling/unmarshaling context across service boundaries.

  • Context in HTTP Servers & Service Calls — HTTP handler context: r.Context() for request-scoped cancellation, middleware integration, and propagating to services. HTTP client patterns: NewRequestWithContext, client timeouts, and retries with context awareness. Database operations: always use *Context variants (QueryContext, ExecContext) to respect deadlines.

Cross-References

  • → See the samber/cc-skills-golang@golang-concurrency skill for goroutine cancellation patterns using context
  • → See the samber/cc-skills-golang@golang-database skill for context-aware database operations (QueryContext, ExecContext)
  • → See the samber/cc-skills-golang@golang-observability skill for trace context propagation with OpenTelemetry
  • → See the samber/cc-skills-golang@golang-design-patterns skill for timeout and resilience patterns

Enforce with Linters

Many context pitfalls are caught automatically by linters: govet, staticcheck. → See the samber/cc-skills-golang@golang-lint skill for configuration and usage.

Version History

  • bac46b0 Current 2026-09-03 09:50

    文档格式规范化更新:收紧描述指南,修复重叠问题,新增正文写作风格规范(如祈使句、术语一致性),并针对16个违规技能进行回溯修复。

  • 147c067 2026-08-28 11:52

    无内容变更,仅进行版本升级和工具链兼容性重构。

  • 709b181 2026-07-25 07:35

Same Skill Collection

skills/golang-code-style/SKILL.md
skills/golang-database/SKILL.md
skills/golang-documentation/SKILL.md
skills/golang-graphql/SKILL.md
skills/golang-grpc/SKILL.md
skills/golang-modernize/SKILL.md
skills/golang-samber-do/SKILL.md
skills/golang-samber-hot/SKILL.md
skills/golang-samber-oops/SKILL.md
skills/golang-samber-slog/SKILL.md
skills/golang-stretchr-testify/SKILL.md
skills/golang-uber-dig/SKILL.md
skills/golang-uber-fx/SKILL.md
skills/golang-benchmark/SKILL.md
skills/golang-cli/SKILL.md
skills/golang-concurrency/SKILL.md
skills/golang-data-structures/SKILL.md
skills/golang-dependency-injection/SKILL.md
skills/golang-dependency-management/SKILL.md
skills/golang-design-patterns/SKILL.md
skills/golang-error-handling/SKILL.md
skills/golang-google-wire/SKILL.md
skills/golang-gopls/SKILL.md
skills/golang-how-to/SKILL.md
skills/golang-lint/SKILL.md
skills/golang-naming/SKILL.md
skills/golang-observability/SKILL.md
skills/golang-performance/SKILL.md
skills/golang-pkg-go-dev/SKILL.md
skills/golang-popular-libraries/SKILL.md
skills/golang-project-layout/SKILL.md
skills/golang-refactoring/SKILL.md
skills/golang-safety/SKILL.md
skills/golang-samber-lo/SKILL.md
skills/golang-samber-mo/SKILL.md
skills/golang-samber-ro/SKILL.md
skills/golang-security/SKILL.md
skills/golang-spf13-cobra/SKILL.md
skills/golang-spf13-viper/SKILL.md
skills/golang-stay-updated/SKILL.md
skills/golang-structs-interfaces/SKILL.md
skills/golang-swagger/SKILL.md
skills/golang-testing/SKILL.md
skills/golang-troubleshooting/SKILL.md
skills/golang-continuous-integration/SKILL.md

Metadata

Files
0
Version
19a0626
Hash
257a3e5a
Indexed
2026-07-25 07:35

- 위키
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-09-16 20:02
浙ICP备14020137号-1