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.

referencesWEB服务开发SessionSession-Storage接口开发.md

≈875 tokens on demand. Your agent reads this file only when SKILL.md points to it.

大部分场景下,通过 gsession 组件内置提供的常见 Storage 实现已经能够满足需求。如果有特殊的场景需要制定不易开发 Storage 当然也是支持的,因为 gsession 的功能都采用了接口化设计。

Storage定义

https://github.com/gogf/gf/blob/master/os/gsession/gsession_storage.go

// Storage is the interface definition for session storage.
type Storage interface {
    // New creates a custom session id.
    // This function can be used for custom session creation.
    New(ctx context.Context, ttl time.Duration) (id string, err error)

    // Get retrieves and returns session value with given key.
    // It returns nil if the key does not exist in the session.
    Get(ctx context.Context, id string, key string) (value interface{}, err error)

    // GetMap retrieves all key-value pairs as map from storage.
    GetMap(ctx context.Context, id string) (data map[string]interface{}, err error)

    // GetSize retrieves and returns the size of key-value pairs from storage.
    GetSize(ctx context.Context, id string) (size int, err error)

    // Set sets one key-value session pair to the storage.
    // The parameter `ttl` specifies the TTL for the session id.
    Set(ctx context.Context, id string, key string, value interface{}, ttl time.Duration) error

    // SetMap batch sets key-value session pairs as map to the storage.
    // The parameter `ttl` specifies the TTL for the session id.
    SetMap(ctx context.Context, id string, data map[string]interface{}, ttl time.Duration) error

    // Remove deletes key with its value from storage.
    Remove(ctx context.Context, id string, key string) error

    // RemoveAll deletes all key-value pairs from storage.
    RemoveAll(ctx context.Context, id string) error

    // GetSession returns the session data as `*gmap.StrAnyMap` for given session id from storage.
    //
    // The parameter `ttl` specifies the TTL for this session.
    // The parameter `data` is the current old session data stored in memory,
    // and for some storage it might be nil if memory storage is disabled.
    //
    // This function is called ever when session starts. It returns nil if the TTL is exceeded.
    GetSession(ctx context.Context, id string, ttl time.Duration, data *gmap.StrAnyMap) (*gmap.StrAnyMap, error)

    // SetSession updates the data for specified session id.
    // This function is called ever after session, which is changed dirty, is closed.
    // This copy all session data map from memory to storage.
    SetSession(ctx context.Context, id string, data *gmap.StrAnyMap, ttl time.Duration) error

    // UpdateTTL updates the TTL for specified session id.
    // This function is called ever after session, which is not dirty, is closed.
    UpdateTTL(ctx context.Context, id string, ttl time.Duration) error
}

每一个方法的调用时机都在注释中详细介绍了,开发者在实现自定义的 Storage 时,可以充分参考内置的几种 Storage 实现。

注意事项

  • Storage 接口中,并不是所有的接口方法都需要实现,开发者仅需要根据业务需要,实现特定调用时机的一些接口即可。
  • 为了提高 Session 的执行性能,接口有 gmap.StrAnyMap 容器类型的使用,开发时可以参考一下章节: 字典类型-gmap

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.