基本介绍

GoFrame框架的ORM功能由gdb模块实现，用于常用关系型数据库的ORM操作。

gdb数据库引擎底层采用了链接池设计，当链接不再使用时会自动关闭，因此链接对象不用的时候不需要显式使用Close方法关闭数据库连接。

注意：为提高数据库操作安全性，在ORM操作中不建议直接将参数拼接成SQL字符串执行，建议使用预处理的方式（充分使用?占位符）来传递SQL参数。gdb的底层实现中均采用的是预处理的方式处理开发者传递的参数，以充分保证数据库操作安全性。

接口文档：

https://pkg.go.dev/github.com/gogf/gf/v2/database/gdb

组件特性

GoFrame ORM组件具有以下显著特点：

  1. 全自动化支持嵌套事务。
  2. 面向接口化设计、易使用易扩展。
  3. 内置支持主流数据库类型驱动，并易于扩展。
  4. 强大的配置管理，使用框架统一的配置组件。
  5. 支持单例模式获取配置同一分组数据库对象。
  6. 支持原生SQL方法操作、ORM链式操作两种方式。
  7. 支持OpenTelemetry可观测性：链路跟踪、日志记录、指标上报。
  8. 通过Scan方法自动识别Map/Struct接收查询结果，自动化查询结果初始化、结构体类型转换。
  9. 通过返回结果nil识别为空，无需sql.ErrNoRows识别查询数据为空的情况。
  10. 全自动化的结构体属性-字段映射，无需显示定义结构体标签维护属性-字段映射关系。
  11. 自动化的给定Map/Struct/Slice参数类型中的字段识别、过滤，大大提高查询条件输入、结果接收。
  12. 完美支持GoFrame框架层面的DAO设计，全自动化Model/DAO代码生成，极大提高开发效率。
  13. 支持调试模式、日志输出、DryRun、自定义Handler、自动类型类型转换、自定义接口转换等等高级特性。
  14. 支持查询缓存、软删除、自动化时间更新、模型关联、数据库集群配置（软件主从模式）等等实用特性。

知识图谱

数据库ORM - 图1

GoFrame ORM Features

组件关联

数据库ORM - 图2

GoFrame ORM Dependencies

g.DB与gdb.New、gdb.Instance

获取数据库操作对象有三种方式，一种是使用g.DB方法（推荐），一种是使用原生gdb.New方法，还有一种是使用包原生单例方法gdb.Instance，而第一种是推荐的使用方式。这三种方式的区别如下：

  1. g.DB对象管理方式获取的是单例对象，整合了配置文件的管理功能，支持配置文件热更新。
  2. gdb.New是根据给定的数据库节点配置创建一个新的数据库对象(非单例)，无法使用配置文件。
  3. gdb.Instance是包原生单例管理方法，需要结合配置方法一起使用，通过分组名称(非必需)获取对应配置的数据库单例对象。

有这么多对象获取方式原因在于GoFrame是一个模块化设计的框架，每个模块皆可单独使用。

New创建数据库对象

  1. db, err := gdb.New(gdb.ConfigNode{
  2.     Link: "mysql:root:12345678@tcp(127.0.0.1:3306)/test",
  3. })

获取数据库对象单例

  1. // 获取默认配置的数据库对象(配置名称为"default")
  2. db := g.DB()
  4. // 获取配置分组名称为"user"的数据库对象
  5. db := g.DB("user")
  8. // 使用原生单例管理方法获取数据库对象单例
  9. db, err := gdb.Instance()
  10. db, err := gdb.Instance("user")

内置支持的数据库类型

由于go标准库的数据库操作对象采用接口实现，因此提供了非常好的可扩展性和兼容性。框架已支持的第三方数据库驱动请参考：https://github.com/gogf/gf/tree/master/contrib/drivers

额外接入新的数据库相当方便，可参考源码中关于PostgreSQL、SQLite、Oracle、SQL Server的接入方式。具体介绍请参考后续 ORM接口开发-驱动开发 章节。

相关文档