2. 程式人生 > 實用技巧 >【go-gin-API系列】請求和響應引數的檢查繫結（二）

【go-gin-API系列】請求和響應引數的檢查繫結（二）

阿新 • • 發佈：2020-07-27

引數設計

一套合格的API的服務需要規範的輸入請求和標準的輸出響應格式。
為了更規範的設計，也是為了程式碼的可讀性和擴充套件性，我們需要對Http請求和響應做好模型設計。

  • 請求

根據[【Gin-API系列】需求設計和功能規劃（一）]請求案例的設計，
我們在ip引數後面再增加一個引數oid來表示模型ID，只返回需要的模型model

 // 考慮到後面會有更多的 API 路由設計，本路由可以命名為 SearchIp

type ReqGetParaSearchIp struct {
	Ip  string        
	Oid configure.Oid 
}

type ReqPostParaSearchIp struct {
	Ip  string        
	Oid configure.Oid 
}

const (
	OidHost   Oid = "HOST"
	OidSwitch Oid = "SWITCH"
)

var OidArray = []Oid{OidHost, OidSwitch}
  • 響應

API的響應都需要統一格式，並維護各欄位的文件解釋

type ResponseData struct {
	Page     int64         `json:"page"`  // 分頁顯示，頁碼
	PageSize int64         `json:"page_size"`  // 分頁顯示，頁面大小
	Size     int64         `json:"size"`  // 返回的元素總數
	Total    int64         `json:"total"`  // 篩選條件計算得到的總數，但可能不會全部返回
	List     []interface{} `json:"list"`
}

type Response struct {
	Code    configure.Code `json:"code"`  // 響應碼
	Message string         `json:"message"` // 響應描述
	Data    ResponseData   `json:"data"`  // 最終返回資料
}
  • 請求IP合法性檢查

我們需要對search_ip介面的請求引數長度、格式、錯誤IP做檢查。
其中，錯誤IP一般指的是127.0.0.1這種迴環IP，或者是閘道器、重複的區域網IP等

func CheckIp(ipArr []string, low, high int) error {
	if low > len(ipArr) || len(ipArr) > high {
		return errors.New(fmt.Sprintf("請求IP數量超過限制"))
	}
	for _, ip := range ipArr {
		if !network.MatchIpPattern(ip) {
			return errors.New(fmt.Sprintf("錯誤的IP格式:%s", ip))
		}
		if network.ErrorIpPattern(ip) {
			return errors.New(fmt.Sprintf("不支援的IP:%s", ip))
		}
	}
	return nil
}

utils.network 檔案

// IP地址格式匹配  "010.99.32.88" 屬於正常IP
func MatchIpPattern(ip string) bool {
	//pattern := `^((2[0-4]\d|25[0-5]|[01]?\d\d?)\.){3}(2[0-4]\d|25[0-5]|[01]?\d\d?)$`
	//reg := regexp.MustCompile(pattern)
	//return reg.MatchString(ip)
	if net.ParseIP(ip) == nil {
		return false
	}
	return true
}

// 排查錯誤的IP
func ErrorIpPattern(ip string) bool {
	errorIpMapper := map[string]bool{
		"192.168.122.1": true,
		"192.168.250.1": true,
		"192.168.255.1": true,
		"192.168.99.1":  true,
		"192.168.56.1":  true,
		"10.10.10.1":    true,
	}
	errorIpPrefixPattern := []string{"127.0.0.", "169.254.", "11.1.", "10.176."}
	errorIpSuffixPattern := []string{".0.1"}
	if _, ok := errorIpMapper[ip]; ok {
		return true
	}
	for _, p := range errorIpPrefixPattern {
		if strings.HasPrefix(ip, p) {
			return true
		}
	}
	for _, p := range errorIpSuffixPattern {
		if strings.HasSuffix(ip, p) {
			return true
		}
	}
	return false
}
  • 程式碼實現

為了通用性設計，我們將main函式的func(c *gin.Context)獨立定義成一個函式SearchIpHandlerWithGet
考慮到API的擴充套件和相容，我們將對API的實現區分版本，在route資料夾中新建v1資料夾作為第一版本程式碼實現。
同時，我們將search_ip歸類為sdk集合，存放於v1

