当前位置：首页 > news >正文

Golang Gin系列-3：Gin Framework的项目结构

news 文章来源：https://blog.csdn.net/neweastsun/article/details/145213041 2025/5/19 20:32:16

在Gin教程的第3篇，我们将讨论如何设置你的项目。这不仅仅是把文件扔得到处都是，而是要对所有东西的位置做出明智的选择。相信我，这些东西很重要。如果你做得对，你的项目会更容易处理。当你以后不再为了找东西或添加新功能而绞尽脑汁时，你会感谢自己的。另外，它会让你的代码看起来更专业。因此，让我们深入了解像老板一样组织Gin项目的细节。

Gin项目结构参考

组织良好的项目结构是无缝开发和协作的基础。以下是Gin项目的推荐布局：

my-gin-project/
├── go.mod
├── go.sum
├── main.go
├── config/
│   └── config.go
├── controllers/
│   ├── user_controller.go
│   └── product_controller.go
├── models/
│   ├── user_model.go
│   └── product_model.go
├── routes/
│   └── routes.go
├── middleware/
│   └── auth_middleware.go
├── services/
│   ├── user_service.go
│   └── product_service.go
├── utils/
│   └── utils.go
└── static/└── index.html

go.mod 和 go.sum:

go.mod

这个文件是使用 Go Modules 进行依赖管理的核心文件，它包含了项目的模块信息和依赖的第三方库及其版本信息。例如：
```
module github.com/yourusername/my-gin-projectgo 1.18require (github.com/gin-gonic/gin v1.7.4
)
```
go.sum

存储了项目依赖的所有包的版本及其哈希值，确保依赖的完整性和安全性。当你使用 go get 命令添加或更新依赖时，这个文件会自动更新。
main.go:

项目的入口文件，通常包含了程序的初始化和启动逻辑。例如：

package mainimport ("github.com/gin-gonic/gin"
)func main() {r := gin.Default()// 注册路由// 可以在这里调用 routes 包中的函数来注册路由r.Run(":8080")
}

用于存放项目的配置文件或配置信息的读取和管理逻辑。config.go:

package configimport "os"func GetConfig() string {return os.Getenv("APP_CONFIG")
}

这里的 GetConfig 函数可以用来获取环境变量中的配置信息，比如应用程序的配置。

controllers/ 目录:

存放控制器逻辑，处理路由请求和响应。user_controller.go:

package controllersimport ("net/http""github.com/gin-gonic/gin"
)func UserHandler(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "Hello, User!"})
}

这里的 UserHandler 函数是一个处理用户相关请求的控制器，通过 gin.Context 来处理请求和发送响应。

models/ 目录:

包含数据模型，通常用于定义数据结构和与数据库的交互逻辑（如 ORM）。user_model.go:

package modelstype User struct {ID        intName      stringEmail     string
}

这里定义了一个 User 结构体，代表用户的数据结构。

routes/ 目录:

负责路由的注册和配置。routes.go:

package routesimport ("github.com/gin-gonic/gin""my-gin-project/controllers"
)func SetupRoutes(r *gin.Engine) {r.GET("/user", controllers.UserHandler)
}

这里的 SetupRoutes 函数将 /user 路由与 controllers.UserHandler 函数绑定。

middleware/ 目录:

包含中间件逻辑，例如身份验证、日志记录等。auth_middleware.go:

package middlewareimport ("net/http""github.com/gin-gonic/gin"
)func AuthMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 这里可以添加身份验证逻辑c.Next()}
}

这个 AuthMiddleware 函数是一个中间件，可以在请求处理前进行身份验证操作。

包含业务逻辑，通常是控制器和模型之间的业务处理逻辑。user_service.go:

package servicesimport "my-gin-project/models"func GetUserByID(id int) models.User {// 这里可以添加从数据库获取用户信息的逻辑user := models.User{ID:    id,Name:  "Test User",Email: "test@example.com",}return user
}

这里的 GetUserByID 函数实现了根据用户 ID 获取用户信息的业务逻辑。

存放一些通用的工具函数，例如日期处理、字符串处理等。utils.go:

package utilsimport "fmt"func PrintMessage(message string) {fmt.Println(message)
}

这里的 PrintMessage 函数是一个简单的工具函数，用于打印消息。

用于存放静态文件，例如 HTML、CSS、JavaScript 文件等。index.html:

<!DOCTYPE html>
<html lang="en">
<head><meta charset="UTF-8"><title>Welcome</title>
</head>
<body><h1>Welcome to my Gin project</h1>
</body>
</html>

