安装与快速入门

相关源文件

• .github/workflows/gin.yml
• .golangci.yml
• README.md
• debug.go
• debug_test.go
• gin.go
• go.mod
• go.sum

本文档提供了安装 Gin Web 框架并创建您的第一个 Gin 应用程序的全面说明。它涵盖了先决条件、安装方法以及使用 Gin 创建和运行基本 HTTP 服务器的关键步骤。

先决条件

在安装 Gin 之前，请确保您的开发环境满足以下要求

• Go 1.23 或更高版本
• 正确配置的 Go 工作区

您可以通过以下方式验证您的 Go 安装

来源: go.mod3 README.md31-33

安装方法

在您的项目中安装 Gin 主要有两种方法。

方法一：使用 Go Modules（推荐）

如果您的项目使用 Go modules（建议所有新项目都使用），当您在代码中导入 Gin 并运行任何 Go 命令时，Gin 将被自动获取。

方法二：使用 Go Get

或者，您可以使用 go get 命令显式下载并安装 Gin。

来源: README.md35-47

安装流程

来源: README.md35-47 README.md49-71

创建您的第一个 Gin 应用程序

以下是如何创建一个响应 HTTP 请求的基本 Gin 应用程序

1. 创建一个新文件（例如，main.go）
2. 导入必要的包
3. 使用 gin.Default() 创建一个路由器
4. 添加路由和处理程序
5. 使用 router.Run() 启动服务器

一个最小的 Gin 应用程序如下所示

来源: README.md52-71

应用程序结构

来源: gin.go92-181 gin.go225-231 README.md52-71

关键组件

引擎

Engine 是 Gin 框架的核心。它包含了路由器、中间件，并用于处理 HTTP 请求。

有两种方法可以创建一个 Engine

1. gin.Default() - 创建一个 Engine，并预先附带 Logger 和 Recovery 中间件。这对于大多数应用程序来说是推荐的选择。
2. gin.New() - 创建一个不附带任何中间件的空白 Engine 实例。如果您想自定义中间件堆栈，请使用此方法。

路由器和路由

路由通过 Engine 或 RouterGroup 上的 HTTP 方法函数定义。

上下文

Context 包含了当前 HTTP 请求、响应和中间件状态的所有信息。它作为参数传递给处理程序和中间件。

来源: gin.go52-53 gin.go92-181 gin.go225-231

运行您的应用程序

默认 HTTP 服务器

运行 Gin 应用程序最简单的方法是使用 Run() 方法

自定义地址

您可以指定一个自定义地址

HTTPS 支持

对于 HTTPS，请使用 RunTLS() 方法

来源: gin.go514-529 gin.go531-545 README.md72-79

运行模式

Gin 有三种运行模式

模式	描述	用途
调试	开发默认模式，带有详细日志	gin.SetMode(gin.DebugMode)
发布	生产模式，日志最少以提高性能	gin.SetMode(gin.ReleaseMode)
测试	测试专用模式	gin.SetMode(gin.TestMode)

对于生产部署，推荐使用 Release 模式

或设置环境变量

来源: debug.go18-22 debug.go89-96

请求处理流程

来源: gin.go622-633 gin.go648-714

结论

您现在已经学会了如何安装 Gin 并创建一个基本的 Web 应用程序。这为使用 Gin 框架构建更复杂的 Web 服务奠定了基础。

有关特定功能的更详细信息，请参阅

• 核心架构，了解 Gin 的结构
• 中间件系统，了解如何集成中间件
• 请求处理，了解如何处理 HTTP 请求
• 响应渲染 以生成响应

其他资源

示例仓库

Gin 提供了一个包含各种用例示例应用程序的仓库：https://github.com/gin-gonic/examples

官方文档

有关全面的文档，请访问 Gin 网站或 Go 参考文档

• https://gin-gonic.cn/docs/
• https://pkg.go.dev/github.com/gin-gonic/gin

来源: README.md81-107