var SearchIpHandlerWithGet = func(c *gin.Context) {
	ipStr := c.DefaultQuery("ip", "")
	response := route_response.Response{
		Code:configure.RequestSuccess,
		Data: route_response.ResponseData{List: []interface{}{}},
	}
	if ipStr == "" {
		response.Code, response.Message = configure.RequestParameterMiss, "缺少請求引數ip"
		c.JSON(http.StatusOK, response)
		return
	}
	ipArr := strings.Split(ipStr, ",")
	if err := route_request.CheckIp(ipArr, 1, 10); err != nil {
		response.Code, response.Message = configure.RequestParameterRangeError, err.Error()
		c.JSON(http.StatusOK, response)
		return
	}
	hostInfo := map[string]interface{}{
		"10.1.162.18": map[string]string{
			"model": "主機", "IP": "10.1.162.18",
		},
	}
	response.Data = route_response.ResponseData{
		Page:     1,
		PageSize: 1,
		Size:     1,
		Total:    1,
		List:     []interface{}{hostInfo, },
	}
	c.JSON(http.StatusOK, response)
	return
}
  • 結果驗證
D:\> curl http://127.0.0.1:8080?ip=''
{"code":4002,"message":"錯誤的IP格式:''","data":{"page":0,"page_size":0,"size":0,"total":0,"list":[]}}

D:\> curl http://127.0.0.1:8080?ip=
{"code":4005,"message":"缺少請求引數ip","data":{"page":0,"page_size":0,"size":0,"total":0,"list":[]}}

D:\> curl http://127.0.0.1:8080?ip="10.1.1.1"
{"code":0,"message":"","data":{"page":1,"page_size":1,"size":1,"total":1,"list":[{"10.1.162.18":{"IP":"10.1.162.18","model":"主機"}}]}}

Gin.ShouldBind引數繫結

  • 為了使請求引數的可讀性和擴充套件性更強，我們使用ShouldBind函式來對請求進行引數繫結和校驗

ShouldBind 支援將Http請求內容繫結到Gin Struct結構體，
目前支援JSON、XML、FORM請求格式繫結(請看前面定義的ReqParaSearchIp)。

  • 使用方法
// ipStr := c.DefaultQuery("ip", "")
 
var req route_request.ReqParaSearchIp
if err := c.ShouldBindQuery(&req); err != nil {
    response.Code, response.Message = configure.RequestParameterTypeError, err.Error()
    c.JSON(http.StatusOK, response)
    return
}
ipStr := req.Ip
if ipStr == "" {
    response.Code, response.Message = configure.RequestParameterMiss, "缺少請求引數ip"
    c.JSON(http.StatusOK, response)
    return
}
  • 注意事項

GET請求的struct使用form解析
POST請求的使用JSON解析,Content-Type使用application/json

type ReqParaSearchIp struct {
    Ip string         `form:"ip"`
    Oid configure.Oid `form:"oid"`
}

type ReqPostParaSearchIp struct {
    Ip string         `json:"ip"`
    Oid configure.Oid `json:"oid"`
}
  • 自定義校驗器

使用了ShouldBind之後我們就可以使用第三方校驗器來協助校驗引數了。
還記得我們前面的引數校驗嗎，邏輯很簡單，程式碼卻很繁瑣。
接下來，我們將使用validator.v10來做自定義校驗器。

先完成validator.v10的初始化繫結

// DefaultValidator 驗證器
type DefaultValidator struct {
	once     sync.Once
	validate *validator.Validate
}

var _ binding.StructValidator = &DefaultValidator{}

// ValidateStruct 如果接收到的型別是一個結構體或指向結構體的指標，則執行驗證。
func (v *DefaultValidator) ValidateStruct(obj interface{}) error {
	if kindOfData(obj) == reflect.Struct {
		v.lazyinit()
		if err := v.validate.Struct(obj); err != nil {
			return err
		}
	}
	return nil
}

// Engine 返回支援`StructValidator`實現的底層驗證引擎
func (v *DefaultValidator) Engine() interface{} {
	v.lazyinit()
	return v.validate
}

func (v *DefaultValidator) lazyinit() {
	v.once.Do(func() {
		v.validate = validator.New()
		v.validate.SetTagName("validate")

		//自定義驗證器 初始化
		for valName, valFun := range validatorMapper {
			if err := v.validate.RegisterValidation(valName, valFun); err != nil {
				fmt.Println(err)
				os.Exit(1)
			}
		}
	})
}

func kindOfData(data interface{}) reflect.Kind {
	value := reflect.ValueOf(data)
	valueType := value.Kind()

	if valueType == reflect.Ptr {
		valueType = value.Elem().Kind()
	}
	return valueType
}

