jframe-module-dev

jframe Module Development

This skill guides you through implementing the internal code of a jframe module — the handler, service, dao, and model layers, plus DI wiring, route registration, and testing.

Prerequisite: The module skeleton should already exist (created via jframe create -n <name> or manually). If not, use the jframe-module-design skill first — it walks through requirements gathering, lifecycle phase selection, config struct design, DI planning, scaffolding, and module registration.

Module internal architecture

jframe modules follow a layered architecture convention:

mod/<name>/
├── mod.go       # Lifecycle entry point — DI wiring, route registration
├── handler/     # HTTP/gRPC request handling — parse input, call service, format response
├── service/     # Business logic — orchestrates dao calls, enforces rules
├── dao/         # Data access — GORM queries, wraps stdao
├── model/       # Data models — GORM structs, DTOs
└── e/           # Error codes — domain-specific error definitions

Data flow: handler → service → dao → model

The handler receives requests, calls service methods with domain types, the service implements business rules and calls dao for persistence, and the dao talks to the database through GORM. This separation keeps each layer testable and replaceable.

Implementing the model layer

Models define your data structures. For database-backed models, embed stdao.Model which provides ULID primary key, timestamps, and soft delete:

// mod/<name>/model/user.go
package model

import "github.com/juanjiTech/jframe/pkg/stdao"

type User struct {
    stdao.Model
    Username string `json:"username" gorm:"uniqueIndex;size:64"`
    Email    string `json:"email" gorm:"size:256"`
    Status   int    `json:"status" gorm:"default:1"`
}

stdao.Model gives you:

type Model struct {
    ID        string          `json:"id" gorm:"primaryKey;size:26"`  // ULID
    CreatedAt time.Time       `json:"createdAt"`
    UpdatedAt time.Time       `json:"updatedAt"`
    DeletedAt *gorm.DeletedAt `json:"deletedAt" gorm:"index"`       // soft delete
}