Skip to end of metadata
Go to start of metadata

关于DAO数据访问对象设计其实是关于GoFrame框架工程化实践中比较重要一块设计。

DAO设计结合GoFrameORM组件性能和易用性都很强,可以极大提高开发和维护效率。看完本章节内容之后,小伙伴们应该能够理解并体会到使用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、数据模型、数据操作、业务逻辑解耦,支持DaoModel代码工具化自动生成,提高开发效率,便于规范落地

采用DAO设计改进后的代码示例







Content Menu

  • No labels

11 Comments

  1. 从使用者角度给强哥提些建议,service层代码  通过   dao.table("xxx").where().find(),实际是service层在维护数据访问的逻辑,dao只是个驱动而已。建议service层只做原始数据的业务逻辑的加工,把sql的维护放在dao层。  类似于:

    userservice.getuser() { 
    
        userdao.FetchByID(UID) 
    
    }       
    
    userdao.fetchByID(uid uint64) *Userstruct  {
    
        return db.where("uid = ?").find.bindtostruct()
    
    }

     这样有两个好处,service层不用关心数据来自db还是缓存,可以在dao层做缓存控制。2是userstuct可以在包一个entity层   相当于 entity对象里套着userstruct(数据表结构体的映射结构体),因为很多业务场景往往要对原始数据做进一步加工,这层加工可以在entity层做。我以前做的phpgo项目都延用这套升级。相当于ctrl 做输入输出的校验,业务流程。  service封装业务逻辑力度尽量细,dao做数据数据访问层(sql语句)和缓存策略管理,entity做数据库对象的映射,同时支持重载底层字段。

    1. 我也算是一路踩坑过来的苦逼码农,你这个建议其实是一个经典问题,在这篇文章中有提及到:代码分层设计

      daoservice的职责边界维护其实并不容易(有时比较模糊),对于有经验的开发者来说往往并不是什么问题,问题在于团队架构是有层级的,要保证团队的每个成员都能编写好边界清晰的代码并不容易(往往很难,所以才会有技术债务和重构这一概念)。往往这个时候团队管理者需要依靠简单的逻辑去制定规范,文章中给的建议便是如此。

      你的那个FetchByID的例子放dao可以(dao设计有这样的扩展能力,其实我们也有很多dao的自定义数据接口),是否由dao来控制缓存却不能一概而论,因为dao是共用的,这得看业务场景,否则其他的开发者调用了你的接口得到一个意想不到的缓存值可能会是一个问题。好的代码管理是不需要别人深入去看你的代码逻辑就知道有没有带额外特性,如果团队明确规定dao就只是数据库CURD逻辑,而是否需要缓存由service封装具体的业务场景的逻辑来决定,设计简单便不易出错。

      service调用dao的链式操作来实现数据访问确实是将dao的职责给减轻了,却并没有限制dao的数据封装和扩展能力。写代码是一门艺术,拿捏得当就得看手艺了。

    2. 明白了。刚我看了下gf-demo源码,model和dao外面都有包一层,我光看文档了没看代码~有需要的可以在这两层做我说得工作,另外强哥说的dao是公用的,走缓存和不走缓存的find方法如果都有需要,那就应该是2个function,比如叫find 和 fetch,因为即使放到service层如果两种数据来源都需要。也是要显式区分的。因为无论来源是缓存还是数据库,对业务层来说都是数据,感觉上归到dao层以组合的方式来实现,更通顺一些

      1. 在dao的函数的输入参数里,加一个isCache字段, 

        如果service层需要从缓存里获取数据,这个字段就是1 或者 true,

        如果不需要从缓存里取数据,就传递0,或者false

        这样是否可行呢?



        1. 跟我们以前的一样我们以前是php,在daobase里组合一个cachetrait,提供2套function一套是withcache的,底层就是你说的这样用函数参数控制是否缓存。

          1. 渴望力量 ayamzh 有个Cache链式操作方法控制缓存,具体可以参考章节 ORM链式操作-查询缓存 。关于放dao还是service,我之前的回复也有建议,可作参考。

            1. 好的  谢谢   您的文档 写的很详细 很棒 (thumbs up)

          2. 嗯嗯  使用__Call( )函数,实现的     

            不使用缓存是 getUser($uid)

            使用缓存是  getUserFrom($uid)

  2. dao.TableName.Save()的方法如何使用事务呢?

    tx, _ := db.Begin() 开启事务后,后续的数据库操作都要使用tx才能进行事务commit/rollback。使用dao的话要怎么用呢

    1. dao.TX(tx).TableName.Save()