结构设计的优势：

模块化：将不同功能的代码分别存放在不同的目录和文件中，方便代码的组织和维护。例如，当你需要修改用户控制器时，你可以直接定位到 controllers/user_controller.go 文件。
职责分离：每个目录和文件都有其明确的职责，如控制器负责处理请求，模型负责数据结构和数据库交互，服务负责业务逻辑，这样可以使代码更加清晰，易于理解和扩展。
可维护性：当项目规模扩大时，清晰的结构有助于团队协作，不同的开发人员可以专注于不同的模块，同时减少代码的耦合性，降低维护成本。

通过这种项目结构，你可以构建一个清晰、易于维护和扩展的 Golang Gin 项目，不同的功能和逻辑被合理地划分到不同的模块中，使开发和维护更加高效。

在为Gin应用程序配置项目布局时，请考虑以下指导原则：

一致性: 在您的项目中保持一致的目录结构，以方便导航并减少开发人员的认知开销。
约定优于配置：尽可能遵循既定的约定和最佳实践，以提高代码的熟悉性和可维护性。
灵活性：设计您的项目布局以适应未来的增长和进化。预测需求的变化，并相应地调整结构，以防止不必要的重构。

构建Gin项目的最佳实践

遵循以下最佳实践来维护一个干净且可扩展的Gin项目：

模块化应用程序

将应用程序分解为更小、更易于管理的模块或包。每个模块应该封装一组不同的功能，并遵循单一职责原则。

使用Go的包系统创建内聚和可重用的组件，可以很容易地集成到其他项目中。

分层思想实践

采用分层架构，分离诸如表示、业务逻辑和数据访问等关注点。这种分离提高了代码的可维护性，简化了测试，并支持不同组件的独立开发。

利用MVC（模型-视图-控制器）或MVVM（模型-视图-视图模型）等设计模式来进一步描述职责和促进代码组织。

使用依赖注入

通过注入组件的依赖来解耦组件，而不是直接实例化它们。依赖注入促进了松散耦合，并通过允许容易地模拟或替换依赖来简化单元测试。

考虑使用依赖注入框架或库，如谷歌Wire或Facebook的Inject，来自动解决依赖并减少样板代码。

优雅处理错误

在整个应用程序中实现健壮的错误处理机制，以优雅地处理意外故障，并向用户提供信息丰富的错误消息。

使用Go内置的错误处理功能，如‘ error ’接口和‘ panic ’和‘ recover ’函数，有效地管理错误，并在必要时将它们传播到调用堆栈中。

编写代码文档

使用Go内置的文档注释（doc comments）为代码编写清晰简洁的文档。记录函数、类型和包的目的、行为和用法，以帮助理解和促进协作。

使用‘ godoc ’等工具生成文档，为开发人员提供易于访问和最新的项目文档。

Golang Gin系列-3：Gin Framework的项目结构

在Gin教程的第3篇，我们将讨论如何设置你的项目。这不仅仅是把文件扔得到处都是，而是要对所有东西的位置做出明智的选择。相信我，这些东西很重要。如果你做得对，你的项目会更容易处理。当你以后不再为了找东西或添加新功能而绞尽脑…...

编程日记 2025/1/18 11:19:28

LabVIEW实车四轮轮速信号再现系统

开发了一个基于LabVIEW的实车四轮轮速信号再现系统。该系统解决现有电机驱动传感器成本高、重复性差、真实性差和精度低等问题，提供一种高精度、低成本的轮速信号再现解决方案。项目背景 ABS轮速传感器在现代汽车安全系统中发挥着至关重要的作用。为保证其准确性和…...

编程日记 2025/1/18 11:18:27

2025.1.16——六、BabySQL 双写绕过|联合注入

题目来源：buuctf [极客大挑战 2019]BabySQL 1 目录一、打开靶机，分析已知信息二、手工注入解题 step 1：万能密码 step 2：正常注入，判断字段数 step 3：绕过 step 4：查数据库 step 5&am…...

编程日记 2025/1/18 11:17:25

Spring Boot 下的Swagger 3.0 与 Swagger 2.0 的详细对比

先说结论： Swgger 3.0 与Swagger 2.0 区别很大，Swagger3.0用了最新的注释实现更强大的功能，同时使得代码更优雅。就个人而言，如果新项目推荐使用Swgger 3.0，对于工具而言新的一定比旧的好；对接于旧项目原…...

编程日记 2025/1/18 11:16:24

【已解决】git clone报错：Failed to connect to github.com port 443: Timed out

