skilld
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.

Ask your Agent

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

This session only. Nothing lands on disk.

references核心组件资源管理资源管理-最佳实践.md

资源管理设计的目标之一是在开发阶段不影响静态文件的开发管理，只有在发布的时候执行打包即可，打包完毕后清理临时文件，因此只会影响生成的二进制可执行文件，对开发者来说无感知且使用便捷。

准备工程

建议大家使用 GoFrame 官方提供的工程化目录结构，并且使用 CLI 工具来创建自己的项目工程，因为整个框架工程化思想以及一些示例都是基于标准化的工程目录结构，这样更有利于大家学习和使用整个开发框架，提高开发效率。特别是，在工程目录中存在一个 packed 目录，用以存放资源管理组件的相关打包内容，在默认情况下，里面是一个空的 go 文件，什么都不会做。

开发阶段

在开发阶段，一般来说，开发者并不需要关心资源管理的事情，该怎么撸码就怎么撸，静态的文件按照建议放到 resource 目录下。在开发阶段的静态文件访问都会直接通过文件系统访问。

准备发布

当开发完毕后，想要将静态文件、模板文件、配置文件打包到二进制可执行文件中，随着二进制可执行文件发布。好的，这个时候资源组件开始介入展示能力了。您需要配置到交叉编译的配置，具体请参考命令行相关章节 交叉编译-build 。我们需要使用到CLI工具来执行可执行文件编译，将您的编译配置通过配置文件管理起来（放到hack/config.yaml文件中），一个参考的编译配置如下：

gfcli:
  build:
    name:      "my-app"
    arch:      "amd64"
    system:    "linux"
    mod:       "none"
    cgo:       0
    packSrc:   "manifest/config,manifest/i18n,resource/public,resource/template"
    version:   ""
    output:    "./bin"
    extra:     ""

请注意其中的 pack 配置，表示我们在执行编译的时候自动打包到二进制可执行文件中的目录。随后，我们在项目根目录下执行编译命令：

gf build

该命令在编译时会自动将配置文件中指定的目录进行打包成临时的打包 go 文件，再执行编译，编译完毕后自动清理临时的打包 go 文件。 :::tip 大部分场景下，配置文件可能不需要打包进二进制可执行文件，具体根据您的业务场景自行选择。 :::

发布运行

将二进制执行发布执行即可。

Source: SKILL.md on GitHub

Third-party checks

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

Provenance

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

Topics

  • Go
  • Database
  • goframe
  • orm
  • http
  • grpc
  • microservices
  • crud
  • scaffolding
  • middleware

README badge

README badge for gogf/skills

What it does

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.

Frequently asked

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.