Gin框架入门系列【1】HelloWorld

490 阅读2分钟

开启掘金成长之旅!这是我参与「掘金日新计划 · 12 月更文挑战」的第1天,点击查看活动详情

1 什么是Gin

Gin框架是一个使用Go语言编写的web框架,截止目前为止在GitHub上已有64K star,Gin框架是一个高性能,且能快速进行开发的框架,是目前Go语言生态中使用最多且最简单的web框架之一。

GitHub地址:github.com/gin-gonic/g…

官网:gin-gonic.com/

2 快速入门

GoLang版本:1.19

开发工具:GoLand

2.1 新建项目

在GoLand中新建一个 gin-study 项目,并在根目录下新建main.go文件

image.png

打开GoLand的Terminal,使用go get 命令导入gin框架的依赖:

go get github.com/gin-gonic/gin

image-20221124111853323

2.2 编写main.go文件

package main

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

func main() {
	g := gin.Default()
	g.GET("/hello", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{
			"message": "Hello World",
		})
	})
	err := g.Run(":8888")
	if err != nil {
		return
	}
}

使用 gin 框架开发一个web程序很简单,首先可以通过gin.Default()方法创建一个默认的gin路由,该方法返回值为*Engine类型,上述代码中使用变量 g 接收。

然后使用返回的默认路由绑定路由规则,路由规则的绑定主要有GET,POST,PUT,DELETE和OPTIONS,这些方法的使用都是一样需要两个参数,第一个参数为string类型的路由,第二个参数为回调函数,可以理解为当请求匹配到该路由时就会执行后面的回调方法。

回调方法的参数必须为 *gin.Context 类型,该类型里面封装了 request 和 response,使用该类型的JSON方法可以返回JSON数据,常见的数据返回类型有String,JSON,XML等,例如上述JSON返回方法中需要执行两个参数,第一个是HTTP返回码,第二个是具体的JSON数据,http.StatusOK是一个值为200的常量,gin.H是一个初始化JSON数据的工具。

最后调用默认路由的 Run 方法,该方法参数指定监听的端口,不指定则默认监听8080端口。

3 运行

运行该程序,输出 [GIN-debug] Listening and serving HTTP on :8888 表示程序启动成功,然后使用浏览器访问 http://localhost:8888/hello

输出以下内容则表示成功。(只看JSON串里面的内容,我这个是因为浏览器安装了JSON插件所以会有额外内容及JSON格式转换)

image-20221124113748353

关注,持续更新……