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

校验组件支持强大的递归校验(嵌套校验)特性。如果给定的校验数据中的属性或者键值为struct/map/slice类型时,将会被自动执行递归校验。我们来看几个示例:

示例1,递归校验:struct

package main

import (
    "fmt"

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

type SearchReq struct {
    Key    string `v:"required"`
    Option SearchOption
}

type SearchOption struct {
    Page int `v:"min:1"`
    Size int `v:"max:100"`
}

func main() {
    var (
        ctx = gctx.New()
        req = SearchReq{
            Key: "GoFrame",
            Option: SearchOption{
                Page: 1,
                Size: 10000,
            },
        }
    )
    err := g.Validator().Data(req).Run(ctx)
    fmt.Println(err)
}

执行后,终端输出:

The Size value `10000` must be equal or lesser than 100

示例2,递归校验:slice

package main

import (
    "fmt"

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

func main() {
    type Student struct {
        Name string `v:"required#Student Name is required"`
        Age  int
    }
    type Teacher struct {
        Name     string
        Students []Student
    }
    var (
        ctx     = gctx.New()
        teacher = Teacher{}
        data    = g.Map{
            "name":     "john",
            "students": `[{"age":2},{"name":"jack", "age":4}]`,
        }
    )
    err := g.Validator().Assoc(data).Data(teacher).Run(ctx)
    fmt.Println(err)
}

执行后,终端输出:

Student Name is required

示例3,递归校验:map

package main

import (
    "fmt"

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

func main() {
    type Student struct {
        Name string `v:"required#Student Name is required"`
        Age  int
    }
    type Teacher struct {
        Name     string
        Students map[string]Student
    }
    var (
        ctx     = gctx.New()
        teacher = Teacher{
            Name: "Smith",
            Students: map[string]Student{
                "john": {Name: "", Age: 18},
            },
        }
    )
    err := g.Validator().Data(teacher).Run(ctx)
    fmt.Println(err)
}

执行后,终端输出:

Student Name is required

注意事项:空对象对递归校验的影响

package main

import (
    "fmt"

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

func main() {
    type Student struct {
        Name string `v:"required"`
    }
    type Teacher struct {
        Students Student
    }
    var (
        ctx     = gctx.New()
        teacher = Teacher{}
        data    = g.Map{
            "students": nil,
        }
    )
    err := g.Validator().Assoc(data).Data(teacher).Run(ctx)
    fmt.Println(err)
}

执行后,终端输出:

Student Name is required

有同学可能会觉得奇怪,明明我都没有传递Student字段值,为什么还会递归校验Student结构体里面的Name字段?这是因为这里的Student属性是个空结构体,是带有默认值的(Name默认值为空字符串)。递归校验里面,虽然Student不是必须参数,这个意思是你可以不传递,但是只要传递了就会按照里面属性的校验规则执行校验(带有默认值的空对象也算是有值)。可以对比和以下代码的差别:

package main

import (
    "fmt"

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

func main() {
    type Student struct {
        Name string `v:"required"`
    }
    type Teacher struct {
        Students *Student
    }
    var (
        ctx     = gctx.New()
        teacher = Teacher{}
        data    = g.Map{
            "students": nil,
        }
    )
    err := g.Validator().Assoc(data).Data(teacher).Run(ctx)
    fmt.Println(err)
}

和前一示例的唯一差异在于Student属性从结构体改为了结构体指针*Student,这样该属性不是空对象便没有默认值了。执行后,终端输出为空,表示校验通过。

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.