func InitValidator() {
	binding.Validator = new(DefaultValidator)
}

自定義引數驗證器

// 自定義引數驗證器名稱
const (
	ValNameCheckOid string = "check_oid"
)

// 自定義引數驗證器字典
var validatorMapper = map[string]func(field validator.FieldLevel) bool{
	ValNameCheckOid: CheckOid,
}

// 自定義引數驗證器函式
func CheckOid(field validator.FieldLevel) bool {
	oid := configure.Oid(field.Field().String())
	for _, id := range configure.OidArray {
		if oid == id {
			return true
		}
	}
	return false
}

使用引數驗證器

type ReqGetParaSearchIp struct {
	Ip  string        `form:"ip" validate:"required"`
	Oid configure.Oid `form:"oid" validate:"required,check_oid"`
}

type ReqPostParaSearchIp struct {
	Ip  string        `json:"ip" validate:"required"`
	Oid configure.Oid `json:"oid" validate:"required,check_oid"`
}

ShouldBind繫結

var SearchIpHandlerWithGet = func(c *gin.Context) {
	response := route_response.Response{
		Code:configure.RequestSuccess,
		Data: route_response.ResponseData{List: []interface{}{}},
	}
	var params route_request.ReqGetParaSearchIp
	if err := c.ShouldBindQuery(&params); err != nil {
		code, msg := params.ParseError(err)
		response.Code, response.Message = code, msg
		c.JSON(http.StatusOK, response)
		return
	}
	ipArr := strings.Split(params.Ip, ",")
	if err := route_request.CheckIp(ipArr, 1, 10); err != nil {
		response.Code, response.Message = configure.RequestParameterRangeError, err.Error()
		c.JSON(http.StatusOK, response)
		return
	}
	hostInfo := map[string]interface{}{
		"10.1.162.18": map[string]string{
			"model": "主機", "IP": "10.1.162.18",
		},
	}
	response.Data = route_response.ResponseData{
		Page:     1,
		PageSize: 1,
		Size:     1,
		Total:    1,
		List:     []interface{}{hostInfo, },
	}
	c.JSON(http.StatusOK, response)
	return
}

main函式初始化

func main() {
	route := gin.Default()
	route_request.InitValidator()
	route.GET("/", v1_sdk.SearchIpHandlerWithGet)
	if err := route.Run("127.0.0.1:8080"); err != nil {
		fmt.Println(err)
		os.Exit(1)
	}
}
  • 實現效果展示
D:\> curl "http://127.0.0.1:8080?ip=10.1.1.1&oid=HOST"
{"code":0,"message":"","data":{"page":1,"page_size":1,"size":1,"total":1,"list":[{"10.1.162.18":{"IP":"10.1.162.18","model":"主機"}}]}}

D:\> curl "http://127.0.0.1:8080?ip=10.1.1.1&oid=SWITCH"
{"code":0,"message":"","data":{"page":1,"page_size":1,"size":1,"total":1,"list":[{"10.1.162.18":{"IP":"10.1.162.18","model":"主機"}}]}}

D:\> curl "http://127.0.0.1:8080?ip=10.1.1.1&oid=XX"
{"code":4002,"message":"請求引數 Oid 需要傳入 object id","data":{"page":0,"page_size":0,"size":0,"total":0,"list":[]}}

D:\> curl "http://127.0.0.1:8080?ip=10.1.1&oid=HOST"
{"code":4002,"message":"錯誤的IP格式:10.1.1","data":{"page":0,"page_size":0,"size":0,"total":0,"list":[]}}

Github 程式碼

請訪問 Gin-IPs 或者搜尋 Gin-IPs

相關推薦

【go-gin-API系列】請求和響應引數的檢查繫結（二）

引數設計 一套合格的API的服務需要規範的輸入請求和標準的輸出響應格式。 為了更規範的設計，也是為了程式碼的可讀性和擴充套件性，我們需要對Http請求和響應做好模型設計。

【Gin-API系列】請求和響應引數的檢查繫結（二）

引數設計 一套合格的API的服務需要規範的輸入請求和標準的輸出響應格式。 為了更規範的設計，也是為了程式碼的可讀性和擴充套件性，我們需要對Http請求和響應做好模型設計。

【進階之路】Redis基礎知識兩篇就滿足（二）

