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.

exampleshttpserversseREADME.ZH.MD

≈744 tokens on demand. Your agent reads this file only when SKILL.md points to it.

Server-Sent Events(SSE)

描述

本示例演示了如何使用 GoFrame 实现服务器发送事件（SSE）。服务器发送事件是一种允许服务器通过HTTP连接向客户端推送更新的技术。与WebSocket不同，SSE是单向的 - 只有服务器可以向客户端发送数据。

本示例实现了一个简单的SSE服务端实现，逐字符流式传输响应，模拟现代AI聊天应用程序中常见的实时打字效果。

要求

结构

- go.mod: Go模块文件
- main.go: 包含SSE实现的主应用程序入口点

特性

  • 服务器发送事件实现
  • 模拟AI聊天逐字符流式响应
  • 适用于SSE的正确HTTP头

设置

  1. 克隆仓库：

    git clone https://github.com/gogf/examples.git
cd examples/httpserver/sse

  2. 安装依赖：

    go mod tidy

  3. 运行应用程序：

    go run main.go

使用方法

  1. 运行示例：

    go run main.go

  2. 服务器将在以下地址启动：http://127.0.0.1:8000

  3. 访问SSE端点：

实现细节

SSE实现包括：

  • 设置正确的SSE HTTP头：

    • Content-Type: text/event-stream
    • Cache-Control: no-cache
    • Connection: keep-alive

  • 使用适当的刷新进行流式响应

  • 使用time.Sleep模拟打字延迟

  • 使用GoFrame的路由器进行简单的HTTP路由

注意事项

  • SSE连接保持打开状态，直到客户端明确关闭
  • 服务器必须在每条消息后刷新响应缓冲区
  • 对于生产环境，请考虑实现重连逻辑和事件ID
  • SSE通过常规HTTP/HTTPS工作，并支持浏览器中的自动重连

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.