25-Go的web框架gin基本介绍

孔深
2023-12-01

Gin框架介绍

Go世界里最流行的web框架,github上有32k+的star。基于httprouter开发的web框架。中文文档齐全,简单易用的轻量级框架。

Gin框架安装与使用

安装

下载并安装Gin:

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

第一个Gin示例:

package main

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

func main() {
	//创建一个默认的路由引擎
	r := gin.Default()

	// GET:请求方式;/hello: 请求的路径
	// 当客户端以GET方法请求/hello路径时,会执行后面的匿名函数
	r.GET("/hello", func(ctx *gin.Context) {
		// ctx.JSON: 返回JSON格式的数据
		ctx.JSON(200, gin.H{
			"message": "hello world",
		})
	})

	// 启动HTTP服务,默认在0.0.0.0:8080启动服务
	r.Run()
}

RESTful

REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移”或“表现层状态转化”。

简单来说,REST的含义就是客户端与web服务器之间进行交互的时候,使用HTTP协议中的4个请求方法代表不同的动作。

  • GET用来获取资源
  • POST用来新建资源
  • PUT用来更新资源
  • DELETE用来删除资源。

只要API程序遵循了REST风格,那就可以称其为RESTful API。目前在前后端分离的架构中,前后端基本都是通过RESTful API来进行交互。

例如,我们现在要编写一个管理书籍的系统,我们可以查询对一本书进行查询、创建、更新和删除等操作,我们在编写程序的时候就要设计客户端浏览器与我们Web服务端交互的方式和路径。按照经验我们通常会设计成如下模式:

请求方法URL含义
GET/book查询书籍信息
POST/create_book创建书籍记录
POST/update_book更新书籍信息
POST/delete_book删除书籍信息

同样的需求我们按照RESTful API设计如下:

请求方法URL含义
GET/book查询书籍信息
POST/book创建书籍记录
PUT/book更新书籍信息
DELETE/book删除书籍信息

Gin框架支持开发RESTful API的开发。

func main(){
  r:= gin.Default()
  // GET 请求方法
  r.GET("/book",func(c *gin.Context){
    c.JSON(200,gin.H{
      "message":"GET",
    })
  })
  
  // POST请求方法
  r.POST("/book",func(c *gin.Context){
    c.JSON(200,gin.H{
      "message":"POST"
    })
  })
  
  // PUT请求方法
  r.PUT("/book",func(c *gin.Context){
    c.JSON(200,gin.H{
      "message":"PUT",
    })
  })
   
  // DELETE请求方法
  r.DELETE("/book",func(c *gin.Context){
    c.JSON(200,gin.H{
      "message":"DELETE"
    })
  })
    
}

开发RESTful API的时候通常使用postman作为客户端测试工具.

Gin 渲染

HTML渲染

我们首先定义一个存放模版文件的templates文件夹,然后在其内部按照业务定义一个posts文件夹和一个users文件夹。posts/index.html文件的内容如下:

{{define "posts/index.html"}}
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>posts/index</title>
</head>
<body>
    {{.title}}
</body>
</html>
{{end}}

users/index.html文件的内容如下:

{{define "users/index.html"}}
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>users/index</title>
</head>
<body>
    {{.title}}
</body>
</html>
{{end}}

Gin框架中使用LoadHTMLGlob或者LoadHTMLFiles()方法进行HTML模版渲染。

func HTmlDemo1() {
	// 定义默认路由
	r := gin.Default()

	// HTML 模版渲染
	// r.LoadHTMLGlob("templates/**/*")
	r.LoadHTMLFiles("templates/posts/index.html", "templates/users/index.html")

	// 发送get请求
	r.GET("/posts/index", func(ctx *gin.Context) {
		ctx.HTML(http.StatusOK, "posts/index.html", gin.H{
			"message": "posts/index",
		})
	})

	// 发送get请求
	r.GET("/users/index", func(ctx *gin.Context) {
		ctx.HTML(http.StatusOK, "users/index.html", gin.H{
			"message": "users/index",
		})
	})
JSON渲染
// JSON渲染
func JsonDemo1() {
	// 定义默认路由
	r := gin.Default()

	// gin.H是map[string]interface{}的缩写
	r.GET("/jsonDemo", func(ctx *gin.Context) {
		// 方式一:自己拼接JSON
		ctx.JSON(http.StatusOK, gin.H{
			"message": "hello 方式一",
		})
	})

	r.GET("/jsonDemo2", func(ctx *gin.Context) {
		// 方法二:使用结构体
		var msg struct {
			Name    string `json:"name"`
			Message string
			Age     int
		}
		msg.Name = "小男孩"
		msg.Message = "大家好,我是爱写代码的小男孩"
		msg.Age = 28
		ctx.JSON(http.StatusOK, msg)
	})

	r.Run(":8080")

}

更多想了解XML,YAML渲染,详见:https://www.liwenzhou.com/posts/Go/Gin_framework/#autoid-0-4-5

 类似资料: