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.

examplesbalancerpolarisREADME.md

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

Load Balancer - Polaris Integration Example

Description

This example demonstrates how to implement HTTP service load balancing with GoFrame using Polaris. It shows:

  • Service registration using Polaris
  • Client-side load balancing
  • Round-robin load balancing strategy
  • HTTP service communication
  • Local cache and logging configuration

Requirements

Structure

.
├── client/           # HTTP client implementation with load balancing
│   └── client.go     # Client code with round-robin balancer
├── server/           # HTTP server implementation
│   └── server.go     # Server code with service registration
├── go.mod            # Go module file
└── go.sum            # Go module checksums

Prerequisites

  1. Running Polaris server:
    # Using docker
docker run -d --name polaris \
   -p 8090:8090 -p 8091:8091 -p 8093:8093 -p 9090:9090 -p 9091:9091 \
   polarismesh/polaris-standalone:v1.17.2

Configuration

The example uses the following Polaris configurations:

  • Server address: 127.0.0.1:8091
  • Local cache directory: <TempDir>/polaris/backup
  • Log directory: <TempDir>/polaris/log
  • Service TTL: 10 seconds

Usage

  1. Start multiple server instances (use random different ports):

    # Terminal 1
cd server
go run server.go

# Terminal 2
cd server
go run server.go

# Terminal 3
cd server
go run server.go

  2. Run the client to test load balancing:

    cd client
go run client.go

Implementation Details

  1. Server Implementation (server/server.go):

    • HTTP server setup using GoFrame
    • Service registration with Polaris
    • Simple HTTP endpoint that returns "Hello world"
    • Automatic service discovery registration
    • Configurable TTL for service registration

  2. Client Implementation (client/client.go):

    • Service discovery using Polaris
    • Round-robin load balancing strategy
    • Multiple request demonstration with timing information
    • Automatic service discovery and load balancing
    • Local cache and logging configuration

Notes

  • The example uses Polaris for service registration and discovery
  • Round-robin load balancing is implemented for demonstration
  • The client automatically handles service discovery and load balancing
  • Local cache is used to improve performance
  • Logging is configured for better debugging

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.