1.问题原因1 报错信息1： fatal: unable to access https://github.com/microsoft/xxx/: Failed to connect to github.com port 443: Timed out 报错信息2： fatal: unable to access https://github.com/xxx/xx/: OpenSSL SSL_read: Connection was …...

编程日记 2025/1/18 11:15:23

Qt 程序 DPI 适配方法归纳

方案1：通过 Windows api 处理缺点：放大之后界面会模糊。通过调用api实现 #include <ShellScalingAPI.h> #pragma comment(lib, "Shcore.lib")HRESULT hr SetProcessDpiAwareness(PROCESS_SYSTEM_DPI_AWARE);或者使用qt.conf 实现在…...

编程日记 2025/1/18 11:13:19

AI刷题-小R的随机播放顺序、不同整数的计数问题

目录一、小R的随机播放顺序问题描述测试样例解题思路： 问题理解数据结构选择算法步骤最终代码： 运行结果： 二、不同整数的计数问题问题描述测试样例解题思路： 问题理解数据结构选择算法步骤最终…...

编程日记 2025/1/18 11:08:13

windows 极速安装 Linux （Ubuntu）-- 无需虚拟机

1. 安装 WSL 和 Ubuntu 打开命令行，执行 WSL --install -d ubuntu若报错，则先执行 WSL --update2. 重启电脑因安装了子系统，需重启电脑才生效 3. 配置 Ubuntu 的账号密码打开 Ubuntu 的命令行按提示，输入账号，密…...

编程日记 2025/1/18 11:06:10

【影刀_常规任务计划_API调用】

影刀_常规任务计划 1、在常规任务计划被关闭或者设置了定时任务的情况下（非手动执行），通过API的方式启动任务，任务仍然可以被正常执行。 2、如果在常规任务计划里面应用中填写的参数的话， 如果通过api执行&#xff…...

编程日记 2025/1/18 10:59:00

参数校验 Spring Validation框架

后端参数校验解决：校验前端传入的参数是否符合预期 1、引入依赖使用Spring Validation框架 <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validatio…...

编程日记 2025/1/18 10:57:59

Spring Boot 基础入门指南

Spring Boot 基础入门指南引言在当今快速发展的软件行业中，开发者们一直在寻找简化应用程序开发的方法。Spring Boot 应运而生，它旨在帮助开发者快速构建基于Spring框架的应用程序，同时尽可能减少配置工作。本文将带您了解Spring Boot的基…...

编程日记 2025/1/18 10:56:58

doc、pdf转markdown

国外的一个网站可以： Convert A File Word, PDF, JPG Online 这个网站免费的，算是非常厚道了，但是大文件上传多了之后会扛不住国内的一个网站也不错： TextIn-AI智能文档处理-图像处理技术-大模型加速器-在线免费体验 https://…...

编程日记 2025/1/18 10:55:56

基于 HTML5 Canvas 制作一个精美的 2048 小游戏--day 1

基于 HTML5 Canvas 制作一个精美的 2048 小游戏在这个快节奏的生活中，简单而富有挑战性的游戏总能给我们带来乐趣。2048 是一款受欢迎的益智游戏，不仅考验智力，还能让人回味无穷。今天，我带领大家将一起学习如何使用 HTML5 Canv…...

编程日记 2025/1/18 10:54:56

知识图谱入门（一）

最近在研究Graph RAG项目，因此对相关内容做个总结，首先从知识图谱开始，供大家参考。知识图谱是结构化知识表示的一种形式，它将知识组织成一个多关系图，其中节点表示实体，边表示实体之间的关系。知识图谱…...

编程日记 2025/1/18 10:53:46

springboot项目-基础数据回显

一.基础数据回显说明微服务项目中由于从服务独立的角度考虑，对数据库做了分库的处理。对于基础数据表来说，各个服务都是需要的。项目中在使用基础数据时，往往是在sql中写连接然后获取基础数据的名称。例： select wi.name,bc.ci…...

编程日记 2025/1/18 10:49:36

LabVIEW实现油浸式变压器自主监测与实时报告

油浸式变压器广泛应用于电力系统中，尤其是在电力传输和分配领域。为了确保变压器的安全、稳定运行，及时监测其工作状态至关重要。传统的变压器监测方法通常依赖人工巡检和定期检查，但这不能及时发现潜在的故障隐患，且效率较低。随…...

编程日记 2025/1/18 10:46:33

K8S 亲和性与反亲和性深度好文

