All skills
gogf avatar

/goframe-v2

@911705d
by GoFramegogf/skills81 stars
3

GoFrame v2 development skill. Use only when the target Go project uses or is explicitly adopting GoFrame v2: the nearest go.mod requires github.com/gogf/gf/v2, existing Go files import github.com/gogf/gf/v2 or any github.com/gogf/gf/v2/... component package, or the user asks to scaffold, migrate, or build with GoFrame. Trigger for GoFrame-backed Go work such as APIs/controllers/services, middleware, routing/config, ORM/DAO/DO/entity/database operations, gf CLI/codegen, HTTP/gRPC services, and microservice conventions. Do not trigger for generic Go projects without GoFrame evidence, frontend-only work, shell scripts, or unrelated infrastructure tasks.

Use this Skill: https://skilld.dev/gh/gogf/skills/goframe-v2

This session only. Nothing lands on disk.

references组件列表数据结构对象复用-gpool对象复用-gpool.md

基本介绍

对象复用池(并发安全)。将对象进行缓存复用,支持 过期时间、 创建方法 及 销毁方法 定义。

使用场景:

任何需要支持定时过期的对象复用场景。

使用方式:

import "github.com/gogf/gf/v2/container/gpool"

接口文档:

https://pkg.go.dev/github.com/gogf/gf/v2/container/gpool

需要注意几点:

  1. New 方法的过期时间类型为 time.Duration。
  2. 对象 创建方法( newFunc NewFunc)返回值包含一个 error 返回,当对象创建失败时可由该返回值反馈原因。
  3. 对象 销毁方法( expireFunc...ExpireFunc)为可选参数,用以当对象超时/池关闭时,自动调用自定义的方法销毁对象。

泛型支持

:::tip 版本要求:v2.10.0 :::

从 v2.10.0 版本开始,gpool 提供了泛型类型 TPool[T],提供类型安全的对象池操作。

基本使用

使用 NewTPool[T] 创建泛型对象池:

type MyObject struct {
    ID   int
    Name string
}

// 创建对象池,设置 3 秒过期时间
pool := gpool.NewTPool[*MyObject](
    3*time.Second,
    func() (*MyObject, error) {
        // 对象创建方法
        return &MyObject{ID: 1, Name: "example"}, nil
    },
    func(obj *MyObject) {
        // 对象销毁方法(可选)
        fmt.Printf("Destroying object: %+v\n", obj)
    },
)
defer pool.Close()

// 从池中获取对象
obj, err := pool.Get()
if err != nil {
    panic(err)
}
fmt.Printf("Got object: %+v\n", obj)

// 使用完对象后放回池中
pool.MustPut(obj)

类型安全的优势

泛型版本提供编译时类型检查,避免了类型断言:

// 传统方式(需要类型断言)
pool := gpool.New(3*time.Second, func() (interface{}, error) {
    return &MyObject{}, nil
})
obj, _ := pool.Get()
myObj := obj.(*MyObject) // 需要类型断言

// 泛型方式(类型安全)
pool := gpool.NewTPool[*MyObject](3*time.Second, func() (*MyObject, error) {
    return &MyObject{}, nil
})
obj, _ := pool.Get() // obj 直接是 *MyObject 类型,无需断言

gpool 与 sync.Pool

gpool 与 sync.Pool 都可以达到对象复用的作用,但是两者的设计初衷和使用场景不太一样。

sync.Pool 的对象生命周期不支持自定义过期时间,究其原因, sync.Pool 并不是一个 Cache; sync.Pool 设计初衷是为了缓解GC 压力, sync.Pool 中的对象会在 GC 开始前全部清除;并且 sync.Pool 不支持对象创建方法及销毁方法。

相关文档

Source: SKILL.md on GitHub

1 alert16d5 checks · Risk MEDIUM
  • Gen Agent Trust Hub16d

    The skill provides a comprehensive development guide and code examples for the GoFrame v2 framework. While highly informative for Go developers, it contains several examples with hardcoded placeholder secrets, tokens, and specific local file paths to sensitive configuration files (like Kubernetes credentials). These elements are provided for demonstration purposes but represent insecure practices if used in production without modification.

  • Socket16d

    5 alerts: gptSecurity, gptAnomaly

  • Snyk16d

    Risk: LOW · No issues

  • Runlayer6mo

    227/949 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at 911705d. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 months ago.

Steadyupdated 4 months ago
  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

Provides instruction and conventions for developing with GoFrame v2, a modular Go framework for building HTTP and gRPC services, microservices, and database operations using its ORM, CLI tooling, and project scaffolding. Use this skill when the target project has GoFrame v2 as a dependency or when the user requests scaffolding, migrations, or service development with GoFrame conventions.

Generated from the current SKILL.md.

When should I use this skill?
Use this skill only when your Go project uses GoFrame v2, indicated by github.com/gogf/gf/v2 in go.mod or imports. Do not use for generic Go projects, frontend work, or infrastructure tasks unrelated to GoFrame.
Should I manually set created_at and updated_at fields?
No. GoFrame automatically writes created_at on insert and updated_at on insert/update/save. Manually setting these fields is redundant and violates project conventions.
What should I use for database operations instead of g.Map?
Always use DO objects from internal/model/do/. DO struct fields are interface{}, unset fields remain nil and are automatically ignored by the ORM.
How does soft delete work in GoFrame?
Call Delete() on the DAO; GoFrame automatically converts it to UPDATE SET deleted_at = NOW(). Queries automatically filter out soft-deleted rows without requiring manual WhereNull conditions.
Where should I implement business logic?
Implement business logic directly in the service/ directory. Do not use the logic/ directory unless explicitly requested.

Generated from the current SKILL.md. These answers refresh after source changes.