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核心组件数据库ORMORM接口开发ORM接口开发.md

gdb 模块使用了非常灵活且扩展性强的接口设计,接口设计允许开发者可以非常方便地自定义实现和替换接口定义中的任何方法。

DB 接口

接口文档: https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb#DB

DB 接口是数据库操作的核心接口,也是我们通过 ORM 操作数据库时最常用的接口,这里主要对接口的几个重要方法做说明:

  1. Open 方法用于创建特定的数据库连接对象,返回的是标准库的 *sql.DB 通用数据库对象。
  2. Do* 系列方法的第一个参数 link 为 Link 接口对象,该对象在 master-slave 模式下可能是一个主节点对象,也可能是从节点对象,因此如果在继承的驱动对象实现中使用该 link 参数时,注意当前的运行模式。 slave 节点在大部分的数据库主从模式中往往是不可写的。
  3. HandleSqlBeforeCommit 方法将会在每一条 SQL 提交给数据库服务端执行时被调用做一些提交前的回调处理。
  4. 其他接口方法详见接口文档或者源码文件。

DB 接口关系

GoFrame ORM Relations

Driver 接口

接口文档: https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb#Driver

开发者自定义的驱动需要实现以下接口:

// Driver is the interface for integrating sql drivers into package gdb.
type Driver interface {
    // New creates and returns a database object for specified database server.
    New(core *Core, node *ConfigNode) (DB, error)
}

其中的 New 方法用于根据 Core 数据库基础对象以及 ConfigNode 配置对象创建驱动对应的数据库操作对象,需要注意的是,返回的数据库对象需要实现 DB 接口。而数据库基础对象 Core 已经实现了 DB 接口,因此开发者只需要”继承” Core 对象,然后根据需要覆盖对应的接口实现方法即可。

相关文档

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.