Go每日一库：使用sqlx批量插入数据
以下文章来源于李文周 ，作者七米老师
一个北漂程序员的自我更新之旅。
使用sqlx批量插入数据
在项目中我们通常可能会使用database/sql连接MySQL数据库。sqlx可以认为是Go语言内置database/sql的超集，它在优秀的内置database/sql基础上提供了一组扩展。这些扩展中除了大家常用来查询的Get(dest interface{}, ...) error和Select(dest interface{}, ...) error外还有很多其他强大的功能。
本文借助使用sqlx实现批量插入数据的例子，介绍了sqlx中可能被你忽视了的sqlx.In和DB.NamedExec方法。
库地址：https://github.com/jmoiron/sqlx，Star 数：8.1k+
前置条件
连接数据库
var DB *sqlx.DBfunc initDB() (err error) {dsn := "username:password@tcp(127.0.0.1:3306)/sqlx_demo"// 也可以使用MustConnect连接不成功就panicDB, err = sqlx.Connect("mysql", dsn)if err != nil {fmt.Printf("connect DB failed, err:%v\n", err)return}fmt.Println("connecting to MySQL...")return}
表结构
CREATE TABLE `user` (`id` BIGINT(20) NOT NULL AUTO_INCREMENT,`name` VARCHAR(20) DEFAULT '',`age` INT(11) DEFAULT '0',PRIMARY KEY(`id`))ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4;
结构体
type User struct {Name string `db:"name"`Age int `db:"age"`}
bindvars（绑定变量）
查询占位符?在内部称为bindvars（查询占位符）,它非常重要。你应该始终使用它们向数据库发送值，因为它们可以防止SQL注入攻击。database/sq不尝试对查询文本进行任何验证；它与编码的参数一起按原样发送到服务器。除非驱动程序实现一个特殊的接口，否则在执行之前，查询是在服务器上准备的。因此bindvars是特定于数据库的:
MySQL中使用 ?PostgreSQL使用枚举的 $1、$2等bindvar语法SQLite中 ?和$1的语法都支持Oracle中使用 :name的语法
其他数据库可能有所不同。可以使用sqlx.DB.Rebind(string) string函数和?的bindvar语法去获取适合在当前数据库类型上执行的查询语句。
bindvars的一个常见误解是，它们用于在语句中插入值。它们仅用于参数化，不允许更改SQL语句的结构。例如，使用bindvars尝试参数化列或表名将不起作用：
// ？不能用来插入表名（做SQL语句中表名的占位符）db.Query("SELECT * FROM ?", "mytable")// ？也不能用来插入列名（做SQL语句中列名的占位符）db.Query("SELECT ?, ? FROM people", "name", "location")
如何实现批量插入呢？
自己拼接语句实现批量插入
比较笨，但是很好理解。就是有多少个User就拼接多少个(?, ?)。
// BatchInsertUsers 自行构造批量插入的语句func BatchInsertUsers(users []*User) error {// 存放 (?, ?) 的slicevalueStrings := make([]string, 0, len(users))// 存放values的slicevalueArgs := make([]interface{}, 0, len(users) * 2)// 遍历users准备相关数据for _, u := range users {// 此处占位符要与插入值的个数对应valueStrings = append(valueStrings, "(?, ?)")valueArgs = append(valueArgs, u.Name)valueArgs = append(valueArgs, u.Age)}// 自行拼接要执行的具体语句stmt := fmt.Sprintf("INSERT INTO user (name, age) VALUES %s",strings.Join(valueStrings, ","))_, err := DB.Exec(stmt, valueArgs...)return err}
使用sqlx.In实现批量插入
前提是需要我们的结构体实现driver.Valuer接口：
func (u User) Value() (driver.Value, error) {return []interface{}{u.Name, u.Age}, nil}
使用sqlx.In实现批量插入代码如下：
// BatchInsertUsers2 使用sqlx.In帮我们拼接语句和参数, 注意传入的参数是[]interface{}func BatchInsertUsers2(users []interface{}) error {query, args, _ := sqlx.In("INSERT INTO user (name, age) VALUES (?), (?), (?)",users..., // 如果arg实现了 driver.Valuer, sqlx.In 会通过调用 Value()来展开它)fmt.Println(query) // 查看生成的querystringfmt.Println(args) // 查看生成的args_, err := DB.Exec(query, args...)return err}
使用NamedExec实现批量插入
**注意：**该功能目前有人已经推了#285 PR，但是还没有发release，所以需要暂时使用master分支的代码：
在项目目录下执行以下命令使用master分支代码：
go get github.com/jmoiron/sqlx@master使用NamedExec实现批量插入的代码如下：
// BatchInsertUsers3 使用NamedExec实现批量插入func BatchInsertUsers3(users []*User) error {_, err := DB.NamedExec("INSERT INTO user (name, age) VALUES (:name, :age)", users)return err}
把上面三种方法综合起来试一下：
func main() {err := initDB()if err != nil {panic(err)}defer DB.Close()u1 := User{Name: "七米", Age: 18}u2 := User{Name: "q1mi", Age: 28}u3 := User{Name: "小王子", Age: 38}// 方法1users := []*User{&u1, &u2, &u3}err = BatchInsertUsers(users)if err != nil {fmt.Printf("BatchInsertUsers failed, err:%v\n", err)}// 方法2users2 := []interface{}{u1, u2, u3}err = BatchInsertUsers2(users2)if err != nil {fmt.Printf("BatchInsertUsers2 failed, err:%v\n", err)}// 方法3users3 := []*User{&u1, &u2, &u3}err = BatchInsertUsers3(users3)if err != nil {fmt.Printf("BatchInsertUsers3 failed, err:%v\n", err)}}
sqlx.In的查询示例
关于sqlx.In这里再补充一个用法，在sqlx查询语句中实现In查询和FIND_IN_SET函数。即实现SELECT * FROM user WHERE id in (3, 2, 1);和SELECT * FROM user WHERE id in (3, 2, 1) ORDER BY FIND_IN_SET(id, '3,2,1');。
in查询
查询id在给定id集合中的数据。
// QueryByIDs 根据给定ID查询func QueryByIDs(ids []int)(users []User, err error){// 动态填充idquery, args, err := sqlx.In("SELECT name, age FROM user WHERE id IN (?)", ids)if err != nil {return}// sqlx.In 返回带 `?` bindvar的查询语句, 我们使用Rebind()重新绑定它query = DB.Rebind(query)err = DB.Select(&users, query, args...)return}
in查询和FIND_IN_SET函数
查询id在给定id集合的数据并维持给定id集合的顺序。
// QueryAndOrderByIDs 按照指定id查询并维护顺序func QueryAndOrderByIDs(ids []int)(users []User, err error){// 动态填充idstrIDs := make([]string, 0, len(ids))for _, id := range ids {strIDs = append(strIDs, fmt.Sprintf("%d", id))}query, args, err := sqlx.In("SELECT name, age FROM user WHERE id IN (?) ORDER BY FIND_IN_SET(id, ?)", ids, strings.Join(strIDs, ","))if err != nil {return}// sqlx.In 返回带 `?` bindvar的查询语句, 我们使用Rebind()重新绑定它query = DB.Rebind(query)err = DB.Select(&users, query, args...)return}
当然，在这个例子里面你也可以先使用IN查询，然后通过代码按给定的ids对查询结果进行排序。
参考链接：
Illustrated guide to SQLX：http://jmoiron.github.io/sqlx/
推荐阅读
喜欢本文的朋友，欢迎关注“Go语言中文网”：
Go语言中文网启用微信学习交流群，欢迎加微信：274768166，投稿亦欢迎