关于DAO
数据访问对象设计其实是关于GoFrame
框架工程化实践中比较重要一块设计。
DAO
设计结合GoFrame
的ORM
组件性能和易用性都很强,可以极大提高开发和维护效率。看完本章节内容之后,小伙伴们应该能够理解并体会到使用DAO
数据库访问对象设计的优点。
一、现有ORM
使用示例
使用作者本厂的案例举例,本厂是互联网医疗企业,所以示例以医生相关接口做示例。需要提前说明的是,这里涉及到的源码只是方便演示的示例代码,并不是真正生产使用的源码。
1、需要定义模型
用户基础表(仅作演示,真实的表有数十个字段)
医生信息表(仅作演示,真实的表有上百个字段)
2、GRPC
接口实现示例
一个简单的GRPC
查询医生信息接口。
一个简单的GRPC
数据查询接口
二、现有痛点描述
1、必须要定义tag
关联表结构与struct
属性,无法做到自动映射
表字段与实体对象属性名称之间原本就有一定的关联规则,没有必要定义和维护大量的tag
定义。
大量非必要的tag
定义,用于指定数据表字段到实体对象属性映射
2、不支持通过返回对象指定需要查询的字段
无法通过返回的对象数据结构指定查询字段,要么只能SELECT *
,要么只能通过额外的方法手动录入查询字段,效率很低下。
常见的SELECT *
操作,无法根据接口对象指定查询字段
3、无法对输入对象属性名称进行自动字段过滤
定义了输入与输出数据结构,输出的数据结构已经包含我们需要查询的字段名称。开发者输入定义的返回对象,期望在查询的时候仅查询我需要的字段名称,多余的属性则不会执行查询,自动过滤掉。
4、需要创建中间查询结果对象执行赋值转换
查询结果不支持struct
智能转换,需要额外定义一个中间model
模型,再通过其他工具进行复制,效率低。
存在中间临时的模型对象,用于承接查询结果及返回结构对象赋值转换
5、需要提前初始化返回对象,不管有无查询到数据
这种方式不仅不优雅,对性能也有影响,还对GC
不太友好。期望查询到数据时再自动创建返回对象,没有查询到数据时什么都不要做。
需要预先初始化返回对象,不管有无查询到数据
6、没有DAO
对象封装操作
大部分的Golang
初学者似乎都倾向于使用一个全局的DB
对象,在查询的时候通过DB
对象生成特定表的Model
对象再执行CURD
操作,这是一种面向过程的使用方式。这种方式并没有代码分层的设计可言,使得数据操作和业务逻辑高度耦合。
原始数据库对象操作方式,没有DAO
封装
7、太多的字符串硬编码,例如表名和字段的硬编码
举个例子,userId
这个字段假如一不小心写成了UserId
或者userid
,测试的时候如果没有完全覆盖到,在一定的条件下才触发查询操作,是不是会造成新的一场事故呢?
大量的字符串硬编码
8、不支持链路跟踪
ORM
作为关键的功能组件需要支持conetxt
传递,以便支持链路跟踪。目前无法传递链路信息,无法在日志中打印TraceId
等链路信息字段。
9、不支持SQL
日志输出
并且需要支持开关功能,当出现问题的时候可以定位到具体的SQL
,并且可以在日志中看到具体的链路信息。
三、改进方案设计
1、查询结果对象无需特殊标签定义
2、支持根据指定对象自动识别查询字段,而不是全部SELECT *
3、支持根据指定对象自动过滤不存在的字段内容
4、使用DAO
对象封装代码设计,通过对象方式操作数据表
5、DAO
对象将关联的表名及字段名进行封装,避免字符串硬编码
6、无需提前定义实体对象接受返回结果,无需创建中间实体对象用于接口返回对象的赋值转换
7、查询结果对象无需提前初始化,查询到数据时才会自动创建
8、支持context
输入,以便支持链路跟踪
9、支持SQL
日志输出能力,支持开关功能
10、数据模型、数据操作、业务逻辑解耦,支持Dao
及Model
代码工具化自动生成,提高开发效率,便于规范落地
采用DAO
设计改进后的代码示例
Content Menu