GoFastCrud

GoFastCrud 是一个基于 Gin 框架的快速 CRUD 开发框架，帮助开发者快速构建 RESTful API。

特性

• 🚀 快速生成标准 CRUD 接口
• 📚 自动生成 Swagger 文档
• 🛠 支持自定义控制器和路由
• 🔌 灵活的中间件支持
• 🎯 类型安全的泛型实现
• 📦 工厂模式简化注册流程
• 💡 支持自定义响应处理
• 🔒 内置权限验证机制
• 📊 支持多种数据库（待开发）
• 🔍 丰富的查询条件支持
• 📝 完整的日志记录
• ⚡️ 高性能设计（待开发）
• 🔄 支持事务处理
• 🛡 内置安全防护（待开发）

安装

go get github.com/kruily/gofastcrud

使用

1. 配置

// config.yaml
server: 
  address: ":8080"  // 服务地址

database:
  driver: "mysql" // 数据库驱动
  host: "localhost" // 数据库地址
  port: 3306 // 数据库端口
  username: "root" // 数据库用户名
  password: "password" // 数据库密码
  database: "test_crud" // 数据库名称

2. 启动服务

// main.go

type User struct {
    ...
}

func main() {    
    // 创建应用实例
    app := app.NewDefaultGoFastCrudApp()

    // 发布API版本
    app.PublishVersion(server.V1)

    // 注册控制器
    app.RegisterControllers(func(factory *crud.ControllerFactory, server *server.Server) {
        crud.Register[*User](factory, "/users", server)
    })

    // 启动服务
    app.Start()
}

启动服务，访问主页：http://localhost:8080

现在用户各个接口均已自动注册到GIN ROUTER中,可以点击主页API Documentation查看Swagger文档或访问：http://localhost:8080/api/v1/swagger/index.html

3. 定义实体模型

需要继承 crud.BaseEntity 并实现 crud.ICrudEntity 接口的 Table 方法

// models/user.go
type User struct {
    // 嵌入crud基础实体 
    crud.BaseEntity  `json:"-"` //不参与json序列化
	Username  string `json:"username" binding:"required" description:"用户名"`
	Email     string `json:"email" description:"邮箱地址"`
}

// 定义表名 必须实现
func (u User) Table() string {
	return "users"
}

4. 控制器

有两种方式创建控制器：

4.1 使用默认控制器

只需传入实体模型

factory.Register(server, models.User{})

4.2 使用自定义控制器

需要继承 crud.CrudController 并定义出创建控制器实例的方法

// controllers/user_controller.go
type UserController struct {
    // ***嵌入 CrudController***
    *crud.CrudController[models.User] 
}
// 创建控制器实例
func NewUserController(db *gorm.DB) *UserController {
    controller := &UserController{
        CrudController: crud.NewCrudController(db, models.User{}),
    }
    // 应用中间件（可选）
    controller.UseMiddleware("*", middleware.Auth())
    // 某类方法应用中间件（可选）
    controller.UseMiddleware("POST", middleware.Validate())

    // 添加自定义路由
    controller.AddRoute(crud.APIRoute{
        Path:        "/login",
        Method:      "POST",
        // swagger 信息
        Tags:        []string{controller.GetEntityName()},
        Summary:     "用户登录",
        Description: "通过用户名和密码进行登录",
        // 请求处理函数
        Handler:     controller.Login,
        // 只对当前路由应用中间件（可选）
        Middleware:  []gin.HandlerFunc{middleware.Auth()},
    })
    return controller
}

// 自定义方法 返回值必须为(interface{}, error) 
//interface{} 为返回数据 error 为错误信息
// 无需关注Response 框架会自动处理
func (c *UserController) Login(ctx *gin.Context)(interface{}, error) {
    ...
}

factory.RegisterCustom(server, controllers.NewUserController)

5. 完整示例

example

标准 CRUD 接口

• GET /{entity} - 获取列表
• POST /{entity} - 创建实体
• GET /{entity}/{id} - 获取单个实体
• POST /{entity}/{id} - 更新实体
• DELETE /{entity}/{id} - 删除实体
• POST /{entity}/batch - 批量创建
• POST /{entity}/batch - 批量更新
• DELETE /{entity}/batch - 批量删除

高级特性

中间件支持

// 控制器全局中间件，* 表示所有方法，POST 表示指定方法
controller.UseMiddleware("*", middleware.Auth())

// 方法特定中间件
controller.UseMiddleware("POST", middleware.Validate())

自定义响应处理

app := app.NewDefaultGoFastCrudApp(WithResponse(CustomResponser{}))

CustomResponser 需要实现 ICrudResponse 接口

// internal/crud/response.go
type ICrudResponse interface {
	Success(data interface{}) interface{}
	Error(err error) interface{}
	Pagenation(items interface{}, total int64, page int, size int) interface{}
}

DI 支持

# 获取DI
di.SINGLE()

# 注册依赖 单例
di.BindSingletonWithName("SERVICE", &Service{})
di.BindSingletonWithType(&Service{})

# 获取依赖 单例
di.GetSingletonByName("SERVICE")
di.GetSingletonByType(&Service{})

获取Repository 单独使用

// 获取Repository
repo := di.GetSingletonByName(models.User{}.Table())

Repository 实现 ICrudRepository 接口

贡献指南

1. Fork 本仓库
2. 创建特性分支 (git checkout -b feature/AmazingFeature)
3. 提交更改 (git commit -m 'Add some AmazingFeature')
4. 推送到分支 (git push origin feature/AmazingFeature)
5. 提交 Pull Request

许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情