15-项目代码结构解析

发表于 | 更新于 | 分类于
本文字数： 8.5k | 阅读时长 ≈ 8 分钟

思考并回答以下问题：

实验介绍

本章开始我们将通过一个实战项目来掌握如何利用Gin框架从0到1开发一个简单的用户管理后台应用。本项目将涉及之前章节学习到的知识点，包括控制器（Controller）、路由（Router）、模版渲染（Template Rendering）等知识领域，另外将介绍如何排布Go语言项目代码结构。我们将从代码结构开始，由浅入深的一步一步开始项目实战。

知识点

  • 项目介绍
  • Gin项目代码结构

项目介绍

在这个Gin实战项目中，我们构建一个管理后台应用。该应用的主要目标是管理用户信息、权限设置和角色分配等重要功能。通过学习本课程，我们将学会使用Gin框架来构建高效的后端应用程序，并实现一个完整的项目界面。

在项目完成后，我们将拥有一个用户管理模块，能够轻松管理和维护用户信息。我们还将学习如何添加、编辑和删除用户，以及查看和搜索用户信息。另外，我们还将介绍登陆（Login）与认证（Authentication）模块，以确保应用的安全性。我们将学习如何实现用户身份验证和授权，以限制对敏感数据和功能的访问。通过使用Gin提供的身份验证中间件和安全策略，建立一个可靠的身份认证系统。

我们要实现的是一个管理后台，该应用用于管理用户信息。最终的项目完成界面会包括用户管理模块、登陆与认证模块。

Gin项目代码结构

Gin项目代码结构是我们在实战项目中需要关注的一个重要方面。通过良好的代码结构，我们可以使项目更加可维护、可扩展，并提高团队协作效率。以下我们将介绍一种常见的Gin项目代码结构，并解释每个目录和文件的作用。

1，main.go：这是我们的应用程序的入口文件，其中包含了启动Gin服务器的代码。在这个文件中，我们将初始化Gin实例，并配置路由和中间件。

2，routes/：这个目录用于存放路由相关的代码。我们可以在这里定义不同的路由组和处理函数，将不同的请求映射到对应的处理逻辑上。

3，handlers/：在这个目录下，我们将实现处理具体请求的处理函数。每个处理函数负责处理一个特定的路由，包括验证输入、处理业务逻辑和返回响应等操作。我们可以根据功能模块将处理函数进行组织，例如将用户管理相关的处理函数放在一个文件中。

4，models/：在这个目录中，我们将定义数据模型和数据库操作相关的代码。我们可以创建结构体来表示不同的数据实体，例如用户、角色和权限等。同时，我们还可以编写数据库操作的函数，用于创建、读取、更新和删除数据。

5，middlewares/：这个目录存放Gin中间件（Middleware），在其中我们将定义和实现各种中间件，例如身份验证中间件、日志中间件等。

6，utils/：这个目录用于存放一些通用的工具函数或辅助函数。这些函数可以在整个项目中被多个模块共享和复用，例如时间处理函数、加密函数等。

除了上述目录和文件，我们还可以根据需要添加其他目录和文件，例如静态文件目录、配置文件等。通过合理组织项目代码结构，我们可以使项目更具可读性、可维护性，并且能够快速定位和修改特定功能模块的代码。

实战练习

打开IDE，在项目根目录下创建go.mod，输入如下内容。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
module gin-project

go 1.19

require github.com/gin-gonic/gin v1.9.0

require (
    github.com/bytedance/sonic v1.8.0 // indirect
    github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
    github.com/gin-contrib/sse v0.1.0 // indirect
    github.com/go-playground/locales v0.14.1 // indirect
    github.com/go-playground/universal-translator v0.18.1 // indirect
    github.com/go-playground/validator/v10 v10.11.2 // indirect
    github.com/goccy/go-json v0.10.0 // indirect
    github.com/json-iterator/go v1.1.12 // indirect
    github.com/klauspost/cpuid/v2 v2.0.9 // indirect
    github.com/leodido/go-urn v1.2.1 // indirect
    github.com/mattn/go-isatty v0.0.17 // indirect
    github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
    github.com/modern-go/reflect2 v1.0.2 // indirect
    github.com/pelletier/go-toml/v2 v2.0.6 // indirect
    github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
    github.com/ugorji/go/codec v1.2.9 // indirect
    golang.org/x/arch v0.0.0-20210923205945-b76863e36670 // indirect
    golang.org/x/crypto v0.5.0 // indirect
    golang.org/x/net v0.7.0 // indirect
    golang.org/x/sys v0.5.0 // indirect
    golang.org/x/text v0.7.0 // indirect
    google.golang.org/protobuf v1.28.1 // indirect
    gopkg.in/yaml.v3 v3.0.1 // indirect
)

同时，创建main.go，输入如下内容。
1
2
3
4
5
6
7
8
9
10
11
package main

import "github.com/gin-gonic/gin"

func main() {
    // 创建 Gin 引擎
    app := gin.New()

    // 运行 Gin 引擎
    app.Run(":8080")
}

然后在终端中运行go mod tidy，可以看到生成了go.sum文件。

生成项目结构

接下来，我们需要按照要求生成项目的目录结构。请在IDE中创建如下对应的目录及文件。

1
2
3
4
5
6
7
8
9
10
11
- main.go                  // 应用程序的入口文件
- routes/                  // 路由相关的代码
  - user.go                  // 用户管理路
- handlers/                // 处理具体请求的处理函数
  - user.go                // 用户管理处理函数
- models/                  // 数据模型和数据库操作相关的代码
  - user.go                   // 用户数据模型和数据库操作
- middlewares/             // 中间件相关的代码
  - auth.go                // 身份验证中间件
  - log.go                 // 日志中间件
- utils/                   // 通用的工具函数或辅助函数

打开终端，输入tree .，可以得到如下内容。

实验总结

本实验介绍了本章的项目内容以及如何生成Gin框架的项目目录结构。在实战练习中，我们生成了入口文件main.go、路由目录routes/、处理函数目录handlers/、模型目录models/、中间件目录middlewares/以及工具函数目录utils/。这只是项目的基础代码结构，在后面的练习中，我们将以此为基础来填充相应的逻辑。

0%