Gin项目目录结构规范

在开发Gin项目时，如何规范目录结构才能既保持清晰又便于维护？常见的分层方式（如MVC、领域驱动等）在Gin中该如何具体实现？是否有推荐的目录命名规范（例如/internal、/pkg的使用场景区别）？中小型项目与大项目的目录划分是否需要差异？希望了解实际项目中的最佳实践和常见坑点。

3 回复

作为一个Gin框架的屌丝程序员，我推荐如下项目目录结构：

myproject/
├── main.go          # 程序入口
├── config/          # 配置文件
│   └── config.yaml  # 应用配置
├── controllers/     # 控制器层
│   └── user.go      # 用户模块控制器
├── models/          # 模型层
│   └── user.go      # 用户模型定义
├── services/        # 服务层
│   └── user.go      # 用户业务逻辑
├── middleware/      # 中间件
│   └── auth.go      # 权限验证中间件
├── routers/         # 路由配置
│   └── router.go    # 路由注册
├── utils/           # 工具类
│   └── helper.go    # 工具函数
├── logs/            # 日志文件
└── go.mod           # Go模块定义

这种结构清晰，便于分工协作。main.go负责初始化项目，config/存放配置，controllers/处理请求，models/与数据库交互，services/封装业务逻辑，middleware/用于拦截和增强请求，routers/定义路由，utils/存放通用工具，logs/存储日志文件。


作为屌丝程序员，我分享一个简单的Gin项目目录结构规范：

myginapp/
│
├── main.go          # 项目入口文件
├── conf/            # 配置文件
│   └── config.yaml
├── controllers/     # 控制器层
│   └── example.go
├── models/          # 模型层
│   └── user.go
├── routes/          # 路由配置
│   └── router.go
├── middleware/      # 中间件
│   └── auth.go
├── utils/           # 工具类
│   └── helper.go
├── logs/            # 日志文件
└── go.mod           # 依赖管理

这个结构简单清晰：入口文件main.go负责启动服务；conf存放配置；controllers处理请求逻辑；models定义数据模型；routes绑定路由；middleware实现通用中间件；utils存放工具函数；logs保存日志文件。保持这种规范，代码会更有条理，方便后续维护和扩展。

在Gin框架项目中，建议采用以下目录结构规范，保持代码清晰和可维护性：

project/
├── cmd/                 # 主程序入口
│   └── main.go         # 主启动文件
├── internal/           # 私有代码(外部项目不可导入)
│   ├── config/         # 配置文件处理
│   ├── controller/     # 控制器层
│   ├── middleware/     # 中间件
│   ├── model/          # 数据模型
│   ├── repository/     # 数据持久层
│   ├── service/        # 业务逻辑层
│   └── router/         # 路由配置
├── pkg/                # 公共库(可被外部项目引用)
├── api/                # API文档/Swagger
├── web/                # 前端静态资源
├── scripts/            # 部署/构建脚本
├── test/               # 测试代码
├── go.mod              # Go模块文件
└── README.md           # 项目文档

关键说明：

  1. 分层架构：控制器(controller)→服务(service)→仓储(repository)→模型(model)
  2. 路由单独管理：建议在router/目录中初始化Gin引擎和路由
  3. 示例router.go:
package router

import (
	"github.com/gin-gonic/gin"
	"project/internal/controller"
	"project/internal/middleware"
)

func Setup() *gin.Engine {
	r := gin.Default()
	
	r.Use(middleware.Logger())
	
	v1 := r.Group("/api/v1")
	{
		v1.GET("/users", controller.GetUsers)
		v1.POST("/users", controller.CreateUser)
	}
	
	return r
}
  1. main.go简单示例：
package main

import "project/internal/router"

func main() {
	r := router.Setup()
	r.Run(":8080")
}

这种结构清晰分离关注点，方便团队协作和后续扩展。

回到顶部