docs(constitution): 新增数据库设计原则(v2.4.0)

在项目宪章中新增第九条原则"数据库设计原则",明确禁止使用数据库外键约束和ORM关联标签。

主要变更:
- 新增原则IX:数据库设计原则(Database Design Principles)
- 强制要求:数据库表不得使用外键约束
- 强制要求:GORM模型不得使用ORM关联标签(foreignKey、hasMany等)
- 强制要求:表关系必须通过ID字段手动维护
- 强制要求:关联数据查询必须显式编写,避免ORM魔法
- 强制要求:时间字段由GORM处理,不使用数据库触发器

设计理念:
- 提升业务逻辑灵活性(无数据库约束限制)
- 优化高并发性能(无外键检查开销)
- 增强代码可读性(显式查询,无隐式预加载)
- 简化数据库架构和迁移流程
- 支持分布式和微服务场景

版本升级:2.3.0 → 2.4.0(MINOR)
This commit is contained in:
2025-11-13 13:40:19 +08:00
parent ea0c6a8b16
commit 984ccccc63
63 changed files with 12099 additions and 83 deletions

View File

@@ -0,0 +1,104 @@
package postgres
import (
"context"
"github.com/break/junhong_cmp_fiber/internal/model"
"gorm.io/gorm"
)
// OrderStore 订单数据访问层
type OrderStore struct {
db *gorm.DB
}
// NewOrderStore 创建订单 Store
func NewOrderStore(db *gorm.DB) *OrderStore {
return &OrderStore{db: db}
}
// Create 创建订单
func (s *OrderStore) Create(ctx context.Context, order *model.Order) error {
return s.db.WithContext(ctx).Create(order).Error
}
// GetByID 根据 ID 获取订单
func (s *OrderStore) GetByID(ctx context.Context, id uint) (*model.Order, error) {
var order model.Order
err := s.db.WithContext(ctx).First(&order, id).Error
if err != nil {
return nil, err
}
return &order, nil
}
// GetByOrderID 根据订单号获取订单
func (s *OrderStore) GetByOrderID(ctx context.Context, orderID string) (*model.Order, error) {
var order model.Order
err := s.db.WithContext(ctx).Where("order_id = ?", orderID).First(&order).Error
if err != nil {
return nil, err
}
return &order, nil
}
// ListByUserID 根据用户 ID 分页获取订单列表
func (s *OrderStore) ListByUserID(ctx context.Context, userID uint, page, pageSize int) ([]model.Order, int64, error) {
var orders []model.Order
var total int64
// 计算总数
if err := s.db.WithContext(ctx).Model(&model.Order{}).Where("user_id = ?", userID).Count(&total).Error; err != nil {
return nil, 0, err
}
// 分页查询
offset := (page - 1) * pageSize
err := s.db.WithContext(ctx).
Where("user_id = ?", userID).
Offset(offset).
Limit(pageSize).
Order("created_at DESC").
Find(&orders).Error
if err != nil {
return nil, 0, err
}
return orders, total, nil
}
// List 分页获取订单列表(全部订单)
func (s *OrderStore) List(ctx context.Context, page, pageSize int) ([]model.Order, int64, error) {
var orders []model.Order
var total int64
// 计算总数
if err := s.db.WithContext(ctx).Model(&model.Order{}).Count(&total).Error; err != nil {
return nil, 0, err
}
// 分页查询
offset := (page - 1) * pageSize
err := s.db.WithContext(ctx).
Offset(offset).
Limit(pageSize).
Order("created_at DESC").
Find(&orders).Error
if err != nil {
return nil, 0, err
}
return orders, total, nil
}
// Update 更新订单
func (s *OrderStore) Update(ctx context.Context, order *model.Order) error {
return s.db.WithContext(ctx).Save(order).Error
}
// Delete 软删除订单
func (s *OrderStore) Delete(ctx context.Context, id uint) error {
return s.db.WithContext(ctx).Delete(&model.Order{}, id).Error
}

View File

@@ -0,0 +1,53 @@
package postgres
import (
"context"
"go.uber.org/zap"
"gorm.io/gorm"
)
// Store PostgreSQL 数据访问层整合结构
type Store struct {
db *gorm.DB
logger *zap.Logger
User *UserStore
Order *OrderStore
}
// NewStore 创建新的 PostgreSQL Store 实例
func NewStore(db *gorm.DB, logger *zap.Logger) *Store {
return &Store{
db: db,
logger: logger,
User: NewUserStore(db),
Order: NewOrderStore(db),
}
}
// DB 获取数据库连接
func (s *Store) DB() *gorm.DB {
return s.db
}
// Transaction 执行事务
// 提供统一的事务管理接口,自动处理提交和回滚
// 在事务内部,所有 Store 操作都会使用事务连接
func (s *Store) Transaction(ctx context.Context, fn func(*Store) error) error {
return s.db.WithContext(ctx).Transaction(func(tx *gorm.DB) error {
// 创建事务内的 Store 实例
txStore := &Store{
db: tx,
logger: s.logger,
User: NewUserStore(tx),
Order: NewOrderStore(tx),
}
return fn(txStore)
})
}
// WithContext 返回带上下文的数据库实例
func (s *Store) WithContext(ctx context.Context) *gorm.DB {
return s.db.WithContext(ctx)
}

View File

@@ -0,0 +1,78 @@
package postgres
import (
"context"
"github.com/break/junhong_cmp_fiber/internal/model"
"gorm.io/gorm"
)
// UserStore 用户数据访问层
type UserStore struct {
db *gorm.DB
}
// NewUserStore 创建用户 Store
func NewUserStore(db *gorm.DB) *UserStore {
return &UserStore{db: db}
}
// Create 创建用户
func (s *UserStore) Create(ctx context.Context, user *model.User) error {
return s.db.WithContext(ctx).Create(user).Error
}
// GetByID 根据 ID 获取用户
func (s *UserStore) GetByID(ctx context.Context, id uint) (*model.User, error) {
var user model.User
err := s.db.WithContext(ctx).First(&user, id).Error
if err != nil {
return nil, err
}
return &user, nil
}
// GetByUsername 根据用户名获取用户
func (s *UserStore) GetByUsername(ctx context.Context, username string) (*model.User, error) {
var user model.User
err := s.db.WithContext(ctx).Where("username = ?", username).First(&user).Error
if err != nil {
return nil, err
}
return &user, nil
}
// List 分页获取用户列表
func (s *UserStore) List(ctx context.Context, page, pageSize int) ([]model.User, int64, error) {
var users []model.User
var total int64
// 计算总数
if err := s.db.WithContext(ctx).Model(&model.User{}).Count(&total).Error; err != nil {
return nil, 0, err
}
// 分页查询
offset := (page - 1) * pageSize
err := s.db.WithContext(ctx).
Offset(offset).
Limit(pageSize).
Order("created_at DESC").
Find(&users).Error
if err != nil {
return nil, 0, err
}
return users, total, nil
}
// Update 更新用户
func (s *UserStore) Update(ctx context.Context, user *model.User) error {
return s.db.WithContext(ctx).Save(user).Error
}
// Delete 软删除用户
func (s *UserStore) Delete(ctx context.Context, id uint) error {
return s.db.WithContext(ctx).Delete(&model.User{}, id).Error
}