今天我们来实验 pod 亲和性。官网描述如下： 假设有如下三个节点的 K8S 集群： k8s31master 是控制节点 k8s31node1、k8s31node2 是工作节点容器运行时是 containerd 一、镜像准备 1.1、镜像拉取 docker pull tomcat:8.5-jre8-alpine docker pull nginx…...

编程日记 2025/1/18 10:44:30

关于php语言api接口开发的流程

确定接口需求：首先明确接口的功能和需求，包括输入参数、输出结果以及接口的业务逻辑。设计接口路由：根据接口需求，设计具体的接口路由，即URL路径，用于访问接口。搭建PHP环境：确保你的服务器上…...

编程日记 2025/1/18 10:42:27

医疗集群系统中基于超融合数据库架构的应用与前景探析

一、引言 1.1 研究背景与意义随着医疗信息化的飞速发展，医疗数据呈爆炸式增长。从日常诊疗记录、患者病历，到各类医疗影像、检查检验数据等，海量信息不断涌现。据统计，医疗数据的年增长率高达 30% 以上，2025 年，全球医疗数据量将达到 2314 艾字节（EB）。如此庞大的数…...

编程日记 2025/1/18 10:40:24

浅谈云计算15 | 存储可靠性技术（RAID）

存储可靠性技术一、存储可靠性需求1.1 数据完整性1.2 数据可用性1.3 故障容错性二、传统RAID技术剖析2.1 RAID 02.2 RAID 12.3 RAID 52.4 RAID 62.5 RAID 10 三、RAID 2.0技术3.1 RAID 2.0技术原理3.1.1 两层虚拟化管理模式3.1.2 数据分布与重构 3.2 RAID 2.0技术优势3.2.1 自…...

编程日记 2025/1/18 10:37:20

43.Textbox的数据绑定 C#例子 WPF例子

固定最简步骤，包括 XAML： 题头里引入命名空间标题下面引入类 box和block绑定属性 C#： 通知的类，及对应固定的任务引入字段引入属性属性双触发，其中一个更新block的属性 block>指向box的属性从Textbo…...

编程日记 2025/1/18 10:33:16

LLM大语言模型的分类

从架构和功能的角度来看，LLM（Large Language Model，大语言模型）主要可以分为以下几种类型： **1. 基础语言模型：** * **定义:** 通过在大规模文本数据上进行预训练，学习语言的规律和模式&#…...

编程日记 2025/1/18 10:27:08

【北京迅为】iTOP-4412全能版使用手册-第八十七章安装Android Studio

iTOP-4412全能版采用四核Cortex-A9，主频为1.4GHz-1.6GHz，配备S5M8767 电源管理，集成USB HUB,选用高品质板对板连接器稳定可靠，大厂生产，做工精良。接口一应俱全，开发更简单,搭载全网通4G、支持WIFI、蓝牙、…...

编程日记 2025/1/18 10:24:02

【深度学习】神经网络之Softmax

Softmax 函数是神经网络中常用的一种激活函数，尤其在分类问题中广泛应用。它将一个实数向量转换为概率分布，使得每个输出值都位于 [0, 1] 之间，并且所有输出值的和为 1。这样，Softmax 可以用来表示各类别的预测概率。 Softmax 函…...

编程日记 2025/1/18 10:19:56

容器渗透横向

本质上要获得 1.获得容器IP段 2.获得主机IP段 3.获得本机IP 4.通过CNI或Docker0等扫描本机端口 Flannel 容器信息 rootubuntu-linux-22-04-desktop:/home/parallels/Desktop# k get po -A -o wide NAMESPACE NAME …...

编程日记 2025/1/18 10:16:53

黑马Java面试教程_P1_导学与准备篇

系列博客目录文章目录系列博客目录导学Why?举例准备篇企业是如何筛选简历的(筛选简历的规则)HR如何筛选简历部门负责人筛选简历简历注意事项简历整体结构个人技能该如何描述项目该如何描述应届生该如何找到合适的练手项目项目来源找到项目后，如何深入学习项目…...

编程日记 2025/1/18 10:13:49

《自动驾驶与机器人中的SLAM技术》ch4：预积分学

目录 1 预积分的定义 2 预积分的测量模型 ( 预积分的测量值可由 IMU 的测量值积分得到 ) 2.1 旋转部分 2.2 速度部分 2.3 平移部分 2.4 将预积分测量和误差式代回最初的定义式 3 预积分的噪声模型和协方差矩阵 3.1 旋转部分 3.2 速度部分 3.3 平移部分 3.4 噪声项合并 4 零偏的…...

编程日记 2025/1/18 9:57:32