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

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

news 2025/9/18 2:39:50

在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/ 目录:

​ 用于存放项目的配置文件或配置信息的读取和管理逻辑。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 函数是一个中间件，可以在请求处理前进行身份验证操作。

  • services/ 目录:

包含业务逻辑，通常是控制器和模型之间的业务处理逻辑。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/ 目录:

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

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

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

  • static/ 目录:

用于存放静态文件，例如 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篇&#xff0c;我们将讨论如何设置你的项目。这不仅仅是把文件扔得到处都是&#xff0c;而是要对所有东西的位置做出明智的选择。相信我&#xff0c;这些东西很重要。如果你做得对&#xff0c;你的项目会更容易处理。当你以后不再为了找东西或添加新功能而绞尽脑…...

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

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

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

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

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

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

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

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

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

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

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

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

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

Qt 程序 DPI 适配方法归纳

方案1&#xff1a;通过 Windows api 处理 缺点&#xff1a;放大之后界面会模糊。 通过调用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的随机播放顺序 问题描述 测试样例 解题思路&#xff1a; 问题理解 数据结构选择 算法步骤 最终代码&#xff1a; 运行结果&#xff1a; 二、 不同整数的计数问题 问题描述 测试样例 解题思路&#xff1a; 问题理解 数据结构选择 算法步骤 最终…...

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

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

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

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

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

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

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

参数校验 Spring Validation框架

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

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

Spring Boot 基础入门指南

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

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

doc、pdf转markdown

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

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

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

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

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

知识图谱入门（一）

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

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

springboot项目-基础数据回显

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

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

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

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

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

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

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

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

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

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

编程日记 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

python打卡day49

知识点回顾&#xff1a; 通道注意力模块复习空间注意力模块CBAM的定义 作业&#xff1a;尝试对今天的模型检查参数数目&#xff0c;并用tensorboard查看训练过程 import torch import torch.nn as nn# 定义通道注意力 class ChannelAttention(nn.Module):def __init__(self,…...

编程新知 2025/9/16 1:42:54

Admin.Net中的消息通信SignalR解释

定义集线器接口 IOnlineUserHub public interface IOnlineUserHub {/// 在线用户列表Task OnlineUserList(OnlineUserList context);/// 强制下线Task ForceOffline(object context);/// 发布站内消息Task PublicNotice(SysNotice context);/// 接收消息Task ReceiveMessage(…...

编程新知 2025/9/10 5:36:56

渗透实战PortSwigger靶场-XSS Lab 14：大多数标签和属性被阻止

<script>标签被拦截 我们需要把全部可用的 tag 和 event 进行暴力破解 XSS cheat sheet&#xff1a; https://portswigger.net/web-security/cross-site-scripting/cheat-sheet 通过爆破发现body可以用 再把全部 events 放进去爆破 这些 event 全部可用 <body onres…...

编程新知 2025/9/13 22:56:28

五年级数学知识边界总结思考-下册

目录 一、背景二、过程1.观察物体小学五年级下册“观察物体”知识点详解&#xff1a;由来、作用与意义**一、知识点核心内容****二、知识点的由来&#xff1a;从生活实践到数学抽象****三、知识的作用&#xff1a;解决实际问题的工具****四、学习的意义&#xff1a;培养核心素养…...

编程新知 2025/6/20 13:47:44

ArcGIS Pro制作水平横向图例+多级标注

今天介绍下载ArcGIS Pro中如何设置水平横向图例。 之前我们介绍了ArcGIS的横向图例制作&#xff1a;ArcGIS横向、多列图例、顺序重排、符号居中、批量更改图例符号等等&#xff08;ArcGIS出图图例8大技巧&#xff09;&#xff0c;那这次我们看看ArcGIS Pro如何更加快捷的操作。…...

编程新知 2025/9/12 23:22:10

网络编程（UDP编程）

思维导图 UDP基础编程&#xff08;单播&#xff09; 1.流程图 服务器&#xff1a;短信的接收方 创建套接字 (socket)-----------------------------------------》有手机指定网络信息-----------------------------------------------》有号码绑定套接字 (bind)--------------…...

编程新知 2025/9/12 23:22:08

动态 Web 开发技术入门篇

一、HTTP 协议核心 1.1 HTTP 基础 协议全称 &#xff1a;HyperText Transfer Protocol&#xff08;超文本传输协议&#xff09; 默认端口 &#xff1a;HTTP 使用 80 端口&#xff0c;HTTPS 使用 443 端口。 请求方法 &#xff1a; GET &#xff1a;用于获取资源&#xff0c;…...

编程新知 2025/8/25 4:55:24

FFmpeg avformat_open_input函数分析

函数内部的总体流程如下&#xff1a; avformat_open_input 精简后的代码如下&#xff1a; int avformat_open_input(AVFormatContext **ps, const char *filename,ff_const59 AVInputFormat *fmt, AVDictionary **options) {AVFormatContext *s *ps;int i, ret 0;AVDictio…...

编程新知 2025/9/7 8:47:45

解析两阶段提交与三阶段提交的核心差异及MySQL实现方案

引言 在分布式系统的事务处理中&#xff0c;如何保障跨节点数据操作的一致性始终是核心挑战。经典的两阶段提交协议&#xff08;2PC&#xff09;通过准备阶段与提交阶段的协调机制&#xff0c;以同步决策模式确保事务原子性。其改进版本三阶段提交协议&#xff08;3PC&#xf…...

编程新知 2025/9/2 16:23:08

WebRTC调研

WebRTC是什么&#xff0c;为什么&#xff0c;如何使用 WebRTC有什么优势 WebRTC Architecture Amazon KVS WebRTC 其它厂商WebRTC 海康门禁WebRTC 海康门禁其他界面整理 威视通WebRTC 局域网 Google浏览器 Microsoft Edge 公网 RTSP RTMP NVR ONVIF SIP SRT WebRTC协…...

编程新知 2025/9/7 8:45:57