文章目錄
- 一、了解gin
- 二、html渲染
- 三、gin中get/post獲取值
- 四、路由分組
- 五、中間件
- 六、文件上傳
- 七、gin中的cookie
一、了解gin
Gin 是一個用 Golang編寫的 高性能的web 框架, 由于http路由的優化,速度提高了近 40 倍。 Gin的特
點就是封裝優雅、API友好。
特性類別 | 具體說明 |
---|---|
性能表現 | 基于 Radix 樹實現路由,匹配速度極快,性能接近原生 Go HTTP 服務器 |
API 設計 | 接口簡潔直觀,學習成本低,如 gin.Default() 快速創建實例,GET() / POST() 注冊路由 |
中間件支持 | 內置日志、恢復 panic、靜態文件服務等中間件,支持自定義中間件實現擴展功能 |
路由管理 | 支持路由分組(Group),便于按模塊 / 版本 / 權限組織路由(如 /v1/* 、/admin/* ) |
參數處理 | 提供便捷的請求參數綁定(ShouldBind),支持 JSON / 表單 / Query 等格式,可配合標簽驗證 |
數據響應 | 內置高效 JSON 處理,c.JSON() 快速返回 JSON 響應,性能優于標準庫 |
錯誤處理 | 簡化異常處理流程,c.AbortWithError() 等方法可快速返回結構化錯誤響應 |
模板渲染 | 集成 HTML 模板引擎,支持模板繼承、自定義函數,適合傳統 Web 應用開發 |
擴展性 | 設計靈活,易于與 ORM、緩存、認證等工具集成,生態豐富 |
輕量特性 | 核心代碼簡潔,依賴少,編譯后二進制體積小,適合微服務或輕量應用 |
下載gin包
go get -u github.com/gin-gonic/gin
測試一下
package main
import "github.com/gin-gonic/gin"
func main() {router := gin.Default()router.GET("/", func(c *gin.Context) {c.JSON(200, map[string]interface{}{"name": "彪子","age": 15,})})router.Run(":8080") // 不寫默認,8080,監聽并在 0.0.0.0:8080 上啟動服務
}
①返回字符串
package main
import "github.com/gin-gonic/gin"
func main() {router := gin.Default()// 類似printf的寫法router.GET("/", func(c *gin.Context) {c.String(200, "我的值為:%v", "啊啊啊")})router.Run(":8080") // 不寫默認,8080,監聽并在 0.0.0.0:8080 上啟動服務
}
②返回json
package main
import "github.com/gin-gonic/gin"
func main() {router := gin.Default()router.GET("/", func(c *gin.Context) {c.JSON(200, map[string]interface{}{"name": "彪子","age": 15,})})router.Run(":8080") // 不寫默認,8080,監聽并在 0.0.0.0:8080 上啟動服務
}
或者可以將map類型用gin自帶的,和我們寫的一樣
router.GET("/", func(c *gin.Context) {c.JSON(200,gin.H{"name": "彪子","age": 15,})})
也可以使用結構體
package main
import ("github.com/gin-gonic/gin"
)
type Ariticle struct {Title stringContent string
}
func main() {router := gin.Default()router.LoadHTMLGlob("templates/*") //配置模板文件router.GET("/", func(c *gin.Context) {article := &Ariticle{Title: "這是標題",Content: "這是內容",}c.JSON(200, article)})router.Run(":8080") // 不寫默認,8080,監聽并在 0.0.0.0:8080 上啟動服務
}
二、html渲染
除了上訴的返回字符串和json數據,我們也可以渲染html。
如果模板目錄下存在多個目錄,每個目錄下含有不同的html文件,那么我們這樣操作
在html定義值
{{ $title := .Title }}
<h1>{{ $title }}</h1>
{{ $sum := 10 + 20 }}
<p>總和:{{ $sum }}</p>
注釋
{{/* 這是模板注釋,瀏覽器中看不到 */}}
條件判斷
{{ if .IsLogin }}
<p>歡迎回來,{{ .Username }}</p>
{{ else }}
<a href="/login">請登錄</a>
{{ end }}
<!-- 否定判斷 -->
{{ if not .IsEmpty }}
<p>內容不為空</p>
{{ end }}
循環遍歷
<!-- 遍歷切片/數組 -->
<ul>
{{ range .Items }}<li>{{ . }}</li> <!-- 內部的 . 代表當前元素 -->
{{ end }}
</ul><!-- 帶索引的遍歷 -->
<!-- 使用 {{ . }} 時注意上下文變化(如在 range 內部,. 代表當前元素) -->
{{ range $index, $item := .Items }}<p>{{ $index }}: {{ $item.Name }}</p>
{{ end }}<!-- 遍歷映射 -->
{{ range $key, $value := .UserInfo }}<p>{{ $key }}: {{ $value }}</p>
{{ end }}<!-- 空集合處理 -->
{{ range .Items }}<li>{{ . }}</li>
{{ else }}<p>沒有數據</p> <!-- 當集合為空時執行 -->
{{ end }}
原始html輸出
<!-- 假設 .Content 包含 <strong>文本</strong> -->
{{ .Content }} <!-- 輸出:<strong>文本</strong> -->
{{ .Content | safeHTML }} <!-- 輸出:<strong>文本</strong> -->
三、gin中get/post獲取值
get請求
name:=c.Query("name")
age:=c.DefaultQuery("age","18")
post請求
name := c.PostForm("name")
age := c.DefaultPostForm("age", "18") // 默認值為string類型
將get/post請求的值綁定都按結構體
package mainimport ("net/http""github.com/gin-gonic/gin"
)
// 定義接收參數的結構體
type UserQuery struct {// form標簽指定對應的查詢參數名Name string `form:"name"`Page int `form:"page" binding:"default=1"` // 默認值1
}
func main() {r := gin.Default()// 注冊路由r.GET("/user", func(c *gin.Context) {var query UserQuery// 綁定GET請求參數到結構體if err := c.ShouldBindQuery(&query); err == nil {// 綁定成功,使用參數c.JSON(http.StatusOK, query)return}})// 啟動服務r.Run(":8080")
}
動態路由傳值
package mainimport ("net/http""github.com/gin-gonic/gin"
)
func main() {r := gin.Default()// 注冊路由r.GET("/:uid", func(c *gin.Context) {uid:=c.Param("uid")// 綁定GET請求參數到結構體c.String(http.StatusOK, "uid: %s", uid)})// 啟動服務r.Run(":8080")
}
四、路由分組
package mainimport ("net/http""github.com/gin-gonic/gin"
)
func main() {r := gin.Default()// 1. 基礎路由分組 - 添加路徑前綴userGroup := r.Group("/user"){// 實際路徑: /useruserGroup.GET("", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "用戶列表"})})// 實際路徑: /user/:iduserGroup.GET("/:id", func(c *gin.Context) {id := c.Param("id")c.JSON(http.StatusOK, gin.H{"message": "查看用戶", "id": id})})// 實際路徑: /user/createuserGroup.POST("/create", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "創建用戶"})})}// 2. 帶中間件的路由分組// 創建需要身份驗證的路由分組authGroup := r.Group("/admin")// 為該分組添加中間件(如身份驗證)authGroup.Use(AuthMiddleware()){// 實際路徑: /admin/dashboard,訪問前會經過AuthMiddleware驗證authGroup.GET("/dashboard", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "管理員面板"})})// 實際路徑: /admin/settingsauthGroup.GET("/settings", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "系統設置"})})}// 3. 嵌套路由分組v1 := r.Group("/api/v1"){// 嵌套用戶分組,實際路徑: /api/v1/usersusers := v1.Group("/users"){users.GET("", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "API v1 用戶列表"})})}// 嵌套文章分組,實際路徑: /api/v1/articlesarticles := v1.Group("/articles"){articles.GET("", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "API v1 文章列表"})})}}r.Run(":8080")
}
// 定義一個身份驗證中間件示例
func AuthMiddleware() gin.HandlerFunc {return func(c *gin.Context) {// 實際應用中這里會驗證token或sessiontoken := c.GetHeader("Authorization")if token == "" {c.JSON(http.StatusUnauthorized, gin.H{"error": "未授權訪問"})c.Abort() // 終止請求處理鏈return}// 驗證通過,繼續處理請求c.Next()}
}
如果把不同路由放到不同文件
五、中間件
c.Next() 的核心作用
流程控制:在中間件中調用 c.Next() 會暫停當前中間件的執行,先執行后續的中間件或路由處理器。
前后置操作: c.Next() 調用前的代碼可以視為 “前置操作”(如權限驗證、日志記錄開始),調用后的代碼可以視為 “后置操作”(如日志記錄結束、響應處理)。
全局中間件:可以使后續的所有請求都走此中間件
func main() {r := gin.Default()r.Use(mid1, mid2)// 實際路徑: /userr.GET("/", func(c *gin.Context) {c.JSON(http.StatusOK, gin.H{"message": "成功"})})r.Run(":8080")
}
在分組路由后配置中間件的兩種方式
// 方式1
a:=r.Group("admin",mid1, mid2)
// 方式2
a:=r.Group("admin")
a.Use(mid1, mid2)
在不同中間件傳遞值
gin中間件中使用grountine
六、文件上傳
單個文件上傳
package mainimport ("net/http""os""path/filepath""github.com/gin-gonic/gin"
)func main() {r := gin.Default()// 單個文件上傳r.POST("/upload", func(c *gin.Context) {// 獲取上傳的文件file, err := c.FormFile("file")if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": "獲取文件失敗: " + err.Error(),})return}// 定義保存路徑(當前目錄下的uploads文件夾)savePath := "./uploads"// 確保保存目錄存在if err := ensureDir(savePath); err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": "創建保存目錄失敗: " + err.Error(),})return}// 構建完整的保存路徑(目錄+文件名)dst := filepath.Join(savePath, file.Filename)// 使用SaveUploadedFile保存文件if err := c.SaveUploadedFile(file, dst); err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": "保存文件失敗: " + err.Error(),})return}c.JSON(http.StatusOK, gin.H{"message": "文件上傳成功","filename": file.Filename,"savePath": dst,})})r.Run(":8080")
}// 確保目錄存在,不存在則創建
func ensureDir(dir string) error {if _, err := os.Stat(dir); os.IsNotExist(err) {return os.MkdirAll(dir, 0755)}return nil
}
多文件上傳
package mainimport ("net/http""os""path/filepath""github.com/gin-gonic/gin"
)func main() {r := gin.Default()// 多個文件上傳r.POST("/upload-multiple", func(c *gin.Context) {// 解析多部分表單form, err := c.MultipartForm()if err != nil {c.JSON(http.StatusBadRequest, gin.H{"error": "解析表單失敗: " + err.Error(),})return}// 獲取所有名為"file"的文件files := form.File["file"]if len(files) == 0 {c.JSON(http.StatusBadRequest, gin.H{"error": "未找到上傳的文件",})return}// 定義保存路徑savePath := "./uploads"if err := ensureDir(savePath); err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": "創建保存目錄失敗: " + err.Error(),})return}// 保存所有文件uploadedFiles := make([]string, 0, len(files))for _, file := range files {dst := filepath.Join(savePath, file.Filename)if err := c.SaveUploadedFile(file, dst); err != nil {c.JSON(http.StatusInternalServerError, gin.H{"error": "保存文件 " + file.Filename + " 失敗: " + err.Error(),})return}uploadedFiles = append(uploadedFiles, file.Filename)}c.JSON(http.StatusOK, gin.H{"message": "所有文件上傳成功","fileCount": len(uploadedFiles),"filenames": uploadedFiles,})})r.Run(":8080")
}// 確保目錄存在,不存在則創建
func ensureDir(dir string) error {if _, err := os.Stat(dir); os.IsNotExist(err) {return os.MkdirAll(dir, 0755)}return nil
}
七、gin中的cookie
package mainimport ("net/http""strings""github.com/gin-gonic/gin"
)func main() {r := gin.Default()// 設置Cookier.GET("/set_cookie", func(c *gin.Context) {// 設置一個名為"username",值為"JohnDoe",1小時后過期的Cookiec.SetCookie("username", "JohnDoe", 3600, "/", "example.com", false, true)c.JSON(http.StatusOK, gin.H{"message": "Cookie set successfully"})})// 獲取 Cookier.GET("/get_cookie", func(c *gin.Context) {cookie, err := c.Cookie("username")if err != nil {c.JSON(http.StatusOK, gin.H{"message": "Cookie not found", "error": err.Error()})return}c.JSON(http.StatusOK, gin.H{"message": "Cookie retrieved successfully", "username": cookie})})//刪除 Cookier.GET("/delete_cookie", func(c *gin.Context) {// 將過期時間設置為1小時前,以達到刪除Cookie的效果c.SetCookie("username", "", -3600, "/", "example.com", false, true)c.JSON(http.StatusOK, gin.H{"message": "Cookie deleted successfully"})})// 遍歷Cookier.GET("/list_cookies", func(c *gin.Context) {cookies := c.Request.Cookies()var cookieList []stringfor _, cookie := range cookies {cookieList = append(cookieList, cookie.Name+"="+cookie.Value)}c.JSON(http.StatusOK, gin.H{"message": "List of cookies", "cookies": strings.Join(cookieList, ", ")})})r.Run(":8080")
}