Gin框架介紹與使用

Gin

// 初識 Gin框架
//下載（可能會下載不全，缺什么get什么即可）
//go get -u -v github.com/gin-gonic/gin

package main

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

func main() {

	r := gin.Default()

	r.GET("/", func(c *gin.Context) {

		c.JSON(http.StatusOK, map[string]string{"name": "zjhah"})
	})

	err := r.Run()
	log.Fatalln(err)
	//
}

Gin框架的熱加載 realize

// 下載 
go get github.com/oxequa/realize

// 下載之后
realize init 初始化 直接下步一步退出即可 
realize start  就是直接將gin運行起來 進行熱加載

• Gin框架—log (Gin 框架 - 使用 logrus 進行日志記錄)

約定日志格式欄位:

請求時間, 日志級別, 狀態碼, 執行時間, 請求IP, 請求方式,請求路由

Logrus

API的URL設計規則restful api

1. api有版本資訊

/v1/xxxx

/v2/xxx

2.盡可能的使用復數, 含義明確 名詞最好

/v1/users

/v1/topics

3.使用GET引數規劃資料展現規則

/v1/users

/v1/users?limit=10 //只顯示10條

• 路由組

	router := gin.Default()

	r := router.Group("/v1/")  // group組
	r.GET("/", FirstJson)
	r.POST("/", PostTest)
	_ = router.Run(":9000")

• api引數

// 這是api引數

r.GET("/:name", FirstJson)

c.param("name")

• URL引數

?key=xxx & name=xxx

• 表單取檔案

r.Post("/v1/:file")

file := c.Formfile("file")

_ := c.saveUploadFile(file, file.FileName)

• 表單上傳多個檔案

// 設定上傳的檔案的最大容量
r.MaxMultipartMemory = 8*1024

// 獲取多個檔案
form, _ := c.MultipartForm()
files := form.File["file"]
然后回圈像上邊單個存一樣

• 接收資料的結構體

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	_ "github.com/sirupsen/logrus"
	_ "log"
	"net/http"
)

// 接收資料的結構體
type Option struct {
	User     string `form:"username" json:"username" uri:"user" xml:"user" binding:"required"` // binding必須不能為空
	Password string `form:"password" json:"password" xml:"password" uri:"password"`
}

func main() {

	// 創建路由
	// default 創建的路由默認使用了兩個中間件 logger()日志  recovery() 自動恢復
	router := gin.Default()

	// 原生的是這個 是不會使用這兩個中間件的
	// router := gin.New()

	router.Use(gin.Logger())
	r := router.Group("/v1")
	{
		
		r.POST("/JsonTest", JsonTest)
	}

	_ = router.Run(":9000")
	//
}

func JsonTest(c *gin.Context) {

	// Bind() 默認決議并系結form格式
	// 根據請求頭中的 content-type 判斷資料型別
	var Form Option
	errs := c.Bind(&Form)
	if errs != nil {
		c.JSON(http.StatusBadRequest, gin.H{"error": errs.Error()})
	}
	fmt.Println(Form)

	// 宣告接收的變數  json系結
	var jsonData Option

	// 接收到的資料 系結到jsonData結構體  ShouldBindJSON
	err := c.ShouldBindJSON(&jsonData)
	fmt.Println(jsonData)
	if err != nil {
		// gin.H 封裝了生成json資料的工具
		c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
		return
	}

	if jsonData.User != "root" || jsonData.Password != "123" {
		c.JSON(http.StatusBadRequest, gin.H{"status_code": "302"})
		return
	}
	c.JSON(http.StatusOK, gin.H{"status": 200})

}

• HTML模版渲染 類似于python render

// 加載模版檔案
//	router.LoadHTMLFiles("templates/index.html")
	router.LoadHTMLGlob("templates/*")


// 	回傳狀態碼，回傳html渲染檔案，回傳想要在html檔案中所需要的資料
c.HTML("200", "index.html", gin.H{"title": "ccn"})

• 重定向

r.GET("/redirect", Redirects)

func Redirects(c *gin.Context) {
	c.Redirect(http.StatusMovedPermanently, "http://www.taobao.com/")

}

• 同步異步

// 異步
func Async(c *gin.Context) {
	// go routine 機制可以方便的實作異步處理
	// 注意: 在啟動新的goroutine時, 不應該使用原始背景關系, 必須使用他的只讀副本
	copyContent := c.Copy()
	
  // go func 處理的就是要處理的資料之類的 例如上傳檔案, 修改資料, 添加資料
	go func() {
		time.Sleep(5 * time.Second)
		fmt.Println(copyContent.Request.Method, copyContent.Request.Header, copyContent.Request.RemoteAddr, copyContent.Request.RequestURI)

	}()
	c.JSON(http.StatusOK, gin.H{"name": 123})

}

// 正常的都是同步

• gin中間件

//gin可以構建中間件, 但它只對注冊過的路由函式起作用
//對于分組路由, 嵌套使用中間件, 可以限定中間件的作用范圍
//中間件分為全域中間件, 單個路由中間件和群組中間件
//gin中間件必須是一個gin.HandlerFun型別


// 全域中間件所有的中間件都會經過

func GinMiddleWare() gin.HandlerFunc {

	return func(c *gin.Context) {
		fmt.Println("中間件開始執行")
		// 設定變數到context的key中, 后邊可以通過Get()獲取
		c.Set("request", "中間件")
		// 執行router系結的函式
		c.Next()
    // 執行完中間件后執行的代碼
		status := c.Writer.Status()
		fmt.Println(status)
	}
}


c.GET("request")

• gin生成介面檔案 swagger
• JSON web token JWT
• 令牌桶 漏桶

標籤：Go

上一篇：懂得取舍才是快取設計的真諦

下一篇：通用連接池幫你解決資源管理難題