Go学习第十三章——Gin入门与路由

Go web框架——Gin入门与路由

- 1 Gin框架介绍
- - 1.1 基础介绍
  - 1.2 安装Gin
  - 1.3 快速使用
- 2 路由
- - 2.1 基本路由
  - - GET请求
    - POST请求
  - 2.2 路由参数
  - 2.3 路由分组
  - - 基本分组
    - 带中间件的分组
  - 2.4 重定向

1 Gin框架介绍

github链接：https://github.com/gin-gonic/gin

中文文档：https://gin-gonic.com/zh-cn/docs/

学习链接（博主在bilibili有视频）：http://www.fengfengzhidao.com/

1.1 基础介绍

Gin是一个轻量级的、高性能的web框架，由Golang语言开发。Gin的核心设计理念是提供快速建立API的开发方式，同时保持良好的性能和高度易用性。

下面是Gin框架的主要特点：

快速性能 – Gin采用了诸如Like-nginx等类似的底层库，因此Gin的性能非常高，可以达到每秒处理数百万个请求的水平。
简单易用 – Gin框架采用了类似于Martini的API设计，非常容易学习和使用。
模块化 – Gin的中间件机制使其易于构建和扩展应用程序。
松散耦合 – Gin的设计允许使用者在不破坏当前应用的前提下快速添加新的特性或更改现有特性。
适用范围广 – Gin的设计允许用户构建任何类型的web应用程序，包括API、代理、Websocket服务等。

除此之外，Gin框架还提供了大量的中间件来提供更加丰富的功能，例如日志、跨域请求、认证和授权、压缩等。

1.2 安装Gin

要求：Go 1.13 及以上版本

创建一个新项目

注意我们创建项目要添加一个国内的代理，不然下载会很慢或者失败

代理：GOPROXY=https://goproxy.cn,direct

下载并安装Gin

go get -u github.com/gin-gonic/gin

然后，我们会在go.mod里面会发现多了很多东西，这些就Gin，直接使用

安装postman

主要是用于对接口进行调试的工具，有类似的工具都可以，例如：Apifox

postman官网：https://www.postman.com/downloads/?utm_source=postman-home

1.3 快速使用

创建文件夹和文件

我这里创建了一个GinStudy01_HelloWord的文件夹，在里面又创建了一个main文件夹，在里面创建main文件

将 gin 引入到代码中：

import "github.com/gin-gonic/gin"

（可选）如果使用诸如 http.StatusOK 之类的常量，则需要引入 net/http 包：

import "net/http"

写代码

package main

import (
	"github.com/gin-gonic/gin"
	"net/http"
)

func main() {
	router := gin.Default()
	router.GET("/index", func(c *gin.Context) {
		c.String(http.StatusOK, "Hello World")
	})
    // 启动方式一
	router.Run(":8000") // 监听并在 0.0.0.0:8000 上启动服务
	// 启动方式二
	// http.ListenAndServe(":8000", router)
}

然后运行，等待一会，成功后，游览器访问：http://127.0.0.1:8000/index，会发现有Hello World

router:=gin.Default()：这是默认的服务器。使用gin的Default方法创建一个路由Handler；
然后通过Http方法绑定路由规则和路由函数。不同于net/http库的路由函数，gin进行了封装，把request和response都封装到了gin.Context的上下文环境中。
最后启动路由的Run方法监听端口。还可以用http.ListenAndServe(":8080", router)，或者自定义Http服务器配置。

2 路由

本文将介绍Gin框架的路由功能，包括路由的基本使用、路由参数、路由分组、重定向、请求响应和中间件等。

2.1 基本路由

Router是Gin框架中的一个HTTP路由。Gin框架使用Router来接受HTTP请求，并根据请求的路径和HTTP方法来判断执行的处理函数。

Gin框架的Router支持HTTP的所有方法：GET、POST、PUT、PATCH、DELETE、HEAD、OPTIONS。

我们首先需要引入gin包：

import "github.com/gin-gonic/gin"

然后创建一个Gin框架的Router：

r := gin.Default()

GET请求

使用GET方法，接受GET方式的HTTP请求。

