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

gview模板引擎支持两种layout模板布局方式:

  1. define + template方式
  2. include模板嵌入方式

这两种方式均支持对模板变量的传入。

define + template

由于gview底层采用了ParseFiles方式批量解析模板文件,因此可以使用define标签定义模板内容块,通过template标签在其他任意的模板文件中引入指定的模板内容块。template标签支持跨模板引用,也就是说define标签定义的模板内容块可能是在其他模板文件中,template也可以随意引入。 :::warning 注意:

  • 为嵌套的子模板传递模板变量时,应当使用: {{template "xxx" .}} 的语法。
  • 模板文件的后缀名,要跟 define template 文件的后缀名保持一致。 ::: 使用示例:
  1. layout.html
<!DOCTYPE html>
<html>
<head>
    <title>GoFrame Layout</title>
    {{template "header" .}}
</head>
<body>
    <div class="container">
    {{template "container" .}}
    </div>
    <div class="footer">
    {{template "footer" .}}
    </div>
</body>
</html>
  1. header.html
{{define "header"}}
    <h1>{{.header}}</h1>
{{end}}
  1. container.html
{{define "container"}}
<h1>{{.container}}</h1>
{{end}}
  1. footer.html
{{define "footer"}}
<h1>{{.footer}}</h1>
{{end}}
  1. main.go
package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
)

func main() {
    s := g.Server()
    s.BindHandler("/", func(r *ghttp.Request) {
        r.Response.WriteTpl("layout.html", g.Map{
            "header":    "This is header",
            "container": "This is container",
            "footer":    "This is footer",
        })
    })
    s.SetPort(8199)
    s.Run()
}

执行后,访问 http://127.0.0.1:8199 结果如下:

include模板嵌入

当然我们也可以使用include标签来实现页面布局。 :::warning 注意,为嵌套的子模板传递模板变量时,应当使用: {{include "xxx" .}} 的语法。 ::: 使用示例:

  1. layout.html
{{include "header.html" .}}
{{include .mainTpl .}}
{{include "footer.html" .}}
  1. header.html
<h1>HEADER</h1>
  1. footer.html
<h1>FOOTER</h1>
  1. main1.html
<h1>MAIN1</h1>
  1. main2.html
<h1>MAIN2</h1>
  1. main.go
package main

import (
    "github.com/gogf/gf/v2/frame/g"
    "github.com/gogf/gf/v2/net/ghttp"
)

func main() {
    s := g.Server()
    s.BindHandler("/main1", func(r *ghttp.Request) {
        r.Response.WriteTpl("layout.html", g.Map{
            "mainTpl": "main/main1.html",
        })
    })
    s.BindHandler("/main2", func(r *ghttp.Request) {
        r.Response.WriteTpl("layout.html", g.Map{
            "mainTpl": "main/main2.html",
        })
    })
    s.SetPort(8199)
    s.Run()
}

执行后,访问不同的路由地址,将会看到不同的结果:

  1. http://127.0.0.1:8199/main1

  2. http://127.0.0.1:8199/main2

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.