vault backup: 2026-06-07 12:14:39
This commit is contained in:
+97
-279
@@ -1,362 +1,180 @@
|
||||
---
|
||||
tags:
|
||||
- Go
|
||||
- golang
|
||||
- gin
|
||||
- web框架
|
||||
- http
|
||||
tags: [go, golang, gin, Web框架, HTTP]
|
||||
create time: 2026-06-07 15:20
|
||||
---
|
||||
|
||||
# Gin
|
||||
|
||||
Gin是一个用Go语言编写的高性能Web框架，以其高效的路由系统和优秀的性能著称。本文将详细介绍如何使用Gin框架开发Web应用。
|
||||
## 概述
|
||||
|
||||
## 安装Gin
|
||||
Gin 是 Go 生态中最流行的 Web 框架，以高性能路由和简洁的 API 著称。本文从基础用法到中间件、分组路由，覆盖构建 RESTful API 的核心技能。
|
||||
|
||||
首先，我们需要安装Gin框架。可以使用以下命令：
|
||||
## 正文
|
||||
|
||||
### 安装
|
||||
|
||||
```bash
|
||||
go get -u github.com/gin-gonic/gin
|
||||
```
|
||||
|
||||
## 基本使用
|
||||
### 快速开始
|
||||
|
||||
### 创建HTTP服务器
|
||||
> [!question] 💭 思考
|
||||
> 如果让你从零实现一个 HTTP 服务器，需要处理哪些事情？（路由匹配、请求解析、响应格式化……）
|
||||
|
||||
使用Gin创建一个基本的HTTP服务器非常简单：
|
||||
Gin 封装了这些底层细节，让你专注于业务逻辑：
|
||||
|
||||
```go
|
||||
package main
|
||||
r := gin.Default() // 创建默认引擎（含 Logger + Recovery 中间件）
|
||||
|
||||
import (
|
||||
"github.com/gin-gonic/gin"
|
||||
"net/http"
|
||||
)
|
||||
r.GET("/ping", func(c *gin.Context) {
|
||||
c.JSON(200, gin.H{"message": "pong"})
|
||||
})
|
||||
|
||||
func main() {
|
||||
// 创建默认的路由引擎
|
||||
r := gin.Default()
|
||||
|
||||
// 注册一个GET路由
|
||||
r.GET("/ping", func(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": "pong",
|
||||
})
|
||||
})
|
||||
|
||||
// 启动HTTP服务，默认在0.0.0.0:8080启动服务
|
||||
r.Run()
|
||||
}
|
||||
r.Run(":8080") // 监听 8080 端口
|
||||
```
|
||||
|
||||
### 路由参数
|
||||
> [!tip] 💡 Default vs New
|
||||
> - `gin.New()`：纯引擎，无日志和恢复中间件
|
||||
> - `gin.Default()`：预装 Logger 和 Recovery，生产环境推荐
|
||||
> - Recovery 中间件会自动 recover panic，避免服务崩溃
|
||||
|
||||
Gin支持多种路由参数形式：
|
||||
### 路由与参数
|
||||
|
||||
#### 路径参数
|
||||
|
||||
```go
|
||||
// 获取get请求的路径参数，参数名为name
|
||||
r.GET("/user/:name", func(c *gin.Context) {
|
||||
name := c.Param("name")
|
||||
c.String(http.StatusOK, "Hello %s", name)
|
||||
})
|
||||
|
||||
// 获取get请求的路径参数，参数名为name，age，age的默认值为20
|
||||
r.GET("/users", func(c *gin.Context) {
|
||||
name := c.Query("name") // 获取name参数
|
||||
age := c.DefaultQuery("age", "20") // 获取age参数，默认值为20
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"name": name,
|
||||
"age": age,
|
||||
})
|
||||
name := c.Param("name") // 获取 :name 的值
|
||||
c.String(200, "Hello %s", name)
|
||||
})
|
||||
```
|
||||
|
||||
### 处理表单数据
|
||||
|
||||
Gin可以轻松处理POST请求中的表单数据：
|
||||
#### Query 参数
|
||||
|
||||
```go
|
||||
r.POST("/form", func(c *gin.Context) {
|
||||
// 获取表单参数
|
||||
username := c.PostForm("username")
|
||||
password := c.DefaultPostForm("password", "")
|
||||
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"username": username,
|
||||
"password": password,
|
||||
})
|
||||
r.GET("/search", func(c *gin.Context) {
|
||||
q := c.Query("q", "") // 获取 ?q=xxx，默认值 ""
|
||||
page := c.DefaultQuery("page", "1") // 带默认值
|
||||
c.JSON(200, gin.H{"query": q, "page": page})
|
||||
})
|
||||
```
|
||||
|
||||
### 处理JSON数据
|
||||
|
||||
Gin可以轻松处理POST请求中的JSON数据：
|
||||
#### POST 表单 / JSON
|
||||
|
||||
```go
|
||||
// 定义请求体结构
|
||||
type LoginRequest struct {
|
||||
Username string `json:"username" binding:"required"`
|
||||
Password string `json:"password" binding:"required"`
|
||||
}
|
||||
|
||||
r.POST("/login", func(c *gin.Context) {
|
||||
var login LoginRequest
|
||||
|
||||
// 将请求体绑定到结构体
|
||||
if err := c.BindJSON(&login); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"error": err.Error(),
|
||||
})
|
||||
var req LoginRequest
|
||||
if err := c.ShouldBindJSON(&req); err != nil {
|
||||
c.JSON(400, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
// 处理登录逻辑
|
||||
c.JSON(http.StatusOK, gin.H{
|
||||
"message": "登录成功",
|
||||
"username": login.Username,
|
||||
})
|
||||
})
|
||||
|
||||
// 也可以直接使用map接收JSON数据
|
||||
r.POST("/raw", func(c *gin.Context) {
|
||||
var data map[string]interface{}
|
||||
|
||||
if err := c.BindJSON(&data); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{
|
||||
"error": err.Error(),
|
||||
})
|
||||
return
|
||||
}
|
||||
|
||||
c.JSON(http.StatusOK, data)
|
||||
// 处理登录...
|
||||
c.JSON(200, gin.H{"message": "ok"})
|
||||
})
|
||||
```
|
||||
|
||||
在上面的示例中：
|
||||
1. 使用结构体接收JSON数据时，可以通过tag来指定字段的验证规则
|
||||
2. `binding:"required"`表示该字段是必需的
|
||||
3. 也可以使用map来接收不固定结构的JSON数据
|
||||
4. `c.BindJSON()`会自动检查Content-Type是否为application/json
|
||||
|
||||
### 上传文件
|
||||
|
||||
Gin支持单文件和多文件上传：
|
||||
|
||||
```go
|
||||
// 单文件上传
|
||||
r.POST("/upload", func(c *gin.Context) {
|
||||
file, _ := c.FormFile("file")
|
||||
|
||||
// 保存文件
|
||||
c.SaveUploadedFile(file, "./"+file.Filename)
|
||||
|
||||
c.String(http.StatusOK, "File %s uploaded successfully", file.Filename)
|
||||
})
|
||||
|
||||
// 多文件上传
|
||||
r.POST("/uploads", func(c *gin.Context) {
|
||||
form, _ := c.MultipartForm()
|
||||
files := form.File["files"]
|
||||
|
||||
for _, file := range files {
|
||||
c.SaveUploadedFile(file, "./"+file.Filename)
|
||||
}
|
||||
|
||||
c.String(http.StatusOK, "%d files uploaded successfully", len(files))
|
||||
})
|
||||
```
|
||||
> [!warning] ⚠️ 绑定注意事项
|
||||
> - `ShouldBindJSON` 仅在 Content-Type 为 `application/json` 时生效
|
||||
> - `binding:"required"` 由内置验证器检查字段是否为空
|
||||
> - 对于复杂验证需求，建议使用 `github.com/go-playground/validator`
|
||||
|
||||
### 中间件
|
||||
|
||||
Gin的中间件可以在请求处理过程中执行一些公共的操作：
|
||||
> [!question] 💭 思考
|
||||
> 如果你的 API 需要对所有请求做日志记录、鉴权、CORS 处理，在每个 handler 里重复写代码合理吗？
|
||||
|
||||
中间件是横切关注点的标准解决方案——它在请求到达 handler **之前**和返回响应**之后**执行：
|
||||
|
||||
```go
|
||||
// 定义一个中间件
|
||||
func Logger() gin.HandlerFunc {
|
||||
// 自定义中间件
|
||||
func RequestID() gin.HandlerFunc {
|
||||
return func(c *gin.Context) {
|
||||
t := time.Now()
|
||||
|
||||
// 在请求之前
|
||||
|
||||
c.Next()
|
||||
|
||||
// 在请求之后
|
||||
latency := time.Since(t)
|
||||
log.Printf("请求处理时间: %v", latency)
|
||||
id := uuid.New().String()
|
||||
c.Set("requestID", id) // 存入上下文
|
||||
c.Header("X-Request-ID", id)
|
||||
c.Next() // ✅ 必须调用，继续处理后续中间件/handler
|
||||
// 这里可以记录耗时等后处理逻辑
|
||||
}
|
||||
}
|
||||
|
||||
// 使用中间件
|
||||
r.Use(Logger())
|
||||
// 注册方式
|
||||
r.Use(RequestID()) // 全局中间件
|
||||
r.GET("/api", MyHandler) // 受中间件保护
|
||||
```
|
||||
|
||||
### 分组路由
|
||||
> [!info] ℹ️ 中间件执行顺序
|
||||
> 先注册的先执行（类似洋葱模型）：
|
||||
> ```
|
||||
> 请求 → Logger → Auth → CORS → Handler
|
||||
> 响应 ← Logger ← Auth ← CORS ← Handler
|
||||
> ```
|
||||
|
||||
Gin支持路由分组，可以更好地组织API：
|
||||
#### 分组路由
|
||||
|
||||
```go
|
||||
// 创建v1版本的路由组
|
||||
v1 := r.Group("/v1")
|
||||
v1 := r.Group("/api/v1")
|
||||
{
|
||||
v1.POST("/login", loginEndpoint)
|
||||
v1.POST("/submit", submitEndpoint)
|
||||
v1.POST("/read", readEndpoint)
|
||||
v1.GET("/users", getUsers)
|
||||
v1.POST("/users", createUser)
|
||||
v1.PUT("/users/:id", updateUser)
|
||||
v1.DELETE("/users/:id", deleteUser)
|
||||
}
|
||||
|
||||
// 创建v2版本的路由组
|
||||
v2 := r.Group("/v2")
|
||||
{
|
||||
v2.POST("/login", loginEndpointV2)
|
||||
v2.POST("/submit", submitEndpointV2)
|
||||
v2.POST("/read", readEndpointV2)
|
||||
}
|
||||
// 为组注册中间件
|
||||
authGroup := r.Group("/api", AuthMiddleware())
|
||||
```
|
||||
|
||||
## 完整示例
|
||||
|
||||
以下是一个完整的示例，展示了如何使用Gin框架创建一个简单的RESTful API服务：
|
||||
### RESTful 完整示例
|
||||
|
||||
```go
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/gin-gonic/gin"
|
||||
"log"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
// User 用户模型
|
||||
type User struct {
|
||||
ID int `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Age int `json:"age"`
|
||||
}
|
||||
|
||||
// 模拟数据库
|
||||
var users = []User{
|
||||
{ID: 1, Name: "张三", Age: 25},
|
||||
{ID: 2, Name: "李四", Age: 30},
|
||||
}
|
||||
var users []User
|
||||
|
||||
func main() {
|
||||
// 创建默认的路由引擎
|
||||
r := gin.Default()
|
||||
|
||||
// 注册路由
|
||||
r.GET("/users", getUsers)
|
||||
r.GET("/users/:id", getUserByID) // 这里的冒号表示路径参数,可以通过c.Param("id")获取
|
||||
r.POST("/users", createUser)
|
||||
r.PUT("/users/:id", updateUser)
|
||||
r.DELETE("/users/:id", deleteUser)
|
||||
|
||||
// 启动http服务器，监听8080端口
|
||||
if err := r.Run(":8080"); err != nil {
|
||||
log.Fatalf("Server error: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// 获取所有用户
|
||||
func getUsers(c *gin.Context) {
|
||||
c.JSON(http.StatusOK, users)
|
||||
}
|
||||
|
||||
// 根据ID获取用户
|
||||
func getUserByID(c *gin.Context) {
|
||||
id := c.Param("id")
|
||||
for _, user := range users {
|
||||
if string(user.ID) == id {
|
||||
c.JSON(http.StatusOK, user)
|
||||
return
|
||||
r.GET("/users", func(c *gin.Context) {
|
||||
c.JSON(200, users)
|
||||
})
|
||||
r.GET("/users/:id", func(c *gin.Context) {
|
||||
id, _ := strconv.Atoi(c.Param("id"))
|
||||
for _, u := range users {
|
||||
if u.ID == id {
|
||||
c.JSON(200, u)
|
||||
return
|
||||
}
|
||||
}
|
||||
}
|
||||
c.JSON(http.StatusNotFound, gin.H{"message": "User not found"})
|
||||
}
|
||||
c.JSON(404, gin.H{"error": "not found"})
|
||||
})
|
||||
r.POST("/users", func(c *gin.Context) {
|
||||
var u User
|
||||
c.ShouldBindJSON(&u)
|
||||
u.ID = len(users) + 1
|
||||
users = append(users, u)
|
||||
c.JSON(201, u)
|
||||
})
|
||||
|
||||
// 创建用户
|
||||
func createUser(c *gin.Context) {
|
||||
var newUser User
|
||||
if err := c.BindJSON(&newUser); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
users = append(users, newUser)
|
||||
c.JSON(http.StatusCreated, newUser)
|
||||
}
|
||||
|
||||
// 更新用户
|
||||
func updateUser(c *gin.Context) {
|
||||
// 获取路径参数中的ID
|
||||
id := c.Param("id")
|
||||
var updatedUser User
|
||||
|
||||
// 绑定请求体中的JSON数据到updatedUser
|
||||
if err := c.BindJSON(&updatedUser); err != nil {
|
||||
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
|
||||
return
|
||||
}
|
||||
|
||||
for i, user := range users {
|
||||
if string(user.ID) == id {
|
||||
users[i] = updatedUser
|
||||
c.JSON(http.StatusOK, updatedUser)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
c.JSON(http.StatusNotFound, gin.H{"message": "User not found"})
|
||||
}
|
||||
|
||||
// 删除用户
|
||||
func deleteUser(c *gin.Context) {
|
||||
id := c.Param("id")
|
||||
for i, user := range users {
|
||||
if string(user.ID) == id {
|
||||
users = append(users[:i], users[i+1:]...)
|
||||
c.JSON(http.StatusOK, gin.H{"message": "User deleted"})
|
||||
return
|
||||
}
|
||||
}
|
||||
c.JSON(http.StatusNotFound, gin.H{"message": "User not found"})
|
||||
r.Run(":8080")
|
||||
}
|
||||
```
|
||||
|
||||
### 程序测试
|
||||
> [!tip] 💡 性能提示
|
||||
> - `gin.H` 是 `map[string]interface{}` 的别名，在高频场景中考虑使用自定义结构体替代，减少反射开销
|
||||
> - 启用 Gzip 压缩：`r.Use(gzip.Gzip(gzip.DefaultCompression))`
|
||||
> - 生产环境建议关闭 Debug 模式：`gin.SetMode(gin.ReleaseMode)`
|
||||
|
||||
使用curl命令测试API：
|
||||
## 关联笔记
|
||||
|
||||
```bash
|
||||
# 获取所有用户
|
||||
curl http://localhost:8080/users
|
||||
|
||||
# 获取指定用户
|
||||
curl http://localhost:8080/users/1
|
||||
|
||||
# 创建用户
|
||||
curl -X POST -H "Content-Type: application/json" -d '{"id":3,"name":"王五","age":35}' http://localhost:8080/users
|
||||
|
||||
# 更新用户
|
||||
curl -X PUT -H "Content-Type: application/json" -d '{"id":1,"name":"张三丰","age":26}' http://localhost:8080/users/1
|
||||
|
||||
# 删除用户
|
||||
curl -X DELETE http://localhost:8080/users/2
|
||||
```
|
||||
|
||||
### 代码说明
|
||||
|
||||
1. **路由设置**：使用`gin.Default()`创建路由引擎，并注册了基本的RESTful API路由。
|
||||
|
||||
2. **数据模型**：定义了`User`结构体作为数据模型，并使用切片模拟数据库存储。
|
||||
|
||||
3. **请求处理**：实现了增删改查(CRUD)的基本操作，包括：
|
||||
- GET /users：获取所有用户
|
||||
- GET /users/:id：获取指定用户
|
||||
- POST /users：创建新用户
|
||||
- PUT /users/:id：更新用户
|
||||
- DELETE /users/:id：删除用户
|
||||
|
||||
4. **错误处理**：对各种可能的错误情况进行了处理，并返回适当的HTTP状态码。
|
||||
|
||||
## 小结
|
||||
|
||||
这篇文章简单介绍了Gin框架的基本使用方法，包括路由配置、参数获取、中间件使用等内容。如需了解Gin框架更详细的用法，可以参考：[Gin框架官方文档](https://gin-gonic.com/zh-cn/docs/)
|
||||
- [[hzh/GolangStar/Go语言框架/gorm]] — Gin + GORM 是全栈开发的经典组合
|
||||
- [[hzh/GolangStar/Go语言进阶/Context]] — HTTP 请求天然适合用 context 控制超时和取消
|
||||
|
||||
Reference in New Issue
Block a user