導言 大家好，我是南橘，一名練習時常兩年半的java練習生，這是我在部落格園的第二篇文章，當然，都是要從別處搬運過來的，不過以後新的文章也會在部落格園同步釋出，希望大家能多多支援^_^

【友晶科技Terasic】DE10_Standard_ADC LTC2308的若干問題解答(SPI)（二）

7. LTC2308 有兩個時序圖，為什麼是選擇下面那個時序圖？   答：原因是為了LTC2308 表現的效能更好，儘量：

CPF 入門教程 - 資料繫結和命令繫結（二）

CPF netcore跨平臺UI框架 系列教程 CPF 入門教程（一） CPF 入門教程 - 資料繫結和命令繫結（二）

【Gin-API系列】需求設計和功能規劃（一）

場景需求 資料庫儲存2個模型，每個模型都有一個或多個IP欄位，需要通過 Golang Http Api(Restful Api) 返回 IP 資訊。

【Gin-API系列】配置檔案和資料庫操作（三）

我們前面已經實現了API的基礎版本，能對引數校驗和返回指定資料，這一章，我們將對主機和交換機進行建模，存入資料庫。

【Gin-API系列】守護程序和平滑重啟（八）

生產環境的API服務我們都會部署在Linux伺服器上，為了不受終端狀態的影響，啟動服務的時候會讓服務在後臺執行。那麼如何讓服務在後臺執行呢，目前有2種常見的方法。

【Gin-API系列】Gin中介軟體之日誌模組（四）

日誌是程式開發中必不可少的模組，同時也是日常運維定位故障的最重要環節之一。一般日誌類的操作包括日誌採集，日誌查詢，日誌監控、日誌統計等等。本文，我們將介紹日誌模組在Gin中的使用。

【Gin-API系列】Gin中介軟體之鑑權訪問（五）

在完成中介軟體的介紹和日誌中介軟體的程式碼後，我們的程式已經基本能正常跑通了，但如果要上生產，還少了一些必要的功能，例如鑑權、異常捕捉等。本章我們介紹如何編寫鑑權中介軟體。

【Go語言入門系列】（九）寫這些就是為了搞懂怎麼用介面

【Go語言入門系列】前面的文章： 【Go語言入門系列】（六）再探函式 【Go語言入門系列】（七）如何使用Go的方法？

go怎麼匯入aws_【Go語言入門系列】Go語言工作目錄介紹及命令工具的使用

技術標籤：go怎麼匯入aws 1. GOPATH目錄結構 在【保姆級教程】手把手教你進行Go語言環境安裝及相關VSCode配置一文中已經配置過工作空間GOPATH的環境變量了，並在工作空間中新建了三個目錄src、pkg、bin了。那為

【系列】移動端專案經驗 表單相容（下篇）

【系列】移動端專案經驗 表單相容（下篇） HTML5學堂：本文，我們將繼續為大家總結介紹移動端的常見相容問題，今天要提的是關於表單的一些相容問題，主要包括呼叫相簿的按鈕樣式處理；佔位符placeholder屬性的行高問

【進階之路】Redis基礎知識兩篇就滿足（一）

導言 大家好，我是南橘，一名練習時常兩年半的java練習生，這是我在部落格園的第一篇文章，當然，都是要從別處搬運過來的，不過以後新的文章也會在部落格園同步釋出，希望大家能多多支援^_^

【狂神說Java】學習筆記16：面向物件程式設計（中）

【狂神說Java】學習筆記16：面向物件程式設計（中） [01] 初識面向物件 [02] 方法回顧和加深

【狂神說Java】學習筆記17：面向物件程式設計（下）

【狂神說Java】學習筆記17：面向物件程式設計（下） [01] 初識面向物件 [02] 方法回顧和加深

【Chesed角色淺談】人性之巔、神性之下（中篇）

2022.3.31 Chesed生日快樂！ Daniel的部分請看上篇   中篇：包括腦葉公司Chesed部分（Past+中期+核心抑制後）

【荒野大鏢客2】什麼叫第九藝術啊？（六）[桌布/攝影]

<轉載>SQL 基礎知識梳理（三） - 聚合和排序 SQL 基礎知識梳理（二） - 查詢基礎

  【博主】反骨仔　　　　【原文】http://www.cnblogs.com/liqingwen/p/5926689.html     序

[系列] - go-gin-api 規劃目錄和引數驗證（二）

概述 首先同步下專案概況： 上篇文章分享了，使用 go modules 初始化專案，這篇文章咱們分享：