Go的ORM框架GORM最佳实践之不定参数的用法

写在前面
适应人群
GORM最佳实践之不定参数的用法
小结
参考

写在前面

最近一段时间的工作主要以业务逻辑编写为主，重度使用了一些Go的框架，比如Web框架Gin、ORM框架GORM、模板渲染框架Simplate等等。在高强度的情况下编写高复杂度的代码，难免会遇到各种坑（比如 Gin基数路由的局限就在我的上一篇博客中提及到了），自然而然地也会积累很多宝贵的经验，这些经验是我个人比较看重的，因此总乐意花一些时间总结。

这篇博文介绍本人非常喜欢的一个经验：不定参数（即…运算符）在GORM中的使用。

适应人群

入门√——初级——中级——高级；本文适应入门及以上。

GORM最佳实践之不定参数的用法

Go中的不定参数

在Golang的语言特性文档中，对不定参数（… 参数）进行了专门的讲解。当在函数定义中声明了一个不定参数…T（比如 func Greeting(prefix string, who ...string)）时，在函数内部就相当于有了一个类型为[]T的变量（比如在Greeting函数内，存在一个类型为[]string的who）。

如果有下面的Greeting函数：

func Greeting(prefix string, who ...string){
	fmt.Println(prefix, len(who), who)
	if len(who) > 0 {
		Greeting(prefix, who[1:]...)
	}
}

那么可以通过Greeting("nobody")和Greeting("hello:", "KiKi", "Joe", "Anna")来调用Greeting方法。对于前者用法来说，who的值为nil；对于后者用法来说，who的值为[]string{"KiKi", "Joe", "Anna"}。

这里需要注意两点：1）不能直接传入字符串切片调用Greeting("hello:", []string{"KiKi", "Joe", "Anna"})，否则编译器会报错。2）也不能这么调用Greeting(prefix, who[1:])，必须要传入who[1:]...。这两点基本上能揭露出不定参数的本质，它更像是声明运算过程而非数据类型，①当在函数声明中使用时，做的是把函数调用时传入的参数组装成为切片（slice）；②当在函数体内部传参使用时，代表的是把切片中的数据拆组成为单个元素。恩，基本上就是这样了。

GORM简介

对于一个编写Web应用的开发者，应该对ORM框架非常熟悉。比如Java中有名的Hibernate、Mybatis， Ruby中的Rails Model，Python中的SQLAlchemy，以及 Golang中的 GORM，等等。

GORM遵循Go的语言特性，可以通过配置搜索条件把数据库中的每行记录塞进结构对象或其切片中，大大提升了开发效率。

不过，如果大家查看GROM的源码，可以发现它大量使用了反射，这也引申出其效率相对低下的问题；不过在编写Web应用时，主要矛盾是产品的原型设计及其逻辑实现，代码的运行效率反而无需那么关注，毕竟产品往往在还未达到系统的性能瓶颈前，它的生命周期就结束了（衰= =）。

GROM中不定参数的最佳实践

说实话，在刚开始接触不定参数时，并不觉得它存在的必要性；平日里编写代码很少用到它，感觉它就像是一个玩具，或者像是语言的一个噱头。直到最近在使用GROM的过程中，面对复杂的业务逻辑，当model层定制的方法越来越多，总觉得力不从心。直到一次review代码时，经过我们组赖老师的指点，才算给我的代码世界又打开了一扇新大门。

先看一段代码：

// Topic 话题
type Topic struct {
	gorm.Model
	Title         string    `gorm:"index"`
	Content       string    `gorm:"type:text"`
	ViewCount     int       `json:"view_count"`
	ReplyCount    int       `json:"reply_count"`
	UserID        int       `gorm:"index" json:"user_id"`
}

// QueryByUserID 根据UserID获取话题
func (t *Topic) QueryByUserID(userID int) (topics []Topic, err error) {
	db := config.DB.Where("user_id = ?", userID).Find(&topics).Error
	return
}

为了根据用户ID（UserID）获取到相应的话题（Topic），我们定义了一个QueryByUserID 的方法，为了表意这里刻意传入了一个参数；好像这个函数已经能帮我们解决model层与controller的分离。但是如果真正使用时会发现，其实这个函数有很大的局限性：它只能获取某个UserID的所有的话题，却无法实现对这个UserID下话题的进一步筛选（比如获取最近七天发布的话题）。

那么应该如何定义这个Query函数，使得我们使用时既优雅又功能强大呢？答案便是不定参数。

试想，我们把QueryByUserID函数以如下的方式定义：

// QueryByUserID 根据UserID获取话题
func (t *Topic) QueryByUserID(userID int, args ...interface{}) (topics []Topic, err error) {
	db := config.DB.Where("user_id = ?", userID)
	if len(args) >= 2 {
		db = db.Where(args[0], args[1:]...)
	} else if len(args) >= 1 {
		db = db.Where(args[0])
	}
	err = db.Find(&topics).Error
	return
}

我们这里在QueryByUserID的最后强行添加了一个args不定参数，从而接受调用时传入的附加的参数。同时在函数体内，我们根据args的长度对它进行不同方式的应用，这就非常优雅地扩展了QueryByUserID的功能。根据GORM的特性，大量使用了Go的反射特性，查看源码后知道这种用法完全可行。

在添加了不定参数的情况下，再调用QueryByUserID的时候，想要进一步精细地搜索话题，就方便多了。比如，想要获取UserID为1且最近一周发布的话题，可以这么写了：

topics, err := (&Topic{}).QueryByUserID(1, "created_at > ?", time.Now().Add(-7*24*time.Hour)
// ... 其他对topics 与 err 的处理

非常灵活，好喜欢！

小结

本文对Go中的不定参数、GORM进行了简单的介绍，并就二者的优雅结合实践进行了描述。通过一个搜索某用户发表的话题（Topic）的例子介绍了使用GORM时加入不定参数后所带来的巨大灵活性。

通过这样一种结合，能够对不定参数以及GORM具有更深一步的认识，而认识的够深刻，开发起来就能更加得心应手了😆。

参考

Getting Started with GORM · GORM Guide GORM的官方文档
The Go Programming Language SpecificationGo官网文档中对不定参数的解释
Golang的不定参数 - CSDN博客介绍了Go中的不定参数
Gin的基数树路由局限及最佳实践介绍了Go的Web框架Gin的路由局限，以及最佳实践

进一步理解不定参数及其在GORM中的优雅应用