Gin-Admin:一个基于Golang的开源RBAC脚手架
1. 项目介绍
Gin-Admin 是一个基于 Golang 的轻量级、灵活、优雅且功能齐全的 RBAC(基于角色的访问控制)脚手架。它集成了流行的 Web 框架 Gin、ORM 框架 GORM 2.0、权限控制框架 Casbin 2.0 和依赖注入工具 Wire DI。Gin-Admin 提供了一套完整的后端服务解决方案,适用于快速构建企业级应用。
2. 项目快速启动
环境准备
- Go 1.19 或更高版本
- Wire:
go install github.com/google/wire/cmd/wire@latest
- Swag:
go install github.com/swaggo/swag/cmd/swag@latest
- Gin-Admin-CLI:
go install github.com/gin-admin/gin-admin-cli/v10@latest
创建新项目
gin-admin-cli new -d ~/go/src --name testapp --desc "A test API service based on golang." --pkg "github.com/xxx/testapp" --git-url https://gitee.com/lyric/gin-admin.git
启动服务
修改 configs/dev/server.toml
中的 MenuFile
可以切换到中文菜单。
cd ~/go/src/testapp
make start
# 或者
go run main.go start
编译服务
make build
# 或者
go build -ldflags "-w -s -X main.VERSION=v1.0.0" -o testapp
生成 Docker 镜像
docker build -f ./Dockerfile -t testapp:v1.0.0 .
代码生成
通过 Gin-Admin-CLI 可以生成代码。
gin-admin-cli gen -d . -m SYS -c dictionary.yaml
生成 Swagger 文档
make swagger
# 或者
swag init --parseDependency --generalInfo ./main.go --output ./internal/swagger
生成依赖注入代码
make wire
# 或者
wire gen ./internal/wirex
3. 应用案例和最佳实践
- RESTful API 设计:Gin-Admin 采用接口化编程范式,提供了优雅的 RESTful API 设计。
- 模块化架构:项目结构清晰简洁,便于维护和升级。
- 中间件集成:内置了身份认证、跨域、日志、限流、链路追踪、权限控制、容错、压缩等中间件,助力快速构建企业级应用。
- 权限控制:集成 Casbin 框架,实现灵活精准的 RBAC 权限控制。
- 数据库操作:基于 GORM 2.0 ORM 框架,简化数据库操作,提升开发效率。
- 依赖注入:采用 Wire 依赖注入,简化模块依赖关系,代码更加优雅解耦。
4. 典型生态项目
- 前端项目:基于 Ant Design React 和 Vue.js 实现的前端项目,与 Gin-Admin 后端项目配合使用。
- 监控与报警:集成 Prometheus 进行监控,可以通过 Grafana 等工具进行可视化展示和报警。
- 日志管理:采用 Zap 日志框架,配合 Context 链路追踪,便于问题排查。
以上就是关于 Gin-Admin 开源项目的简介、快速启动、应用案例和典型生态项目的介绍。希望对您有所帮助。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考