使用Gin框架搭建一個Go Web應用程序的方法詳解

更新時間：2023年08月14日 08:14:03 作者：starrySky

在本文中,我們將要實現一個簡單的 Web 應用程序,通過 Gin 框架來搭建,主要支持用戶注冊和登錄,用戶可以通過注冊賬戶的方式創(chuàng)建自己的賬號,并通過登錄功能進行身份驗證,感興趣的同學跟著小編一起來看看吧

1. 簡介

在本文中，我們將要實現一個簡單的 Web 應用程序，通過 Gin 框架來搭建。主要支持用戶注冊和登錄，用戶可以通過注冊賬戶的方式創(chuàng)建自己的賬號，并通過登錄功能進行身份驗證。

通過本文，你將掌握使用 Gin 框架搭建一個Web應用程序的基本步驟，同時也會了解到其中部分的基本原理，從而對Gin 搭建Web應用程序這個過程有更好的理解。

2. 基本說明

Gin 是 Go 語言的 Web 框架，具有高效、輕量級、靈活和應用的 HTTP 路由功能。使用 Gin 框架，我們可以為 HTTP 請求指定處理函數，即在接收到請求后，Gin 框架會根據請求路徑和請求方法找到對應的處理函數，并執(zhí)行相應的業(yè)務邏輯。

在使用 Gin 框架搭建 Web 應用程序時，我們需要實現兩個步驟，首先是啟動服務器并監(jiān)聽用戶請求。使用 Gin 框架啟動服務器非常簡單，只需要調用 gin.Default() 方法創(chuàng)建一個默認的 Gin 實例，然后使用該實例調用 Run() 方法啟動服務器即可。例如：

r := gin.Default()
r.Run()

接著需要給 HTTP 請求指定處理函數，在使用 Gin 框架搭建 Web 應用程序時，我們需要針對不同的請求路徑和請求方法指定處理函數。Gin 框架提供了多種方式來實現這一功能，最常用的是 gin.HandlerFunc 和 gin.RouterGroup，這里我們對gin.HandlerFunc 進行說明。

我們可以通過 gin.HandlerFunc 定義一個處理函數，然后使用 r.GET()、r.POST() 等方法將該處理函數綁定到對應的請求路徑和請求方法上。例如：

func registerHandler(c *gin.Context) {
    // 注冊邏輯...
}
func loginHandler(c *gin.Context) {
    // 登錄邏輯...
}
r := gin.Default()
r.GET("/register", registerHandler)
r.POST("/login", loginHandler)

在上述代碼中，我們定義了 registerHandler 和 loginHandler 兩個處理函數，并分別將它們綁定到 /register 和 /login 路徑上的 GET 和 POST 請求上。

綜上所述，使用 Gin 框架搭建 Web 應用程序需要實現兩個步驟：啟動服務器并監(jiān)聽用戶請求，給 HTTP 請求指定處理函數。通過 Gin 提供的 gin.HandlerFunc 和 gin.RouterGroup 方法，我們可以快速地完成上述任務。

3. 基本實現

通過上文的講述，我們已經了解了使用 Gin 框架搭建 Web 應用程序需要實現兩個步驟，我們基于此，實現一個能夠接收用戶注冊和登錄請求的 Web 應用程序，代碼示例如下:

import (
   "github.com/gin-gonic/gin"
   "net/http"
)
func main() {
   // 1. 通過gin.Default 創(chuàng)建一個gin.Engine 實例
   r := gin.Default()
   // 2. 通過gin.Engine 中的 GET/POST 設置路由
   r.GET("/register", func(c *gin.Context) {
      c.String(http.StatusOK, "注冊成功")
   })
   r.POST("/login", func(c *gin.Context) {
      // 處理用戶提交的數據
      //...
      // 返回響應結果
      c.JSON(http.StatusOK, gin.H{
         "message": "成功登錄",
      })
   })
   // 3. 啟動服務器
   r.Run(":8080")
}

上面示例代碼中，第8行通過gin.Default 方法創(chuàng)建一個gin.Engine 實例；第10行通過其提供的GET 方法進行路由注冊，也就是給請求指定處理函數，這里我們注冊了register 和 login 兩個路由，支持注冊和登錄；在23行處，調用gin.Engine 實例中的 Run 方法，啟動服務器同時監(jiān)聽本機的8080 端口。

