让 ORM 支持多结果集

本贴最后更新于 2098 天前,其中的信息可能已经渤澥桑田

在现有的 ORM 框架中,都支持查询单个结果集。比如查询用户表,传入语句,返回一个用户对象的集合。虽然一次性查询多个结果集的情况不多,而且也可以通过多次查询得到,但是从写框架的角度来说,我们并不清楚客户(其他 Developer)期望怎么使用我们的框架。(当我写这篇文章的时候,搜索了一下,EF 和 Dapper 都有实现多结果集查询,从其调用来看和我的的思路差不多)

实现多结果集的关键就是方法签名。单个结果集的时候我们可以这样定义:

public List<TModel> Select<TModel>(string sql)

因为是 ORM 框架,我们需要返回泛型结果,使用泛型的限制是,每个泛型参数必须在声明的时候定义好,比如我们返回两个结果集可以这样定义:

public Tuple<List<T1>,List<T2>> Select<T1,T2>(string sql1,string sql2)

这种定义当然是可以实现的,但是存在的问题也很明显,比如我们返回三个结果集的时候,需要再加一个重载:

public Tuple<List<T1>,List<T2>,List<T3>> Select<T1,T2,T3>(string sql1,string sql2,string sql3)

如果是四个、五个、更多呢?还有可能不全是 List,或者是单个模型呢,再加上顺序的问题会有很多组合,这个时候我就要宣布自己精力有限啦。

上述方法可行性不好,需要换一下角度。之所以定义会那么多,是有两方面原因:

    1、我们一次性返回了多个结果集

    2、泛型参数需要声明时定义好

所以上面的实现属于“强为之”,不可取。当我们控制不了一些事物变化的时候,我们应该学会放权,把决策权给用户,落实到文章的主题,有两个不可控:

    1、我们不知道用户要查询几个结果集

    2、我们不知道每一个结果集返回什么类型

为了方便传参,我们定义一个命令对象,包括 sql 语句和 sql 参数:

public class MutipleCmd { /// <summary> /// sql语句 /// </summary> public string CmdText { get; set; } public Dictionary<string, object> Params { get; set; } }

在查询多结果集的时候,我们就可以传入 MutipleCmd 类型的参数数组了。

因为不知道多个结果分别对应什么类型,所以我们的返回值并不能像上面那样直接出去,而是要定义个很关键的结果类,提供方法让用户自己去结果:

/// <summary> /// 查询多个结果集时,返回此类型的对象,客户端手动Fetch /// </summary> public class MutipleResult : IDisposable { #region 实现Dispose public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } public void Close() { Dispose(); } ~MutipleResult() { Dispose(false); } private bool disposed = false; protected virtual void Dispose(bool disposing) { if (disposed) return; if (disposing) { //释放托管资源 } if (_reader != null) { _reader.Dispose(); } disposed = true; } #endregion DbDataReader _reader; public MutipleResult() { } public MutipleResult(DbDataReader reader) { _reader = reader; } /// <summary> /// 从DataReader获取多行数据,填充为TModel集合返回 /// </summary> /// <typeparam name="TModel"></typeparam> /// <returns></returns> public List<TModel> FetchList<TModel>() { if (_reader == null || _reader.IsClosed) return new List<TModel>(); var list = Mapping.ReaderToObjectList<TModel>(_reader); if (!_reader.NextResult()) { _reader.Close(); } return list; } /// <summary> /// 从DataReader获取一行数据,填充为TModel返回 /// </summary> /// <typeparam name="TModel"></typeparam> /// <returns></returns> public TModel FetchObject<TModel>() { if (_reader == null || _reader.IsClosed) return default(TModel); var m = Mapping.ReaderToObject<TModel>(_reader); if (!_reader.NextResult()) { _reader.Close(); } return m; } /// <summary> /// 从DataReader获取首行首列的值 /// </summary> /// <typeparam name="TValue"></typeparam> /// <returns></returns> public TValue FetchScalar<TValue>() { if (_reader == null || _reader.IsClosed) return default(TValue); var scalar = Mapping.ReaderToScalar<TValue>(_reader); if (!_reader.NextResult()) { _reader.Close(); } return scalar; } }

定义的 MutipleResult 类由于引用的 DataReader,要实现以下 IDisposable 接口以方便用户用 using 语法关闭 DataReader。还提供了三个 Fetch 方法用于获取 Mapping 好的结果,也可以提供更多有特性的 Fetch 方法,这里我只实现了自己感觉常用的。

还有一点需要注意一下,传入的多个 MutipleCmd 参数之中的 sql 参数可能因同名而相互影响,所以我们在 MutipleCmd 方法里再加两个方法:

internal Dictionary<string, object> GetUniqueParams(int index) { if (Params == null || Params.Count == 0) return new Dictionary<string, object>(); var newParams = new Dictionary<string, object>(); foreach (var kv in Params) { newParams.Add(kv.Key + "_" + index, kv.Value); } return newParams; } internal string GetMatchedCmdText(int index) { if (Params == null || Params.Count == 0) return CmdText; var newSql = CmdText; foreach (var item in Params) { newSql = newSql.Replace("@" + item.Key, "@" + item.Key + "_" + index); } return newSql; }

这两个方法用于使一次查询中的 sql 参数唯一,在实际查询方法中,我们只是简单的拼接语句和组合 sql 参数,获取 datareader 即可:

/// <summary> /// 执行命令,返回多个结果集,返回对象用using释放,Fetch结果的时候最好不要做其他逻辑 /// </summary> /// <param name="dbConn"></param> /// <param name="cmds"></param> /// <returns></returns> public static MutipleResult SelectMutipleResult(this DbConnection dbConn, params MutipleCmd[] cmds) { if (cmds == null || cmds.Length == 0) return new MutipleResult(); var theCmd = BaseCmd.GetCmd(dbConn.GetProviderType()); List<string> sqls = new List<string>(); List<DbParameter> ps = new List<DbParameter>(); for (int i = 0; i < cmds.Length; i++) { var cmd = cmds[i]; sqls.Add(cmd.GetMatchedCmdText(i)); ps.AddRange(theCmd.DictionaryToParams(cmd.GetUniqueParams(i))); } var sql = string.Join(";", sqls); var reader = SqlHelper.ExecuteReader(dbConn, CommandType.Text, sql, ps.ToArray()); return new MutipleResult(reader); }

使用的例子:

static void TestMutileResult() { using (var db = Utils.CreateConnection()) { var cmds = new MutipleCmd[] { new MutipleCmd { CmdText="select top 2 * from TestEntity" }, new MutipleCmd { CmdText="select top 1 * from TestEntity where F_Int64>@fint", Params=new Dictionary<string, object> { {"fint",23 } } }, new MutipleCmd { CmdText="select top 1 F_Int64 from TestEntity where F_Int64>@fint",Params=new Dictionary<string, object> { {"fint",20 } } }, }; var result = db.SelectMutipleResult(cmds); var list = result.FetchList<TestEntity>(); var entity = result.FetchObject<TestEntity>(); var f_int64 = result.FetchScalar<long>(); Console.WriteLine(list[1].F_String); Console.WriteLine(entity.F_String); Console.WriteLine(f_int64); } }

如 SelectMutipleResult 方法的注释所说,Fetch 结果的时候最好不要做其他操作,因为 Fetch 的时候 DataReader 一直连接着数据库,长时间的连接对性能影响较大。说好的调用 SelectMutipleResult 时要使用 using 呢,其实可用可不用,因为外部连接会关闭,而且如果常规调用,Fetch 到最后一个结果集的时候会自动关闭掉 Reader。

因为是在自己的 ORM 里实现的,以上代码都源自 Loogn.OrmLite

