使用xorm工具，根據數據庫自動生成 go 代碼

使用xorm工具，根據數據庫自動生成 go 代碼

引入

使用 golang 操做數據庫的同窗都會遇到一個問題 —— 根據數據表結構建立對應的 struct 模型。由於 golang 的使用首字母控制可見範圍，咱們常常要設計 struct 字段名和數據庫字段名的對應關係。長此以往，這是一個很是繁瑣的過程。事情變得繁瑣了，咱們都會想，有沒有好的辦法自動生成 model 呢？今天，記錄一種自動生成代碼的方法 —— xorm 工具。

關於 xorm

xorm是一個簡單而強大的Go語言ORM庫. 經過它能夠使數據庫操做很是簡便。我在項目中常用，它的特性以下：

• 支持Struct和數據庫表之間的靈活映射，並支持自動同步表結構
• 事務支持
• 支持原始SQL語句和ORM操做的混合執行
• 使用連寫來簡化調用
• 支持使用Id, In, Where, Limit, Join, Having, Table, Sql, Cols等函數和結構體等方式做爲條件
• 支持級聯加載Struct
• 支持LRU緩存(支持memory, memcache, leveldb, redis緩存Store) 和 Redis緩存
• 支持反轉，即根據數據庫自動生成xorm的結構體
• 支持事件
• 支持created, updated, deleted和version記錄版本（即樂觀鎖）

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

xorm 工具

xorm 是一組數據庫操做命令的工具，包含以下命令：

• reverse 反轉一個數據庫結構，生成代碼
• shell 通用的數據庫操做客戶端，可對數據庫結構和數據操做
• dump Dump數據庫中全部結構和數據到標準輸出
• source 從標註輸入中執行SQL文件
• driver 列出全部支持的數據庫驅動

那咱們該如何使用 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 , 免去了手寫的繁瑣過程。

總結

照例總結一波，引用看到過一句話：

若是一個工具能讓我節省 1s 的時間，我願意花一天的時間去找或者開發這個工具！