【goframe】ORM驅動開發

原文: https://www.bookstack.cn/read/GoFrame-1.13/database-gdb-driver.md

驅動開發

默認情況下,gdb模塊已經提供了一些常用的驅動支持,並允許開發者對接自定義的數據庫驅動。

適用場景:新增第三方數據庫驅動、對已有驅動進行定製化、實現自定義回調處理等。

驅動接口

Driver接口

接口文檔:https://godoc.org/github.com/gogf/gf/database/gdb#Driver

開發者自定義的驅動需要實現以下接口:

  1. // Driver is the interface for integrating sql drivers into package gdb.
  2. type Driver interface {
  3. // New creates and returns a database object for specified database server.
  4. New(core *Core, node *ConfigNode) (DB, error)
  5. }

其中的New方法用於根據Core數據庫基礎對象以及ConfigNode配置對象創建驅動對應的數據庫操作對象,需要注意的是,返回的數據庫對象需要實現DB接口。而數據庫基礎對象Core已經實現了DB接口,因此開發者只需要”繼承”Core對象,然後根據需要覆蓋對應的接口實現方法即可。

DB接口

接口文檔:https://godoc.org/github.com/gogf/gf/database/gdb#DB

DB接口是數據庫操作的核心接口,這裏主要對接口的幾個重要方法做說明:

  1. Open方法用於創建特定的數據庫連接對象,返回的是標準庫的*sql.DB通用數據庫對象。
  2. Do*系列方法的第一個參數linkLink接口對象,該對象在master-slave模式下可能是一個主節點對象,也可能是從節點對象,因此如果在繼承的驅動對象實現中使用該link參數時,注意當前的運行模式。slave節點在大部分的數據庫主從模式中往往是不可寫的。
  3. HandleSqlBeforeCommit方法將會在每一條SQL提交給數據庫服務端執行時被調用做一些提交前的回調處理。
  4. 其他接口方法詳見接口文檔或者源碼文件。

驅動註冊

通過以下方法註冊自定義驅動到gdb模塊:

  1. // Register registers custom database driver to gdb.
  2. func Register(name string, driver Driver) error

其中的驅動名稱name可以是已有的驅動名稱,例如mysql, mssql, pgsql等等,當出現同名的驅動註冊時,新的驅動將會覆蓋老的驅動。

新增第三方驅動

新增一個第三方的驅動到gdb模塊中非常簡單,可以參考gdb模塊源碼中已對接的數據庫類型代碼示例:

  1. https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_mysql.go
  2. https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_mssql.go
  3. https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_pgsql.go
  4. https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_oracle.go
  5. https://github.com/gogf/gf/blob/master/database/gdb/gdb_driver_sqlite.go
  6. 更多: https://github.com/gogf/gf/blob/master/database/gdb

自定義回調處理

我們來看一個自定義回調處理的示例,我們需要將所有執行的SQL語句記錄到monitor表中,以方便於進行SQL審計。

爲簡化示例編寫,我們這裏實現了一個自定義的MySQL驅動,該驅動繼承於gdb模塊中已經實現的DriverMysql,並按照需要修改覆蓋相應的接口方法。由於所有的SQL語句執行必定會通過DoQuery或者DoExec接口,因此我們在自定義的驅動中實現並覆蓋這兩個接口方法即可。

  1. package driver
  2. import (
  3. "database/sql"
  4. "github.com/gogf/gf/database/gdb"
  5. "github.com/gogf/gf/frame/g"
  6. "github.com/gogf/gf/os/gtime"
  7. )
  8. // MyDriver is a custom database driver, which is used for testing only.
  9. // For simplifying the unit testing case purpose, MyDriver struct inherits the mysql driver
  10. // gdb.DriverMysql and overwrites its functions DoQuery and DoExec.
  11. // So if there's any sql execution, it goes through MyDriver.DoQuery/MyDriver.DoExec firstly
  12. // and then gdb.DriverMysql.DoQuery/gdb.DriverMysql.DoExec.
  13. // You can call it sql "HOOK" or "HiJack" as your will.
  14. type MyDriver struct {
  15. *gdb.DriverMysql
  16. }
  17. func init() {
  18. // It here registers my custom driver in package initialization function "init".
  19. // You can later use this type in the database configuration.
  20. if err := gdb.Register("MyDriver", &MyDriver{}); err != nil {
  21. panic(err)
  22. }
  23. }
  24. // New creates and returns a database object for mysql.
  25. // It implements the interface of gdb.Driver for extra database driver installation.
  26. func (d *MyDriver) New(core *gdb.Core, node *gdb.ConfigNode) (gdb.DB, error) {
  27. return &MyDriver{
  28. &gdb.DriverMysql{
  29. Core: core,
  30. },
  31. }, nil
  32. }
  33. // DoQuery commits the sql string and its arguments to underlying driver
  34. // through given link object and returns the execution result.
  35. func (d *MyDriver) DoQuery(link gdb.Link, sql string, args ...interface{}) (rows *sql.Rows, err error) {
  36. tsMilli := gtime.TimestampMilli()
  37. rows, err = d.DriverMysql.DoQuery(link, sql, args...)
  38. if _, err := d.DriverMysql.InsertIgnore("monitor", g.Map{
  39. "sql": gdb.FormatSqlWithArgs(sql, args),
  40. "cost": gtime.TimestampMilli() - tsMilli,
  41. "time": gtime.Now(),
  42. "error": err.Error(),
  43. }); err != nil {
  44. panic(err)
  45. }
  46. return
  47. }
  48. // DoExec commits the query string and its arguments to underlying driver
  49. // through given link object and returns the execution result.
  50. func (d *MyDriver) DoExec(link gdb.Link, sql string, args ...interface{}) (result sql.Result, err error) {
  51. tsMilli := gtime.TimestampMilli()
  52. result, err = d.DriverMysql.DoExec(link, sql, args...)
  53. if _, err := d.DriverMysql.InsertIgnore("monitor", g.Map{
  54. "sql": gdb.FormatSqlWithArgs(sql, args),
  55. "cost": gtime.TimestampMilli() - tsMilli,
  56. "time": gtime.Now(),
  57. "error": err.Error(),
  58. }); err != nil {
  59. panic(err)
  60. }
  61. return
  62. }

我們看到,這裏在包初始化方法init中使用了gdb.Register("MyDriver", &MyDriver{})來註冊了了一個自定義名稱的驅動。我們也可以通過gdb.Register("mysql", &MyDriver{})來覆蓋已有的框架mysql驅動爲自己的驅動。

驅動名稱mysql爲框架默認的DriverMysql驅動的名稱。

由於這裏我們使用了一個新的驅動名稱MyDriver,因此在gdb配置中的type數據庫類型時,需要填寫該驅動名稱。以下是一個使用配置的示例:

  1. [database]
  2. type = "MyDriver"
  3. link = "root:12345678@tcp(127.0.0.1:3306)/test"
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章