驱动开发
适用场景:新增第三方数据库驱动、对已有驱动进行定制化、实现自定义回调处理等。
接口文档:https://godoc.org/github.com/gogf/gf/database/gdb#Driver
开发者自定义的驱动需要实现以下接口:
其中的New
方法用于根据Core
数据库基础对象以及ConfigNode
配置对象创建驱动对应的数据库操作对象,需要注意的是,返回的数据库对象需要实现DB
接口。而数据库基础对象Core
已经实现了DB
接口,因此开发者只需要”继承”Core
对象,然后根据需要覆盖对应的接口实现方法即可。
DB
接口
DB
接口是数据库操作的核心接口,这里主要对接口的几个重要方法做说明:
Open
方法用于创建特定的数据库连接对象,返回的是标准库的*sql.DB
通用数据库对象。Do*
系列方法的第一个参数为Link
接口对象,该对象在master-slave
模式下可能是一个主节点对象,也可能是从节点对象,因此如果在继承的驱动对象实现中使用该link
参数时,注意当前的运行模式。slave
节点在大部分的数据库主从模式中往往是不可写的。HandleSqlBeforeCommit
方法将会在每一条SQL
提交给数据库服务端执行时被调用做一些提交前的回调处理。
通过以下方法注册自定义驱动到gdb
模块:
其中的驱动名称name
可以是已有的驱动名称,例如mysql
, mssql
, pgsql
等等,当出现同名的驱动注册时,新的驱动将会覆盖老的驱动。
新增一个第三方的驱动到gdb
模块中非常简单,可以参考gdb
模块源码中已对接的数据库类型代码示例:
- https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_mysql.go
- https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_pgsql.go
- 更多: https://github.com/gogf/gf/blob/master/database/gdb
为简化示例编写,我们这里实现了一个自定义的MySQL
驱动,该驱动继承于gdb
模块中已经实现的DriverMysql
,并按照需要修改覆盖相应的接口方法。由于所有的SQL
语句执行必定会通过DoQuery
或者DoExec
接口,因此我们在自定义的驱动中实现并覆盖这两个接口方法即可。
我们看到,这里在包初始化方法init
中使用了gdb.Register("MyDriver", &MyDriver{})
来注册了了一个自定义名称的驱动。我们也可以通过gdb.Register("mysql", &MyDriver{})
来覆盖已有的框架mysql
驱动为自己的驱动。
由于这里我们使用了一个新的驱动名称MyDriver
,因此在gdb
配置中的type
数据库类型时,需要填写该驱动名称。以下是一个使用配置的示例: