定义接口
本节正是编写标签的逻辑,我们想一想,一般接口为增删改查是基础的,那么我们定义一下接口吧!
- 获取标签列表:GET(“/tags”)
- 新建标签:POST(“/tags”)
- 更新指定标签:PUT(“/tags/:id”)
- 删除指定标签:DELETE(“/tags/:id”)
编写路由空壳
开始编写路由文件逻辑,在routers下新建api目录,我们当前是第一个API大版本,因此在api下新建v1目录,再新建tag.go文件,写入内容:
package v1
import "github.com/gin-gonic/gin"
// GetTags 获取多个文章标签
func GetTags(ctx *gin.Context) {
}
// AddTag 新增文章标签
func AddTag(ctx *gin.Context) {
}
// EditTag 修改文章标签
func EditTag(ctx *gin.Context) {
}
// DeleteTag 删除文章标签
func DeleteTag(ctx *gin.Context) {
}
注册路由
我们打开routers下的router.go文件,修改文件内容为:
package routers
import (
"gin_log/pkg/setting"
v1 "gin_log/routers/api/v1"
"github.com/gin-gonic/gin"
)
func InitRouter() *gin.Engine {
r := gin.New()
r.Use(gin.Logger())
r.Use(gin.Recovery())
gin.SetMode(setting.RunMode)
r.GET("/test", func(context *gin.Context) {
context.JSON(200, gin.H{"message": "test"})
})
apiv1 := r.Group("/api/v1")
// tag
{
// 获取标签列表
apiv1.GET("/tags", v1.GetTags)
// 新建标签
apiv1.POST("/tags", v1.AddTag)
// 更新指定标签
apiv1.PUT("/tag/:id", v1.EditTag)
// 删除指定标签
apiv1.DELETE("/tag/:id", v1.DeleteTag)
}
return r
}
当前目录结构体:
检验路由是否注册成功
go run main.go
下载依赖包
首先我们要拉取validation的依赖包,在后面的接口里会使用到表单验证
go get -u github.com/astaxie/beego/validation
编写标签列表的models逻辑
创建models目录下的tag.go,写入文件内容:
package models
type Tag struct {
Model
Name string `json:"name"`
CreatedBy string `json:"created_by"`
ModifiedBy string `json:"modified_by"`
State int `json:"state"`
}
func GetTags(pageNum, pageSize int, maps any) (tags []Tag) {
db.Where(maps).Limit(pageSize).Offset(pageNum).Find(&tags)
return
}
func GetTagTotal(maps any) (count int64) {
db.Model(&Tag{}).Where(maps).Count(&count)
return
}
- 我们创建了一个Tag struct{},用于Gorm的使用。并给予了附属属性json,这样子在c.JSON的时候就会自动转换格式,非常的便利
- 可能会有的初学者看到return,而后面没有跟着变量,会不理解;其实你可以看到在函数末端,我们已经显示声明了返回值,这个变量在函数体内也可以直接使用,因为他在一开始就被声明了
- 有人会疑惑db是哪里来的;因为在同个models包下,因此db *gorm.DB是可以直接使用的
编写标签列表的路由逻辑
打开routers目录下v1版本的tag.go,第一我们先编写获取标签列表的接口
修改文件内容:
package v1
import (
"gin_log/models"
"gin_log/pkg/e"
"gin_log/pkg/setting"
"gin_log/pkg/util"
"github.com/gin-gonic/gin"
"github.com/unknwon/com"
"net/http"
)
// GetTags 获取多个文章标签
func GetTags(ctx *gin.Context) {
name := ctx.Query("name")
maps := make(map[string]any)
data := make(map[string]any)
if name != "" {
maps["name"] = name
}
var state int = -1
if arg := ctx.Query("state"); arg != "" {
state = com.StrTo(arg).MustInt()
maps["state"] = state
}
code := e.SUCCESS
data["list"] = models.GetTags(util.GetPage(ctx), setting.PageSize, maps)
data["total"] = models.GetTagTotal(maps)
ctx.JSON(http.StatusOK, gin.H{
"code": code,
"msg": e.GetMsg(code),
"data": data,
})
}
- c.Query可用于获取?name=test&state=1这类URL参数,而c.DefaultQuery则支持设置一个默认值
- code变量使用了e模块的错误编码,这正是先前规划好的错误码,方便排错和识别记录
- util.GetPage保证了各接口的page处理是一致的
- c *gin.Context是Gin很重要的组成部分,可以理解为上下文,它允许我们在中间件之间传递变量,管理流程,验证请求的json和呈现json响应
在本机执行curl 127.0.0.1:8000/api/v1/tags,正确的返回值为{"code":200,"data":{"lists":[],"total":0},"msg":"ok"},若存在问题请结合gin结果进行拍错。
在获取标签列表接口中,我们可以根据name、state、page来筛选查询条件,分页的步长可通过app.ini进行配置,以lists、total的组合返回达到分页效果。
编写新增标签的models逻辑
接下来我们编写新增标签的接口
打开models目录下tag.go,修改文件(增加2个方法):
func ExitTagByName(name string) bool {
var tag Tag
db.Select("id").Where("name = ?", name).Take(&tag)
return tag.ID > 0
}
func AddTag(name string, state int, createdBy string) bool {
db.Create(&Tag{
Name: name,
State: state,
CreatedBy: createdBy,
})
return true
}
编写新增标签的路由逻辑
打开routers目录下v1下的tag.go,修改文件(变动AddTag方法):
// AddTag 新增文章标签
func AddTag(ctx *gin.Context) {
name := ctx.Query("name")
state := com.StrTo(ctx.DefaultQuery("state", "0")).MustInt()
createBy := ctx.Query("created_by")
valid := validation.Validation{}
valid.Required(name, "name").Message("名称不能为空")
valid.MaxSize(name, 100, "name").Message("名称最长为100字符")
valid.Required(createBy, "create_by").Message("创建人不能为空")
valid.MaxSize(createBy, 100, "created_by").Message("创建人最长为100字符")
valid.Range(state, 0, 1, "state").Message("状态只允许0或1")
var code = e.INVALID_PARAMS
if !valid.HasErrors() {
if !models.ExitTagByName(name) {
code = e.SUCCESS
models.AddTag(name, state, createBy)
}else {
code = e.ERROR_EXIST_TAG
}
}else{
for _, err := range valid.Errors {
log.Println(err.Key, err.Message)
}
}
ctx.JSON(http.StatusOK, gin.H{
"code": code,
"msg": e.GetMsg(code),
"data": make(map[string]string),
})
}
用Postman用POST访问http://127.0.0.1:8000/api/v1/tags?name=1&state=1&created_by=test,查看code是否返回200及blog_tag表中是否有值,有值则正确。
编写models callbacks
但是这个时候大家会发现,我明明新增了标签,但created_on居然没有值,那做修改标签的时候modified_on会不会也存在这个问题?
为了解决这个问题,我们需要打开models目录下的tag.go文件,修改文件内容(修改包引用和增加2个方法):
func (t *Tag) BeforeCreate(tx *gorm.DB) error {
t.CreatedOn = time.Now().Unix()
return nil
}
func (t *Tag) AfterUpdate(tx *gorm.DB) error {
// UpdateColumn会忽略钩子
tx.Model(&Tag{}).Where("id = ?", t.ID).UpdateColumn("updated_on", time.Now().Unix())
return nil
}
gorm钩子函数官方文档
重启服务,再在用Postman用POST访问http://127.0.0.1:8000/api/v1/tags?name=2&state=1&created_by=test,发现created_on已经有值了!
在这几段代码中,涉及到知识点:
这属于gorm的Callbacks,可以将回调方法定义为模型结构的指针,在创建、更新、查询、删除时将被调用,如果任何回调返回错误,gorm将停止未来操作并回滚所有更改。
gorm所支持的回调方法:
- 创建:BeforeSave、BeforeCreate、AfterCreate、AfterSave
- 更新:BeforeSave、BeforeUpdate、AfterUpdate、AfterSave
- 删除:BeforeDelete、AfterDelete
- 查询:AfterFind
编写其余接口的路由逻辑
接下来,我们一口气把剩余的两个接口(EditTag、DeleteTag)完成吧
打开routers目录下v1版本的tag.go文件,修改内容:
EditTag:
// EditTag 修改文章标签
func EditTag(ctx *gin.Context) {
id := com.StrTo(ctx.Param("id")).MustInt()
name := ctx.Query("name")
modifiedBy := ctx.Query("modified_by")
valid := validation.Validation{}
state := -1
if arg := ctx.Query("state"); arg != "" {
state = com.StrTo(arg).MustInt()
valid.Range(state, 0, 1, "state").Message("状态只允许0或1")
}
valid.Required(id, "id").Message("ID不能为空")
valid.Required(modifiedBy, "modified_by").Message("修改人不能为空")
valid.MaxSize(modifiedBy, 100, "modified_by").Message("修改人最长为100字符")
valid.MaxSize(name, 100, "name").Message("名称最长为100个字符")
code := e.INVALID_PARAMS
if !valid.HasErrors() {
code = e.SUCCESS
if models.ExitTagById(id) {
data := make(map[string]any)
data["id"] = id
data["modified_by"] = modifiedBy
if name != "" {
data["name"] = name
}
if state != -1 {
data["state"] = state
}
models.EditTag(id, data)
}else {
code = e.ERROR_NOT_EXIST_TAG
}
}else{
for _, err := range valid.Errors {
log.Println(err.Key, err.Message)
}
}
ctx.JSON(http.StatusOK, gin.H{
"code": code,
"msg": e.GetMsg(code),
"data": make(map[string]string),
})
}
DeleteTag:
// DeleteTag 删除文章标签
func DeleteTag(ctx *gin.Context) {
id := com.StrTo(ctx.Param("id")).MustInt()
valid := validation.Validation{}
valid.Min(id, 1, "id").Message("ID必须大于0")
code := e.INVALID_PARAMS
if !valid.HasErrors() {
code = e.SUCCESS
if models.ExitTagById(id) {
models.DeleteTag(id)
}else{
code = e.ERROR_NOT_EXIST_TAG
}
}else{
for _, err := range valid.Errors {
log.Println(err.Key, err.Message)
}
}
ctx.JSON(http.StatusOK, gin.H{
"code": code,
"msg": e.GetMsg(code),
"data": make(map[string]string),
})
}
编写更新和删除接口的models逻辑
func ExitTagById(id int) bool {
var tag Tag
db.Select("id").Where("id = ?", id).Take(&tag)
return tag.ID > 0
}
func EditTag(id int, data any) bool {
db.Model(&Tag{}).Where("id = ?", id).Updates(data)
return true
}
func DeleteTag(id int) bool {
db.Delete(&Tag{}, id)
return true
}
验证功能
重启服务,用Postman
- PUT访问http://127.0.0.1:8000/api/v1/tags/1?name=edit1&state=0&modified_by=edit1,查看code是否返回200
- DELETE访问http://127.0.0.1:8000/api/v1/tags/1,查看code是否返回200
至此,Tag的API’s完成,下一节我们将开始Article的API’s编写!