Gin框架介绍 与 RESTful API| 青训营笔记

407 阅读3分钟

这是我参与「第五届青训营 」伴学笔记创作活动的第 2 天 Gin 是一个用Go语言编写的web框架。它是一个类似于 martini 但拥有更好性能的API框架, 由于使用了 httprouter,速度提高了近40倍。如果你是性能和高效的追求者, 你会爱上 Gin

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

1: Gin框架安装与使用

1.1: 安装

下载并安装 Gin :

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

1.2: 第一个Gin示例:

package main

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

func main() {
	// 创建一个默认的路由引擎
	r := gin.Default()
	// GET:请求方式;/hello:请求的路径
	// 当客户端以GET方法请求/hello路径时,会执行后面的匿名函数
	r.GET("/hello", func(c *gin.Context) {
		// c.JSON:返回JSON格式的数据
		c.JSON(200, gin.H{
			"message": "Hello world!",
		})
	})
	// 启动HTTP服务,默认在0.0.0.0:8080启动服务
	r.Run()
}

将上面的代码保存并编译执行,然后使用浏览器打开 127.0.0.1:8080/hello 就能看到一串JSON字符串。

[!note]+ 为什么返回 json 以前: 如果直接返回前端写好的 html 文件, 如果网站过大, 就会发送的特别慢 现在: 后端返回 json 字符, 在浏览器中在渲染

2: RESTful API

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

推荐阅读阮一峰 理解RESTful架构

简单来说,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()
	r.GET("/book", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "GET",
		})
	})

	r.POST("/book", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "POST",
		})
	})

	r.PUT("/book", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "PUT",
		})
	})

	r.DELETE("/book", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "DELETE",
		})
	})
    
   	// 启动HTTP服务,默认在0.0.0.0:8080启动服务
	r.Run()
	//postman 访问:127.0.0.1:8080/hello
}

[!note]+ 开发RESTful API的时候我们通常使用 Postman 来作为客户端的测试工具。 可以向本机发送 post, delete 等

image.png