ginx - ERP系统后端

一个基于 Go 语言和 Gin 框架的ERP系统后端，集成了常用的中间件和工具，提供了完整的项目结构、数据库设计和API文档。

项目概述

本项目是一个完整的ERP系统后端解决方案，包含以下核心模块：

• CRM模块：客户管理、联系人管理、客户活动、客户反馈、销售线索、销售机会、营销活动
• 销售模块：客户管理、产品管理、销售报价、销售订单、销售发货、销售发票、销售退货
• 库存模块：仓库管理、库位管理、物料管理、库存管理、库存交易、库存盘点
• 采购模块：供应商管理、采购计划、采购订单、采购收货、采购发票、采购退货
• 财务模块：会计科目、凭证管理、固定资产、预算管理、成本中心
• 生产模块：物料清单、主生产计划、物料需求计划、生产订单、生产工单、工艺路线、工作中心
• 人力资源模块：员工管理、部门管理、职位管理、考勤管理、请假管理、加班管理、薪资管理、培训管理、招聘管理
• 系统模块：用户管理、角色管理、权限管理、日志管理

功能特性

• ✅ Go 1.23.0 + Gin 框架
• ✅ MySQL 数据库集成（GORM）
• ✅ JWT 认证中间件
• ✅ 请求日志中间件
• ✅ 错误处理中间件
• ✅ CORS 中间件
• ✅ HTTPS 重定向中间件
• ✅ 压缩中间件
• ✅ 限流中间件
• ✅ 优雅关闭
• ✅ 配置管理（Viper）
• ✅ Docker 容器化
• ✅ 完整的项目结构
• ✅ Swagger API 文档
• ✅ 分模块启动功能
• ✅ 冷热分离存储
• ✅ 数据迁移服务

项目结构

├── cmd/              # 命令行工具
├── cold_data/        # 冷存储数据
├── configs/          # 配置文件
│   └── config.yaml   # 主配置文件
├── doc/              # 项目文档
│   ├── erp/          # ERP系统文档
│   │   └── api/      # API文档
│   ├── 数据库设计文档.md    # 数据库设计文档
│   └── 后端实现文档清单.md   # 后端实现文档清单
├── internal/         # 内部包
│   ├── api/          # API 相关代码
│   │   ├── handlers/     # 请求处理器
│   │   ├── middlewares/  # 中间件
│   │   ├── routes/       # 路由
│   │   └── schemas/      # 数据结构定义
│   ├── config/       # 配置管理
│   ├── data/         # 数据访问层
│   │   ├── migration/    # 数据迁移
│   │   └── storage/      # 存储实现
│   ├── database/     # 数据库连接
│   ├── errors/       # 错误处理
│   ├── models/       # 数据模型
│   ├── services/     # 业务逻辑层
│   └── utils/        # 工具函数
├── pkg/              # 公共包
├── scripts/          # 脚本文件
├── sql/              # SQL 文件
│   └── erp_database.sql # ERP系统数据库建表语句
├── tests/            # 测试文件
├── wire/             # Wire 依赖注入配置
├── .gitignore        # Git 忽略文件
├── docker-compose.yml # Docker Compose 配置
├── Dockerfile        # Docker 构建文件
├── go.mod            # Go 模块文件
├── go.sum            # Go 依赖校验文件
├── main.go           # 主入口文件
├── Makefile          # 构建脚本
├── README.md         # 项目文档
├── wire.go           # Wire 依赖注入定义
└── wire_gen.go       # Wire 生成的代码

快速开始

1. 环境要求

• Go 1.23.0 或更高版本
• MySQL 8.0 或更高版本
• Docker（可选，用于容器化部署）

2. 安装依赖

go mod tidy

3. 配置数据库

修改 configs/config.yaml 文件中的数据库配置：

database:
  host: "localhost"
  port: "3306"
  user: "root"
  password: "root"
  dbname: "erp"
  charset: "utf8mb4"
  parseTime: true
  loc: "Local"

4. 初始化数据库

使用提供的SQL文件初始化数据库结构：

# 登录MySQL
mysql -u root -p

# 创建数据库
CREATE DATABASE erp CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

# 使用数据库
USE erp;

# 导入SQL文件
source sql/erp_database.sql;

5. 运行项目

直接运行

go run main.go

构建并运行

go build -o ginx main.go
./ginx

使用 Docker 运行

docker-compose up -d

分模块启动

项目支持分模块启动，可以通过 -module 参数指定要启动的模块：

# 启动所有模块
go run main.go -module all

# 启动单个模块（例如HR模块）
go run main.go -module hr

# 启动其他模块
go run main.go -module user      # 用户模块
go run main.go -module sales     # 销售模块
go run main.go -module inventory # 库存模块
go run main.go -module purchase  # 采购模块
go run main.go -module finance   # 财务模块
go run main.go -module production # 生产模块
go run main.go -module crm       # CRM模块

5. 访问 API

项目启动后，可通过以下地址访问 API：

• 基础地址：http://localhost:8080
• 健康检查：http://localhost:8080/health
• Swagger API 文档：http://localhost:8080/swagger/index.html（需要取消注释 main.go 中的 Swagger 路由配置）

开发指南

1. 添加新路由

在 internal/api/routes/routes.go 文件中添加新的路由：

func SetupRoutes(router *gin.Engine) {
    // API 分组
    api := router.Group("/api")
    
    // 健康检查
    router.GET("/health", func(c *gin.Context) {
        c.JSON(http.StatusOK, gin.H{"status": "ok"})
    })
    
    // 添加新路由
    api.GET("/users", GetUsers)
    api.POST("/users", CreateUser)
    api.GET("/users/:id", GetUser)
    api.PUT("/users/:id", UpdateUser)
    api.DELETE("/users/:id", DeleteUser)
}

2. 添加新中间件

在 internal/api/middlewares/ 目录下创建新的中间件文件，然后在 internal/api/middlewares/middlewares.go 文件中注册：

func SetupMiddlewares(router *gin.Engine) {
    router.Use(Logger())
    router.Use(RequestID())
    router.Use(Cors())
    router.Use(Session())
    router.Use(HTTPSRedirect())
    router.Use(Compress())
    router.Use(RateLimit())
    router.Use(ErrorHandler())
}

3. 添加新模型

在 internal/models/ 目录下创建新的模型文件，然后在 main.go 文件中添加自动迁移：

// 自动迁移数据库表结构
err = database.AutoMigrate(&models.User{}, &models.NewModel{})
if err != nil {
    log.Fatalf("迁移数据库表结构失败: %v", err)
}

4. 配置管理

项目使用 Viper 管理配置，配置文件位于 configs/config.yaml，可通过环境变量覆盖配置值。

部署指南

1. 本地部署

# 构建项目
go build -o ginx main.go

# 运行项目
./ginx

2. Docker 部署

# 构建镜像
docker build -t ginx .

# 运行容器
docker run -d --name ginx -p 8080:8080 ginx

3. Docker Compose 部署

docker-compose up -d

测试

运行单元测试

go test ./...

运行基准测试

go test -bench=. ./...

性能分析

# CPU 分析
go test -cpuprofile=cpu.prof ./...
go tool pprof cpu.prof

# 内存分析
go test -memprofile=mem.prof ./...
go tool pprof mem.prof

监控

项目集成了以下监控功能：

• 请求日志
• 错误日志
• 性能分析

常见问题

1. 数据库连接失败

• 检查数据库服务是否运行
• 检查数据库配置是否正确
• 检查网络连接是否正常

2. 端口被占用

• 使用 lsof -i :8080 查看端口占用情况
• 终止占用端口的进程或修改项目端口配置

3. 依赖包下载失败

• 检查网络连接
• 设置 Go 模块代理：

  go env -w GOPROXY=https://goproxy.io,direct

技术栈

技术/工具	版本	用途
Go	1.23.0	开发语言
Gin	v1.11.0	Web 框架
GORM	v1.25.7	ORM 框架
Viper	v1.18.2	配置管理
JWT	v5.2.0	认证
MySQL	8.0+	数据库
Docker	-	容器化

项目文档

1. API文档

• 位置：doc/erp/api/
• 包含各模块的API接口定义、参数说明、返回格式等

2. 数据库设计文档

• 位置：doc/数据库设计文档.md
• 详细描述了数据库表结构、字段定义、索引设计和关系定义

3. 后端实现文档清单

• 位置：doc/后端实现文档清单.md
• 列出了需要实现的功能模块和开发指南

贡献

欢迎提交 Issue 和 Pull Request！

许可证

MIT