使用xorm工具，根据数据库自动生成 go 代码

使用xorm工具，根据数据库自动生成 go 代码

引入

使用 golang 操作数据库的同学都会遇到一个问题 —— 根据数据表结构创建对应的 struct 模型。因为 golang 的使用首字母控制可见范围，我们经常要设计 struct 字段名和数据库字段名的对应关系。久而久之，这是一个非常繁琐的过程。事情变得繁琐了，我们都会想，有没有好的办法自动生成 model 呢？今天，记录一种自动生成代码的方法 —— xorm 工具。

关于 xorm

xorm是一个简单而强大的Go语言ORM库. 通过它可以使数据库操作非常简便。我在项目中经常使用，它的特性如下：


想了解更多请移步：http://www.xorm.io/

xorm 工具

xorm 是一组数据库操作命令的工具，包含如下命令：


那我们该如何使用 reverse 命令根据数据表结构生成 go 代码呢？

首先我们要下载该工具 ：

go get github.com/go-xorm/cmd/xorm

同时需要安装对应的 driver :

go get github.com/go-sql-driver/mysql  //MyMysql
go get github.com/ziutek/mymysql/godrv  //MyMysql
go get github.com/lib/pq  //Postgres
go get github.com/mattn/go-sqlite3  //SQLite

还需要下载 xorm ：

go get github.com/go-xorm/xorm

编译

cmd/xorm

会生成 xorm 工具， 假如环境变量。

这时候，执行

xorm help reverse

能获取帮助信息如下：

usage: xorm reverse [-s] driverName datasourceName tmplPath [generatedPath] [tableFilterReg]

according database's tables and columns to generate codes for Go, C++ and etc.

-s                Generated one go file for every table
driverName        Database driver name, now supported four: mysql mymysql sqlite3 postgres
datasourceName    Database connection uri, for detail infomation please visit driver's project page
tmplPath          Template dir for generated. the default templates dir has provide 1 template
generatedPath     This parameter is optional, if blank, the default value is model, then will
generated all codes in model dir
tableFilterReg    Table name filter regexp

可以知道，执行参数 -s 表示为每张表创建一个单独文件。接下来的参数依次是：驱动，数据源，模板目录（在源码的

/cmd/xorm/templates/goxorm

可根据需求定制），生成目录，表格过滤条件。

接下来我们以 Mysql 为例介绍使用方法。

xorm reverse mysql name:password@(ip:port)/xxx?charset=utf8 /cmd/xorm/templates/goxorm

这里输出目录参数省略，会在当前目录建立一个

model

目录，该目录下就是自动生成的 go 代码,， 驼峰命名方式。具体内容如下：

package model

type TestModel struct {
Id            int    `json:"id" xorm:"not null pk autoincr INT(11)"`
VpsName       string `json:"vps_name" xorm:"VARCHAR(30)"`
VpsIp         string `json:"vps_ip" xorm:"CHAR(15)"`
VpsPrivateIp  string `json:"vps_private_ip" xorm:"CHAR(50)"`
VpsCpu        int    `json:"vps_cpu" xorm:"INT(11)"`
VpsMem        int    `json:"vps_mem" xorm:"INT(11)"`
VpsDisk       int    `json:"vps_disk" xorm:"INT(11)"`
VpsStatus     string `json:"vps_status" xorm:"VARCHAR(255)"`
LastHeartTime int    `json:"last_heart_time" xorm:"INT(11)"`
CreateTime    int    `json:"create_time" xorm:"INT(11)"`                                                       LastTime      int    `json:"last_time" xorm:"INT(11)"`
}

到这里，就生成了我们想要的 model , 免去了手写的繁琐过程。

总结

照例总结一波，引用看到过一句话：