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组件列表系统相关环境变量-genv.md

环境变量管理组件。

使用方式:

import "github.com/gogf/gf/v2/os/genv"

接口文档:

https://pkg.go.dev/github.com/gogf/gf/v2/os/genv

SetMap

func SetMap(m map[string]string) error

该方法用于批量设置环境变量。使用示例:

genv.SetMap(g.MapStrStr{
    "APPID":     "order",
    "THREAD":    "16",
    "ENDPOINTS": "127.0.0.1:6379",
})

GetWithCmd

func GetWithCmd(key string, def ...interface{}) *gvar.Var

该方法用于获取环境变量中指定的选项数值,如果该环境变量不存在时,则从命令行选项中读取。但是两者的名称规则会不一样。例如: genv.GetWithCmd("gf.debug") 将会优先去读取 GF_DEBUG 环境变量的值,当不存在时则去命令行中的 gf.debug 选项。

需要注意的是参数命名转换规则:

  • 环境变量会将名称转换为大写,名称中的 . 字符转换为 _ 字符。
  • 命令行中会将名称转换为小写,名称中的 _ 字符转换为 . 字符。

All

func All() []string

该方法表示返回环境变量中的字符串,并且以` key=value `的形式返回。

Map

func Map() map[string]string

该方法表示返回环境变量中的字符串,并且以` map `的形式返回。

Get

func Get(key string, def ...interface{}) *gvar.Var

该方法用于创建返回一个泛型类型的环境变量,如果给定的 key 不存在则返回一个默认的泛型类型的环境变量。

Set

func Set(key, value string) error

该方法是通过存放 key 和 value 的环境变量,如果有报错则返回一个 Error 类型。

SetMap

func SetMap(m map[string]string) error

该方法通过 map 类型的参数存放环境变量。

Contains

func Contains(key string) bool

该方法通过检查环境变量中是否存在 key。

Remove

func Remove(key ...string) error

该方法可以删除一个或者多个环境变量。

Build

func Build(m map[string]string) []string

该方法将 map 的参数以数组的形式构建并且返回。

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.