使用 xorm 实现多数据库支持坑点总结

如果你想让你的 go 项目支持不同类型的数据库如：MySQL，PostgreSQL，sqlite3… 那么除了使用 orm 框架帮你屏蔽很多 sql 细节外，还有什么坑点呢？最近我正在使用 xorm 做多数据库类型的适配总结了以下问题供参考。

PS: 本人除了对 MySQL 熟悉外，其他数据库仅停留在使用和了解阶段，当前测试仅覆盖 MySQL，PostgreSQL，sqlite3 三种类型

初始化

以往我们进行数据库初始化一般就是导入需要初始化执行的 sql 文件，但由于需要支持多库，则无法使用功能，因为各个数据库结构不同，我们需要使用 xorm 的功能进行初始化操作。

engine, err := xorm.NewEngine(driver, connection)  
if err != nil {  
 return err
}  
  
if err = engine.Ping(); err != nil {  
 return err  
}  
  
err = engine.Sync(tables...)  
if err != nil {  
 return err  
}

tables = []interface{}{  
 &entity.User{},  
 &entity.Goods{},
}

使用 Sync 就可以将我们实体类对象创建为对应的表。

注意点

Sync 只会做创建表的操作，或者是创建表字段的操作，对于已有的表结构中的字段无法进行修改
实体类必须包含相关字段 tag 标识用于识别为字段名称类型等

字段

type User struct {
	ID        int       `xorm:"not null pk autoincr INT(11) id"`
	CreatedAt time.Time `xorm:"created TIMESTAMP created_at"`
	UpdatedAt time.Time `xorm:"updated TIMESTAMP updated_at"`
	Username  string    `xorm:"not null default '' VARCHAR(50) UNIQUE username"`
	Password  string    `xorm:"not null default '' VARCHAR(100) password"`
	IsAdmin   bool      `xorm:"not null default false BOOL is_admin"`
}

对于字段，只需要根据 xorm 文档中给出的规范，写好对应的 tag 就可以 https://xorm.io/zh/docs/chapter-02/4.columns/

注意点

不同数据库中字段的类型不同，在 tag 中一定要书写 xorm 的类型，而非数据库的类型，比如上述所示中写的是 BOOL 在 MYSQL 中识别为 TINYINT/INT ，在 sqlite3 中为 INTEGER，在 postgres 中为 BIGSERIAL
特别注意字符串的是否非空，由于 go 中 string 默认为 “”