func main() {
    r := gin.Default()

    r.GET("/hello", func(c *gin.Context) {
        c.String(http.StatusOK, "Hello World")
    })

    r.Run(":8080")
}

当我们访问http://localhost:8080/hello时，就能够在浏览器上看到输出了"Hello World"。

POST请求

使用POST方法，接受POST方式的HTTP请求。

import (
	"github.com/gin-gonic/gin"
	"net/http"
)
// 这里只是把func给提出来，这样代码看起来更简洁了
func postRequest(c *gin.Context) {
	username := c.PostForm("username")
	password := c.PostForm("password")
	c.JSON(http.StatusOK, gin.H{
		"username": username,
		"password": password,
	})
}

func main() {
	r := gin.Default()
	// post请求
	r.POST("/login", postRequest)

	r.Run(":8080")
}

当我们通过POST方式，访问http://localhost:8080/login，然后通过POST方法提交username和password参数，就能够在返回结果中看到我们提交的参数值。

至于其他的请求，略。。。。

2.2 路由参数

Gin框架中的Router支持动态路由参数，在路由路径中使用冒号加参数名的方式表示参数。

func main() {
    r := gin.Default()

    r.GET("/users/:id", func(c *gin.Context) {
        id := c.Param("id")
        c.String(http.StatusOK, "User ID: %s", id)
    })

    r.Run(":8080")
}

使用Param方法获取路由中的参数值。

当我们访问http://localhost:8080/users/123时，就能够在浏览器上看到输出了"User ID: 123"。

2.3 路由分组

Gin框架的Router也支持路由分组，可以按照功能分组路由，这样能够更好地管理代码，并且能够为每个路由分组设置不同的中间件。

基本分组

我们可以使用Gin框架的Group方法将路由按照功能进行分组。

func main() {
    r := gin.Default()

    api := r.Group("/api")
    {
        api.GET("/users", func(c *gin.Context) {
            c.String(http.StatusOK, "API Users")
        })

        api.GET("/products", func(c *gin.Context) {
            c.String(http.StatusOK, "API Products")
        })
    }

    admin := r.Group("/admin")
    {
        admin.GET("/users", func(c *gin.Context) {
            c.String(http.StatusOK, "Admin Users")
        })

        admin.GET("/products", func(c *gin.Context) {
            c.String(http.StatusOK, "Admin Products")
        })
    }

    r.Run(":8080")
}

我们可以将API路由和管理员路由分别归为一个Group，并在Group中设置对应的路由处理函数。

当我们访问http://localhost:8080/api/users和http://localhost:8080/admin/users时，就能够在浏览器上看到输出了"API Users"和"Admin Users"。

带中间件的分组

中间件还没有讲解，等后面学到了，可以再回来看~

我们还可以在路由分组中指定中间件，这样能够更好地进行控制，对于需要进行身份验证或者请求限制的路由，我们需要通过Group进行中间件的指定。

func main() {
    r := gin.Default()

    api := r.Group("/api")
    {
        api.Use(AuthMiddleware())
        api.GET("/users", func(c *gin.Context) {
            c.String(http.StatusOK, "API Users")
        })

        api.GET("/products", func(c *gin.Context) {
            c.String(http.StatusOK, "API Products")
        })
    }

    admin := r.Group("/admin")
    {
        admin.Use(AuthMiddleware(), LimitMiddleware())
        admin.GET("/users", func(c *gin.Context) {
            c.String(http.StatusOK, "Admin Users")
        })

        admin.GET("/products", func(c *gin.Context) {
            c.String(http.StatusOK, "Admin Products")
        })
    }

    r.Run(":8080")
}

使用Use方法指定中间件，多个中间件可以通过逗号分隔。

2.4 重定向

在Gin中，我们可以使用路由重定向功能将一条路由重定向到另一条路由。

func main() {
    r := gin.Default()

    r.GET("/users", func(c *gin.Context) {
        c.Redirect(http.StatusMovedPermanently, "/api/users")
    })

    r.GET("/api/users", func(c *gin.Context) {
        c.String(http.StatusOK, "API Users")
    })

    r.Run(":8080")
}