  • .NET
    27 引用 • 6 回帖 • 5 关注
  • ORM
    9 引用 • 6 回帖

相关帖子

欢迎来到这里!

我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。

注册 关于
请输入回帖内容 ...

推荐标签 标签

  • Swift

    Swift 是苹果于 2014 年 WWDC(苹果开发者大会)发布的开发语言,可与 Objective-C 共同运行于 Mac OS 和 iOS 平台,用于搭建基于苹果平台的应用程序。

    36 引用 • 37 回帖 • 545 关注
  • 星云链

    星云链是一个开源公链,业内简单的将其称为区块链上的谷歌。其实它不仅仅是区块链搜索引擎,一个公链的所有功能,它基本都有,比如你可以用它来开发部署你的去中心化的 APP,你可以在上面编写智能合约,发送交易等等。3 分钟快速接入星云链 (NAS) 测试网

    3 引用 • 16 回帖
  • LaTeX

    LaTeX(音译“拉泰赫”)是一种基于 ΤΕΧ 的排版系统,由美国计算机学家莱斯利·兰伯特(Leslie Lamport)在 20 世纪 80 年代初期开发,利用这种格式,即使使用者没有排版和程序设计的知识也可以充分发挥由 TeX 所提供的强大功能,能在几天,甚至几小时内生成很多具有书籍质量的印刷品。对于生成复杂表格和数学公式,这一点表现得尤为突出。因此它非常适用于生成高印刷质量的科技和数学类文档。

    12 引用 • 54 回帖 • 17 关注
  • Outlook
    1 引用 • 5 回帖
  • Scala

    Scala 是一门多范式的编程语言,集成面向对象编程和函数式编程的各种特性。

    13 引用 • 11 回帖 • 157 关注
  • frp

    frp 是一个可用于内网穿透的高性能的反向代理应用,支持 TCP、UDP、 HTTP 和 HTTPS 协议。

    20 引用 • 7 回帖 • 2 关注
  • ngrok

    ngrok 是一个反向代理,通过在公共的端点和本地运行的 Web 服务器之间建立一个安全的通道。

    7 引用 • 63 回帖 • 644 关注
  • 架构

    我们平时所说的“架构”主要是指软件架构,这是有关软件整体结构与组件的抽象描述,用于指导软件系统各个方面的设计。另外还有“业务架构”、“网络架构”、“硬件架构”等细分领域。

    143 引用 • 442 回帖 • 1 关注
  • GraphQL

