[系列] go-gin-api 规划目录和参数验证(二)
概述
首先同步下项目概况:
上篇文章分享了,使用 go modules 初始化项目,这篇文章咱们分享:
- 规划目录结构
- 模型绑定和验证
- 自定义验证器
- 制定 API 返回结构
废话不多说,咱们开始吧。
规划目录结构
├─ go-gin-api
│ ├─ app
│ ├─ config //配置文件
│ ├─ config.go
│ ├─ controller //控制器层
│ ├─ param_bind
│ ├─ param_verify
│ ├─ ...
│ ├─ model //数据库ORM
│ ├─ proto
│ ├─ ...
│ ├─ repository //数据库操作层
│ ├─ ...
│ ├─ route //路由
│ ├─ middleware
│ ├─ route.go
│ ├─ service //业务层
│ ├─ ...
│ ├─ util //工具包
│ ├─ ...
│ ├─ vendor //依赖包
│ ├─ ...
│ ├─ go.mod
│ ├─ go.sum
│ ├─ main.go //入口文件
上面的目录结构是我自定义的,大家也可以根据自己的习惯去定义。
controller 控制器层主要对提交过来的数据进行验证,然后将验证完成的数据传递给 service 处理。
在 gin 框架中,参数验证有两种:
1、模型绑定和验证。
2、自定义验证器。
其中目录 param_bind
,存储的是参数绑定的数据,目录param_verify
存储的是自定义验证器。
接下来,让咱们进行简单实现。
模型绑定和验证
比如,有一个创建商品的接口,商品名称不能为空。
配置路由(route.go):
ProductRouter := engine.Group("")
{
// 新增产品
ProductRouter.POST("/product", product.Add)
// 更新产品
ProductRouter.PUT("/product/:id", product.Edit)
// 删除产品
ProductRouter.DELETE("/product/:id", product.Delete)
// 获取产品详情
ProductRouter.GET("/product/:id", product.Detail)
}
参数绑定(param_bind/product.go):
type ProductAdd struct {
Name string `form:"name" json:"name" binding:"required"`
}
控制器调用(controller/product.go):
if err := c.ShouldBind(¶m_bind.ProductAdd{}); err != nil {
utilGin.Response(-1, err.Error(), nil)
return
}
咱们用 Postman 模拟 post 请求时,name 参数不传或传递为空,会出现:
Key: 'ProductAdd.Name' Error:Field validation for 'Name' failed on the 'required' tag
这就使用到了参数设置的 binding:"required"
。
那么还能使用 binding 哪些参数,有文档吗?
有。Gin 使用 go-playground/validator.v8 进行验证,相关文档:
https://godoc.org/gopkg.in/go-playground/validator.v8
接下来,咱们实现一下自定义验证器。
自定义验证器
比如,有一个创建商品的接口,商品名称不能为空并且参数名称不能等于 admin。
类似于这种业务需求,无法 binding 现成的方法,需要我们自己写验证方法,才能实现。
自定义验证方法(param_verify/product.go)
func NameValid (
v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
) bool {
if s, ok := field.Interface().(string); ok {
if s == "admin" {
return false
}
}
return true
}
参数绑定(param_bind/product.go):
type ProductAdd struct {
Name string `form:"name" json:"name" binding:"required,NameValid"`
}
同时还要绑定验证器:
// 绑定验证器
if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
v.RegisterValidation("NameValid", param_verify.NameValid)
}
咱们用 Postman 模拟 post 请求时,name 参数不传或传递为空,会出现:
Key: 'ProductAdd.Name' Error:Field validation for 'Name' failed on the 'required' tag
name=admin 时:
Key: 'ProductAdd.Name' Error:Field validation for 'Name' failed on the 'NameValid' tag
OK,上面两个验证都生效了!
上面的输出都是在控制台,能不能返回一个 Json 结构的数据呀?
能。接下来咱们制定 API 返回结构。
制定 API 返回结构
{
"code": 1,
"msg": "",
"data": null
}
API 接口的返回的结构基本都是这三个字段。
比如 code=1 表示成功,code=-1 表示失败。
msg 表示提示信息。
data 表示要返回的数据。
那么,我们怎么在 gin 框架中实现它,其实很简单 基于 c.JSON()
方法进行封装即可,直接看代码。
package util
import "github.com/gin-gonic/gin"
type Gin struct {
Ctx *gin.Context
}
type response struct {
Code int `json:"code"`
Message string `json:"msg"`
Data interface{} `json:"data"`
}
func (g *Gin)Response(code int, msg string, data interface{}) {
g.Ctx.JSON(200, response{
Code : code,
Message : msg,
Data : data,
})
return
}
控制器调用(controller/product.go):
utilGin := util.Gin{Ctx:c}
if err := c.ShouldBind(¶m_bind.ProductAdd{}); err != nil {
utilGin.Response(-1, err.Error(), nil)
return
}
咱们用 Postman 模拟 post 请求时,name 参数不传或传递为空,会出现:
{
"code": -1,
"msg": "Key: 'ProductAdd.Name' Error:Field validation for 'Name' failed on the 'required' tag",
"data": null
}
name=admin 时:
{
"code": -1,
"msg": "Key: 'ProductAdd.Name' Error:Field validation for 'Name' failed on the 'NameValid' tag",
"data": null
}
OK,上面两个验证都生效了!
源码地址
https://github.com/xinliangnote/go-gin-api
go-gin-api 系列文章
[系列] go-gin-api 规划目录和参数验证(二)的更多相关文章
- go-gin-api 规划目录和参数验证(二)
概述 首先同步下项目概况: 上篇文章分享了,使用 go modules 初始化项目,这篇文章咱们分享: 规划目录结构 模型绑定和验证 自定义验证器 制定 API 返回结构 废话不多说,咱们开始吧. 规 ...
- .net core api 对于FromBody的参数验证
前言 在framework的mvc中,经常会使用 Model.State . ModelState.IsValid 配合着特性进行参数验证,通过这种方式可以降低controller的复杂度,使用方便. ...
- MVC之参数验证(二)
MVC内部针对这此验证是如何实现的咧???现在我们就来分析一下这此验证的背后故事.... 1.ModelValidator与ModelValidatorProvider 虽然Model绑定方式的因绑定 ...
- ASP.NET Web API 2 之参数验证
Ø 前言 目前 C# 比较流行使用 ASP.NET Web API 来承载 Web 接口,提供与客户端之间的数据交互,现在的版本已经是 2.0 了.既然是接口就少不了对输入参数的验证,所以本文主要探 ...
- Gin框架 - 项目目录
概述 今天给大家分享,在 API 端使用 Gin 框架时,项目的目录. 目录 ├─ Project Name │ ├─ config //配置文件 │ ├── ... │ ├─ controller ...
- 【quickhybrid】API规划
前言 当一切就绪后,就要开始进行API规划,这一块是整个Hybrid框架中非常重要的内容,毕竟对于前端页面来说,只会通过JS API来调用功能. 基本上,API调用起来是否方便简洁影响着整个体验. 这 ...
- 智能合约语言 Solidity 教程系列8 - Solidity API
这是Solidity教程系列文章第8篇介绍Solidity API,它们主要表现为内置的特殊的变量及函数,存在于全局命名空间里. 写在前面 Solidity 是以太坊智能合约编程语言,阅读本文前,你应 ...
- [译]C# 7系列,Part 8: in Parameters in参数
原文:https://blogs.msdn.microsoft.com/mazhou/2018/01/08/c-7-series-part-8-in-parameters/ 背景 默认情况下,方法参数 ...
- openresty开发系列11--openresty的api入门
openresty开发系列11--openresty的api入门 1)ngx_lua模块的hello world编辑nginx下conf配置文件nginx.conf# vi nginx.conf在se ...
随机推荐
- 《C# 语言学习笔记》——委托
委托是一种可以把引用存储为函数的类型. 委托的声明非常类似于函数,但不带函数体,且要使用delegate关键字.委托的声明制定了一个返回类型和一个参数列表. 在定义了委托后,就可以声明该委托类型的变量 ...
- python 文件读写总结
这是个人在项目中抽取的代码,自己写的utils的通用模块,使用的框架是tronado,包括了文件的读写操作,api格式的统一函数,如有特别需要可以联系我或者自己扩展,刚学python不久,仅供参考,例 ...
- C语言数据类型及变量整理
数据类型 获取int的字节数大小方法 printf("int bytes:%d",sizeof(int)); 列表整理 类型 字节数 取值范围 char 1 [-128,127]= ...
- UPC Contest RankList – 2019年第二阶段我要变强个人训练赛第十五场
传送门 A: Colorful Subsequence •题意 给一个长为n的小写字母序列,从中选出字母组成子序列 问最多能组成多少种每个字母都不相同的子序列 (不同位置的相同字母也算是不同的一种) ...
- PyCharm字体大小调整
1.点击左上角File----settings----keymap----------搜索increase,选中,increase font size--------再选择enter mouse sh ...
- Cocos2d-x v3.11 中的新内存模型
Cocso2d-x v3.11 一项重点改进就是 JSB 新内存模型.这篇文章将专门介绍这项改进所带来的新研发体验和一些技术细节. 1. 成果 在 Cocos2d-x v3.11 之前的版本中,使用 ...
- Linux 常用命令及使用方法
1. type :查询命令 是否属于shell解释器 2. help : 帮助命令3. man : 为所有用户提供在线帮助4. ls : 列表显示目录内的文件及目录 -l 以长格 ...
- 对于HTTP过程中POST内容加密的解决方案
0x00前言 前几天我师傅和我提及了这件事情 正常情况下 抓包过程中遇到加密情况会很迷茫 昨天把这个都弄了一下 也感谢大佬中间的指导 我一开始看到密码的类型下意识的是base64 但是去解密发现不对 ...
- jenkins未授权访问漏洞
jenkins未授权访问漏洞 一.漏洞描述 未授权访问管理控制台,可以通过脚本命令行执行系统命令.通过该漏洞,可以后台管理服务,通过脚本命令行功能执行系统命令,如反弹shell,wget写webshe ...
- 基于 HTML5 WebGL 的加油站 3D 可视化监控
前言 随着数字化,工业互联网,物联网的发展,我国加油站正向有人值守,无人操作,远程控制的方向发展,传统的人工巡查方式逐渐转变为以自动化控制为主的在线监控方式,即采用数据采集与监控系统 SCADA.SC ...