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.

examplesnosqlmongodbREADME.ZH.MD

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

GoFrame MongoDB 示例

此示例演示了如何在 GoFrame 框架中使用 MongoDB。

概述

本示例展示了:

  1. 如何使用 YAML 配置文件配置 MongoDB 连接
  2. 如何创建 MongoDB 客户端
  3. 基本的 MongoDB 操作(INSERT、FIND、UPDATE)
  4. 如何使用 BSON 进行文档操作

环境要求

  • Go 1.15 或更高版本
  • MongoDB 服务器
  • GoFrame v2

代码结构

  • main.go: 包含主要逻辑和 MongoDB 客户端初始化
  • config.yaml: MongoDB 配置文件

配置说明

MongoDB 配置存储在 config.yaml 文件中:

mongo:
  database: "user"
  address: "mongodb://127.0.0.1:27017/test?retryWrites=true"

您可以根据自己的 MongoDB 服务器配置修改这些设置。

使用 Docker 运行 MongoDB

如果您本地没有安装 MongoDB,可以使用 Docker 快速启动一个 MongoDB 实例:

# 运行 MongoDB 容器
docker run --name mongo-test -p 27017:27017 -d mongo:latest

# 验证容器是否正在运行
docker ps

# 如果需要停止容器
docker stop mongo-test

# 如果需要删除容器
docker rm mongo-test

如果需要带认证的 MongoDB:

# 运行带认证的 MongoDB
docker run --name mongo-test -p 27017:27017 -e MONGO_INITDB_ROOT_USERNAME=admin -e MONGO_INITDB_ROOT_PASSWORD=password -d mongo:latest

# 记得相应地更新 config.yaml:
# mongo:
#   database: "user"
#   address: "mongodb://admin:password@127.0.0.1:27017/test?retryWrites=true"

运行示例

  1. 确保 MongoDB 服务器正在运行
  2. 根据需要更新 config.yaml
  3. 运行示例:
go run main.go

更多参考

更多 MongoDB 的使用方法请参考官方 MongoDB Go 驱动 github.com/mongodb/mongo-go-driver。

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.