    GraphQL 是一个用于 API 的查询语言,是一个使用基于类型系统来执行查询的服务端运行时(类型系统由你的数据定义)。GraphQL 并没有和任何特定数据库或者存储引擎绑定,而是依靠你现有的代码和数据支撑。

    4 引用 • 3 回帖 • 3 关注
  • 以太坊

    以太坊(Ethereum)并不是一个机构,而是一款能够在区块链上实现智能合约、开源的底层系统。以太坊是一个平台和一种编程语言 Solidity,使开发人员能够建立和发布下一代去中心化应用。 以太坊可以用来编程、分散、担保和交易任何事物:投票、域名、金融交易所、众筹、公司管理、合同和知识产权等等。

    34 引用 • 367 回帖 • 1 关注
  • Spring

    Spring 是一个开源框架,是于 2003 年兴起的一个轻量级的 Java 开发框架,由 Rod Johnson 在其著作《Expert One-On-One J2EE Development and Design》中阐述的部分理念和原型衍生而来。它是为了解决企业应用开发的复杂性而创建的。框架的主要优势之一就是其分层架构,分层架构允许使用者选择使用哪一个组件,同时为 JavaEE 应用程序开发提供集成的框架。

    946 引用 • 1460 回帖 • 1 关注
  • golang

    Go 语言是 Google 推出的一种全新的编程语言,可以在不损失应用程序性能的情况下降低代码的复杂性。谷歌首席软件工程师罗布派克(Rob Pike)说:我们之所以开发 Go,是因为过去 10 多年间软件开发的难度令人沮丧。Go 是谷歌 2009 发布的第二款编程语言。

    498 引用 • 1395 回帖 • 257 关注
  • 互联网

    互联网(Internet),又称网际网络,或音译因特网、英特网。互联网始于 1969 年美国的阿帕网,是网络与网络之间所串连成的庞大网络,这些网络以一组通用的协议相连,形成逻辑上的单一巨大国际网络。

    99 引用 • 367 回帖
  • WebClipper

    Web Clipper 是一款浏览器剪藏扩展,它可以帮助你把网页内容剪藏到本地。

    3 引用 • 9 回帖 • 6 关注
  • wolai

    我来 wolai:不仅仅是未来的云端笔记!

    2 引用 • 14 回帖
  • danl
    164 关注
  • WebSocket

    WebSocket 是 HTML5 中定义的一种新协议,它实现了浏览器与服务器之间的全双工通信(full-duplex)。

    48 引用 • 206 回帖 • 298 关注
  • SMTP

    SMTP(Simple Mail Transfer Protocol)即简单邮件传输协议,它是一组用于由源地址到目的地址传送邮件的规则,由它来控制信件的中转方式。SMTP 协议属于 TCP/IP 协议簇,它帮助每台计算机在发送或中转信件时找到下一个目的地。

    4 引用 • 18 回帖 • 638 关注
  • 房星科技

    房星网,我们不和没有钱的程序员谈理想,我们要让程序员又有理想又有钱。我们有雄厚的房地产行业线下资源,遍布昆明全城的 100 家门店、四千地产经纪人是我们坚实的后盾。

    6 引用 • 141 回帖 • 592 关注
  • 新人

    让我们欢迎这对新人。哦,不好意思说错了,让我们欢迎这位新人!
    新手上路,请谨慎驾驶!

    52 引用 • 228 回帖
  • flomo

    flomo 是新一代 「卡片笔记」 ,专注在碎片化时代,促进你的记录,帮你积累更多知识资产。

    6 引用 • 140 回帖
  • 脑图

    脑图又叫思维导图,是表达发散性思维的有效图形思维工具 ,它简单却又很有效,是一种实用性的思维工具。

    31 引用 • 97 回帖
  • Solo

    Solo 是一款小而美的开源博客系统,专为程序员设计。Solo 有着非常活跃的社区,可将文章作为帖子推送到社区,来自社区的回帖将作为博客评论进行联动(具体细节请浏览 B3log 构思 - 分布式社区网络)。

    这是一种全新的网络社区体验,让热爱记录和分享的你不再感到孤单!

    1440 引用 • 10067 回帖 • 492 关注
  • Openfire

    Openfire 是开源的、基于可拓展通讯和表示协议 (XMPP)、采用 Java 编程语言开发的实时协作服务器。Openfire 的效率很高,单台服务器可支持上万并发用户。

    6 引用 • 7 回帖 • 100 关注
  • Rust

    Rust 是一门赋予每个人构建可靠且高效软件能力的语言。Rust 由 Mozilla 开发,最早发布于 2014 年 9 月。

    58 引用 • 22 回帖 • 1 关注
  • IBM

    IBM(国际商业机器公司)或万国商业机器公司,简称 IBM(International Business Machines Corporation),总公司在纽约州阿蒙克市。1911 年托马斯·沃森创立于美国,是全球最大的信息技术和业务解决方案公司,拥有全球雇员 30 多万人,业务遍及 160 多个国家和地区。

    17 引用 • 53 回帖 • 143 关注
  • 安全

    安全永远都不是一个小问题。

    203 引用 • 818 回帖 • 1 关注