优秀的编程知识分享平台

网站首页 > 技术文章 正文

Go Web 框架 Gin 实践4—Gin搭建Blog API's (三)

nanyue 2024-09-09 04:58:14 技术文章 9 ℃

Go语言中文网,致力于每日分享编码知识,欢迎关注我,会有意想不到的收获!

编写Article的API's、Models

项目地址:https://github.com/EDDYCJY/go-gin-example

定义接口

本节编写文章的逻辑,我们定义一下接口吧!

  • 获取文章列表:GET("/articles")
  • 获取指定文章:POST("/articles/:id")
  • 新建文章:POST("/articles")
  • 更新指定文章:PUT("/articles/:id")
  • 删除指定文章:DELETE("/articles/:id")

编写路由逻辑

在routers的v1版本下,新建article.go文件,写入内容:

我们打开routers下的router.go文件,修改文件内容为:

当前目录结构:

在基础的路由规则配置结束后,我们开始编写我们的接口吧!


编写models逻辑 创建models目录下的article.go,写入文件内容:

我们创建了一个Article struct {},与Tag不同的是,Article多了几项

  1. gorm:index,用于声明这个字段为索引,如果你使用了自动迁移功能则会有所影响,在不使用则无影响
  2. Tag字段,实际是一个嵌套的struct,它利用TagID与Tag模型相互关联,在执行查询的时候,能够达到Article、Tag关联查询的功能
  3. time.Now().Unix() 返回当前的时间戳

接下来,请确保已对上一章节的内容通读且了解,由于逻辑偏差不会太远,我们本节直接编写这五个接口


打开models目录下的article.go,修改文件内容:

在这里,我们拿出三点不同来讲

1、 我们的Article是如何关联到Tag???

func GetArticle(id int) (article Article) {
	db.Where("id = ?", id).First(&article)
	db.Model(&article).Related(&article.Tag)
	return 
}

能够达到关联,首先是gorm本身做了大量的约定俗成

  • Article有一个结构体成员是TagID,就是外键。gorm会通过类名+ID的方式去找到这两个类之间的关联关系
  • Article有一个结构体成员是Tag,就是我们嵌套在Article里的Tag结构体,我们可以通过Related进行关联查询

2、 Preload是什么东西,为什么查询可以得出每一项的关联Tag?

Preload就是一个预加载器,它会执行两条SQL,分别是SELECT * FROM blog_articles;和SELECT * FROM blog_tag WHERE id IN (1,2,3,4);,那么在查询出结构后,gorm内部处理对应的映射逻辑,将其填充到Article的Tag中,会特别方便,并且避免了循环查询

那么有没有别的办法呢,大致是两种

  • gorm的Join
  • 循环Related

综合之下,还是Preload更好,如果你有更优的方案,欢迎说一下 :)

3、 v.(I) 是什么?

v表示一个接口值,I表示接口类型。这个实际就是Golang中的类型断言,用于判断一个接口值的实际类型是否为某个类型,或一个非接口值的类型是否实现了某个接口类型


打开routers目录下v1版本的article.go文件,修改文件内容:

当前目录结构:

验证功能

我们重启服务,执行go run main.go,检查控制台输出结果

使用Postman检验接口是否正常(大家可以选用合适的参数传递方式,此处为了方便展示我选用了URL传参),

  • POST:http://127.0.0.1:8000/api/v1/articles?tag_id=1&title=test1&desc=test-desc&content=test-content&created_by=test-created&state=1
  • GET:http://127.0.0.1:8000/api/v1/articles
  • GET:http://127.0.0.1:8000/api/v1/articles/1
  • PUT:http://127.0.0.1:8000/api/v1/articles/1?tag_id=1&title=test-edit1&desc=test-desc-edit&content=test-content-edit&modified_by=test-created-edit&state=0
  • DELETE:http://127.0.0.1:8000/api/v1/articles/1

至此,我们的API's编写就到这里,下一节我们将介绍另外的一些技巧!

参考

本系列示例代码

  • go-gin-example

本系列作者:煎鱼,原创授权发布

Tags:

最近发表
标签列表