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核心组件数据校验数据校验-可选校验.md

可选校验规则

当给定的数据校验规则中不包含required*规则时,表示该规则不是一个必须规则。如果当给定的值为nil或者空字符串时,将会忽略其校验。

示例1,空字符串

package main

import (
    "fmt"
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/os/gctx"
)

func main() {
    type Params struct {
        Page      int    `v:"required|min:1         # page is required"`
        Size      int    `v:"required|between:1,100 # size is required"`
        ProjectId string `v:"between:1,10000        # project id must between {min}, {max}"`
    }
    var (
        ctx = gctx.New()
        obj = &Params{
            Page: 1,
            Size: 10,
        }
    )

    err := g.Validator().Data(obj).Run(ctx)
    fmt.Println(err)

    // Output:
    // <nil>
}

示例2,空指针属性

package main

import (
    "fmt"
    "github.com/gogf/gf/v2/container/gvar"
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/os/gctx"
)

func main() {
    type Params struct {
        Page      int       `v:"required|min:1         # page is required"`
        Size      int       `v:"required|between:1,100 # size is required"`
        ProjectId *gvar.Var `v:"between:1,10000        # project id must between {min}, {max}"`
    }
    var (
        ctx = gctx.New()
        obj = &Params{
            Page: 1,
            Size: 10,
        }
    )
    err := g.Validator().Data(obj).Run(ctx)
    fmt.Println(err)

    // Output:
    // <nil>
}

示例3,空整型属性

需要注意的是,如果键值为 0 或者 false,参数值将仍然会被校验。

package main

import (
    "fmt"
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/os/gctx"
)

func main() {
    type Params struct {
        Page      int `v:"required|min:1         # page is required"`
        Size      int `v:"required|between:1,100 # size is required"`
        ProjectId int `v:"between:1,10000        # project id must between {min}, {max}"`
    }
    var (
        ctx = gctx.New()
        obj = &Params{
            Page: 1,
            Size: 10,
        }
    )
    err := g.Validator().Data(obj).Run(ctx)
    fmt.Println(err)

    // Output:
    // <nil>
}

执行后,终端输出:

project id must between 1, 10000

示例4,通过 map 传参

package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/os/gctx"
)

func main() {
    var (
        ctx    = gctx.New()
        params = map[string]interface{}{
            "passport":  "",
            "password":  "123456",
            "password2": "1234567",
        }
        rules = []string{
            "passport@length:6,16",
            "password@required|length:6,16|same:password2",
            "password2@required|length:6,16",
        }
    )
    err := g.Validator().Rules(rules).Data(params).Run(ctx)
    if err != nil {
        g.Dump(err.Maps())
    }
}

需要注意,其中的 passport 键名并没有 required 规则,因此即便给定的 passport 参数为空字符串,不满足规则时,也并没有报错,因为校验组件将其看做可选校验规则。

执行后,终端输出:

{
    "password": {
        "same": "The password value `123456` must be the same as field password2",
    },
}

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.