golang-xorm库快速学习

作者：ifcoder

链接：https://www.jianshu.com/p/13d46e5d2d2a

來源：简书

xorm

xorm是一个Go语言ORM库. 通过它可以使数据库操作非常简便.

全部文档点我

用法入门：

前提：定义本文中用到的struct和基本代码如下

1. 创建orm引擎

注意:若想配合mysql，需要提前加载mysql驱动，通过如此方式

自动同步表结构

Sync2会进行如下这些操作：

自动检测和创建表，这个检测是根据表的名字

自动检测和新增表中的字段，这个检测是根据字段名，同时对表中多余的字段给出警告信息

自动检测，创建和删除索引和唯一索引，这个检测是根据索引的一个或多个字段名，而不根据索引名称。因此这里需要注意，如果在一个有大量数据的表中引入新的索引，数据库可能需要一定的时间来建立索引。

自动转换varchar字段类型到text字段类型，自动警告其它字段类型在模型和数据库之间不一致的情况。

自动警告字段的默认值，是否为空信息在模型和数据库之间不匹配的情况

以上这些警告信息需要将 设置为 才会显示。

增删改操作

**增加操作：插入一条新的记录，该记录必须是未存在的，否则会返回错误：

**

删除操作：

方法 Delete 接受参数后，会自动根据传进去的值进行查找，然后删除。比如此处，我们指定了 Account 的 ID 字段，那么就会删除 ID 字段值与我们所赋值相同的记录；如果您只对 Name 字段赋值，那么 xorm 就会去查找 Name 字段值匹配的记录。如果多个字段同时赋值，则是多个条件同时满足的记录才会被删除。

删除操作针对的对象没有限制，凡是按照条件查找到的，都会被删除（单个与批量删除）。

获取和修改记录：想要修改的记录必须是提前存在的，所以修改前要先查询所要修改的记录

获取记录：

Get方法

查询单条数据使用Get方法，在调用Get方法时需要传入一个对应结构体的指针，同时结构体中的非空field自动成为查询的条件和前面的方法条件组合在一起查询。

a. 根据Id来获得单条数据:

b. 根据where获取单条数据

c. 根据Account结构体中存在的非空数据来获取单条数据

返回的结果为两个参数，一个has(bool类型)为该条记录是否存在，第二个参数err为是否有错误。不管err是否为nil，has都有可能为true或者false。

在获取到记录之后，我们就需要进行一些修改，然后更新到数据库：

注意，Update接受的参数是指针

批量获取信息

在这里，我们还调用了 Desc 方法对记录按照存款数额将账户从大到小排序。

Find方法的第一个参数为slice的指针或Map指针，即为查询后返回的结果，第二个参数可选，为查询的条件struct的指针。

乐观锁

乐观锁是 xorm 提供的一个比较实用的功能，通过在 tag 中指定 version 来开启它。开启之后，每次对记录进行更新的时候，该字段的值就会自动递增 1。如此一来，您就可以判断是否有其它地方同时修改了该记录，如果是，则应当重新操作，否则会出现错误的数据（同时对一个帐号进行取款操作却只扣了一次的数额）。

事务及回滚

废话不多说，直接上示例代码：

统计记录条数- Count方法

统计数据使用Count方法，Count方法的参数为struct的指针并且成为查询条件。

Iterate方法

Iterate方法提供逐条执行查询到的记录的方法，他所能使用的条件和Find方法完全相同

我们主要来看迭代函数的声明：它接受 2 个参数，第一个是当前记录所对应的索引（该索引和 ID 的值毫无关系，只是查询后结果的索引），第二个参数则是保存了相关类型的空接口，需要自行断言，例如示例中使用 bean.(*Account) 因为我们知道查询的结构是 Account。

查询特定字段

使用 Cols 方法可以指定查询特定字段，当只有结构中的某个字段的值对您有价值时，就可以使用它：

此处，所查询出来的结构只有 Name 字段有值，其它字段均为零值。要注意的是，Cols 方法所接受的参数是数据表中对应的名称，而不是字段名称。

排除特定字段

当您希望刻意忽略某个字段的查询结果时，可以使用 Omit 方法：

x.Omit("name").Iterate(new(Account), printFn)

此处，所查询出来的结构只有 Name 字段为零值。要注意的是，Omit 方法所接受的参数是数据表中对应的名称，而不是字段名称。

查询结果偏移

查询结果偏移在分页应用中最为常见，通过 Limit 方法可以达到一样的目的：

该方法最少接受 1 个参数，第一个参数表示取出的最大记录数；如果传入第二个参数，则表示对查询结果进行偏移。因此，此处的查询结果为偏移 2 个后，再最多取出 3 个记录。

日志记录

一般情况下，使用来开启 xorm 最基本的日志功能，所有 SQL 都会被打印到控制台，但如果您想要将日志保存到文件，则可以在获取到 ORM 引擎之后，进行如下操作：

LRU 缓存

作为唯一支持 LRU 缓存的一款 ORM，如果不知道如何使用这个特性，那将是非常遗憾。不过，想要使用它也并不困难，只需要在获取到 ORM 引擎之后，进行如下操作：

这样就算是使用最基本的缓存功能了。该功能还支持只缓存某些表或排除缓存某些表，详情可以参见 文章首部的官方文档。

事件钩子

官方一共提供了 6 类 事件钩子，示例中只演示其中 2 种：BeforeInsert 和 AfterInsert。全部内容查看文章首部官方文档

它们的作用分别会在 进行插入记录之前 和 完成插入记录之后 被调用：

func (a *Account) BeforeInsert() {

log.Printf("before insert: %s", a.Name)

}

func (a *Account) AfterInsert() {

log.Printf("after insert: %s", a.Name)

}

下面是一个简单的银行存取款的小例子

注：本文参考

Go名库讲解

官方文档

版权申明：内容来源网络，版权归原创者所有。除非无法确认，我们都会标明作者及出处，如有侵权烦请告知，我们会立即删除并表示歉意。谢谢。

Golang语言社区

ID：Golangweb

游戏服务器架构丨分布式技术丨大数据丨游戏算法学习