該程序啟動之后，將監(jiān)聽8080 端口的請求，請求過來后，會根據路由規(guī)則的設置，執(zhí)行不同的業(yè)務邏輯。比如下面發(fā)起注冊請求:

 curl http://localhost:8080/register

此時將返回下面數據:

注冊成功

4. 原理解釋

4.1 路由規(guī)則的設置為什么還區(qū)分GET和POST方法

回看前面設置路由規(guī)則，可以發(fā)現其中既有GET 方法，又有 POST 方法，大概如下:

r := gin.Default()
r.GET("/register", func(c *gin.Context) {})
r.POST("/login", func(c *gin.Context) {})

為什么gin.Engine 設置路由時，既提供了GET 方法，也提供了POST 方法呢，這個有什么用途嗎?

這個其實是和HTTP協(xié)議相對應的，在 HTTP 協(xié)議中，常見的請求方法有 GET、POST、DELETE、PATCH、PUT、OPTIONS、HEAD 等。這些請求方法在語義和功能上有所不同，在實際應用中也會根據需要選擇不同的方法進行使用。

比方說，在HTTP協(xié)議中GET 方法一般用于讀取數據操作，而POST 方法一般用于創(chuàng)建或修改數據操作。

Gin 框架中，我們可以使用 GET、POST、DELETE、PATCH、PUT、OPTIONS、HEAD 等方法來定義相應的路由，用于處理不同類型的請求。Gin 會根據請求方法自動匹配對應的路由并調用相應的處理函數進行處理。通過區(qū)分不同請求方法，可以使代碼更加清晰和規(guī)范，并減少因請求沖突導致的錯誤。

下面舉一個例子來進行說明，假如我們定義了兩個相同URL的路由規(guī)則，但是一個使用GET方法來設置，該路由規(guī)則只會處理HTTP GET請求；而另外一個使用POST 方法來設置，該路由規(guī)則也只會處理HTTP POST請求。下面是一個代碼示例:

r := gin.Default()
r.GET("/hello", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
         "message": "hello GET",
    })
})
r.POST("/hello", func(c *gin.Context) {
    c.JSON(http.StatusOK, gin.H{
         "message": "hello POST",
    })
})

此時啟動服務器，然后客戶端向服務器發(fā)起HTTP GET請求，如下:

 curl -X GET http://localhost:8080/hello

此時將會返回以下數據，說明其映射到了GET 方法設置的路由規(guī)則:

{"message":"hello GET"}

4.2 路由規(guī)則是怎么存儲的

Gin 中路由規(guī)則的存儲，是通過前綴樹來實現的，然后對于GET ，POST 方法，會分別定義一顆前綴樹，互不干擾。下面舉一個例子來說，比如有下面這三個路由規(guī)則:

這里是三個 GET 請求的路由規(guī)則，此時會專門為GET 請求生成一顆前綴樹，這顆前綴樹包含上面的三個規(guī)則，如下:

                 (根節(jié)點)
                   /
                `/user`
                /    \
              `j`   `:id`
             /  \
          `ohn` `ane`

如果路由規(guī)則中，同時存在GET 和 POST 方法，此時會生成兩顆前綴樹，規(guī)則示例如下:

r.GET("/user/john", func(c *gin.Context) {})
r.GET("/user/jane", func(c *gin.Context) {})
r.GET("/user/:id", func(c *gin.Context) {})
r.POST("/user/john", func(c *gin.Context) {})
r.POST("/user/jane", func(c *gin.Context) {})

基于這個規(guī)則，會生成兩顆前綴樹，GET 路由規(guī)則和 POST 路由規(guī)則互不干擾:

               (GET根節(jié)點)                  (POST根節(jié)點)
                   /                           /
                `/user`                     `/user`
                /    \                        /
              `j`   `:id`                   `j` 
             /  \                          /  \
          `ohn` `ane`                   `ohn` `ane`

然后GET 請求，會到GET的前綴樹，根據對應路由規(guī)則找到請求的處理函數；而POST 請求則到POST 的前綴樹中，找到對應的處理函數，執(zhí)行對應的業(yè)務邏輯，二者互不干擾。