gin框架常用函数
前言
在学习gin框架时,发现官方文档并未对常用函数和方法作梳理,遂整理该篇文章
路由与启动
| 常用函数 | 主要作用和用法 |
|---|
| gin.Default() | 创建带日志和恢复中间件的默认引擎 |
| gin.New() | 创建不带默认中间件的空白引擎 |
| r.Run(":8080") | 启动服务并监听指定端口,如8080 |
| r.GET(), r.POST()等 | 分别定义处理GET、POST等请求的路由 |
| r.Group("/api") | 创建路由分组,用于组织具有共同前缀或中间件的路由 |
| r.Use(Logger()) | 使用全局中间件 |
请求参数获取
| 常用函数 | 主要作用和用法 |
|---|
| c.Query("name") | 获取URL查询参数(例如:/path?name=value) |
| c.PostForm("name") | 获取POST表单参数 |
| c.Param("id") | 获取路径参数(例如:路由为/user/:id,访问/user/123) |
| c.BindJSON(&userStruct) | 将请求体中的JSON数据绑定到结构体 |
| c.FormFile("file") | 获取上传的文件 |
响应渲染
| 常用函数 | 主要作用和用法 |
|---|
| c.String(200, "Hello") | 返回字符串响应 |
| c.JSON(200, gin.H{...}) | 返回JSON响应,gin.H是map[string]interface{}的快捷方式 |
| c.HTML(200, "index.html", data) | 渲染HTML模板 |
| c.File("/path/file") | 返回一个文件 |
| c.Redirect(301, "/new-url") | 重定向请求 |
上下文与控制
| 常用函数 | 主要作用和用法 |
|---|
| c.Next() | 在中间件中调用,执行后续中间件和处理函数 |
| c.Abort() | 在中间件中调用,阻止后续处理函数执行 |
| c.SetCookie(...) | 在客户端设置Cookie |
| c.Header("Key", "Value") | 设置HTTP响应头 |