通用查询实现方案(可用于DDD)[附源码] -- 简介

原文:通用查询实现方案(可用于DDD)[附源码] -- 简介

【声明】

写作不易，转载请注明出处(http://www.cnblogs.com/wiseant/p/3985353.html)。

 

【系列文章】

通用查询实现方案(可用于DDD)[附源码] -- 简介

通用查询实现方案(可用于DDD)[附源码] -- 设计思路

通用查询实现方案(可用于DDD)[附源码] -- 代码解读

 

【前言】

最近一直在关注和学习DDD，园子里大牛们的博文也看了不少，如dax.net、netfocus、老赵、田园里的蟋蟀、深蓝医生、冰麟轻武，不一一列举，感谢你们的无私分享。

关于DDD我一直也是看得多，做得少，可以说未入门，自然也写不出什么东西。但是我对DDD相关的思考倒并不少，特别是对于查询好像没有一个很优雅的实现方案。

上个月dax.net写了一篇关于统一查询实现思路的文章：一种通用查询语言的定义与实践，给了我动力和灵感，感谢dax.net兄。

缘于这个契机，我开始尝试实现一个通用查询方案，最近一直在做NC5.7的二次开发，只能用业余时间来搞这个，经过半个多月的努力，实现了一个 自我感觉还算优雅的通用查询方案。但一个人的智慧始终是有限的，而且本人也是半路出家，底子比较薄，遂将项目开源出来，一方面是希望可以帮助到初学者，以 便更多人来检验此查询方案的通用性和可靠性，另外主要也希望得到园子里大牛们的指点，使此查询方案得到更一步发展和提炼而日趋成熟。

PS:顺便吐槽一下NC-UAP5.7开发平台，说文明点就是太难用了，说得不文明点那就是一坨屎！用友还枉称什么国内一流的软件供应商

 

【功能】

以前一直从事基于数据库的企业应用开发，用户经常需要在客户端灵活的进行数据检索，我采用的是拼SQL的方式，虽然有各种弊端，但好处是相当自 由。到了DDD发现拼SQL基本上是行不通了，很多开发人员都采用在仓储中定义类似FindByKey()、FindByName()、 FindByNameAndAge()这样的方法来提供数据检索，每当用户需要多一种条件组合时都要改很多地方，大费周章。我希望这个查询对象定义可以有 代码检查功能，条件组合灵活多样，可以在前后台之前传输，并且一次定义就可以被编译为不同的目标格式，如SQL、Lambda表达式。

下面分别介绍这些功能如何使用。

一、直观的定义查询对象

1)支持以Linq表达式定位属性

 

如上图，首先我们以传统的方式定义了两个字段，紧接着我们以Linq表达式方式直接获取了这两个字段，经过用单元测试方法来验证两种方式所获取的字段是等同的。

显然第二种方式更优雅简洁，更重要的是当字段改名或更改了字段类型时，第一种方式编译依然可以通过，而运行时将不可避免的产生异常，导致程序维 护难度增加；而第二种方式在遇到字段改名时将在编译报告错误，如果你使用ReSharp之类工具的代码重构功能的话，更是会自动做出相应修改。

鉴于以上原因，我将在后续示例代码中仅采用第二种方式书写，我推荐你也使用第二种方式。

2)支持计算公式

如果仅仅支持对字段的比较显然是不够的，我希望日常80%~90%对查询的需求可以通过此通用查询方案来解决。

显然支持计算公式和括号优先级是非常必要的，我们通过下面这张代码贴图可以了解一个使用算式的简单例子。

 

3)支持导航属性条件

还有一个很有必要支持的功能是对导航属性的条件查询，在关系数据库中即为关联表条件查询。

第一张代码贴图中其实已经有相关代码展示了，我将该代码行单独剪切出来放在下图，图中代码行定义一个"订单.供应商.编码"字段，后面的查询示例中会有更详细的代码展示。

 

4)支持括号优先级

上面已经提到过支持括号优先级的必要性，下面的代码将展示定义一个加法运算，并将这个算式用括号括起来，保证此算式优先计算。

 

二、查询对象可序列化及反序列化

无论是DDD还是传统的三层架构都涉及到分层传输的问题，那么我们的通用查询方案也必须提供序列化及反序列化的功能，通过下面的代码贴图可以看到对XML格式文本的序列化支持，由于时间所限我将在稍后提供对json格式的序列化支持。

 

三、定义好查询后可同时编译为SQL或lambda表达式

如果前面的代码你能读懂(其实不难)，那么下面的代码有很详细的注释，相信对你也没什么难度，为节省时间，我就不费口舌了。

         [Fact]
         public void TestQuery3()
         {
             var helper = new TypeInfoHelper<Order>();
             //获得订单集合中的第一张订单，用于之后的单元测试验证
             var findOrder = orders.First();
             //定义一个查询，条件为订单主键等于前面获取的订单对象的主键值
             var query = new Query(typeof(Order))
             {
                 RootExpression = helper.GetProperty(p => p.BillId).EqualTo(findOrder.BillId)
             };
             /*第一种编译方式*/
             //定义一个生成Lambda表达式的编译器对象
             var compiler = new LambdaExpressionCompiler<Order>(query);
             //将查询对象编译为Linq表达式
             var expression = compiler.Compile();
             //对订单集合执行linq查询
             var items = orders.Where(expression.Compile()).ToList();
             //验证查询结果中仅包含一张订单，且订单编号与参照订单的编号相同
             Assert.Equal(items.Count, );
             Assert.Equal(items.First().BillNo, findOrder.BillNo);

             /*第二种编译方式*/
             //定义一个生成SQL脚本的编译器对象
             var sqlCompiler = new SqlWhereClauseCompiler(query) { GenSelectPart = true };
             //将查询对象编译为SQL脚本
             var sql = sqlCompiler.Compile();
             Console.WriteLine(sql);
             //执行sql脚本
             var reader = dbHelper.Read(sql, sqlCompiler.ParameterValues);
             //验证返回的结果中只有一条记录，且订单编号与参照订单的编号相同
             Assert.Equal(reader.Read(), true);
             Assert.Equal(findOrder.BillNo, reader["BillNo"]);
             Assert.Equal(reader.Read(), false);//验证只能执行读取一次操作
         }

【用途】

1.适用于DDD中聚合根的查询

2.适用于普通的面向数据表及视图的查询

3.可以很方便的实现可重用的面向最终用户自助查询(条件组合完全由用户来指定)

受时间所限，这部分内容如有必要后续再补充吧，写文章确实太费时间。

 

我不太擅长写作，导致大家看完博文后，可能还是很难明白此通用查询具体能做什么，补充一个稍复杂的应用示例吧。

下面的定义的查询对象编译后将生成SQL脚本(为了增强阅读性，我添加了换行和缩进)：

SELECT * FROM xzcOrder AS o
  WHERE (o.BillNo LIKE 'PO%' OR  NOT o.BillDate >= '2014-1-1 0:00:00' )
  AND EXISTS(SELECT 1 FROM supplier WHERE supplier.Id=o.SupplierId AND supplier.Code LIKE '%X%')
  AND o.Invalid = 0
  AND EXISTS(SELECT 1 FROM Items AS d WHERE d.BillId=o.BillId AND EXISTS(SELECT 1 FROM Product AS p WHERE p.Id=d.ProductId AND p.Unit = '部'))
  AND EXISTS(SELECT 1 FROM Items AS d WHERE d.BillId=o.BillId AND d.Qty < o.TotalQty)

相应的C#代码

             var helper = new TypeInfoHelper<Order>();
             var query = new Query(typeof(Order))
             {
                 RootExpression = helper.GetProperty(p => p.BillNo).StartsWith("PO") //单号以PO打头
                     .Or(helper.GetProperty(p => p.BillDate).GreaterThanOrEqualTo(new DateTime(, , )).Not())//订单日期 不 大于等于 2014-1-1
                     .Unitary() //上面两个条件设为独立整体，即用()号包围
                     .And(helper.GetProperty(p => p.Supplier.Code).Contains("X"))//供应商编码中包含字符"X"
                     .And(helper.GetProperty(p => p.Invalid).EqualTo(false)) //订单失效标志为否
                     .And(helper.GetProperty(p => p.Items.FirstOrDefault().Product.Unit).EqualTo("部")) //订购产品的计量单位为"部"
                     .And(
                         //订单明细中各项订购数量小于订单总订购数量，仅为测试，无实际意义
                         helper.GetProperty(p => p.Items.FirstOrDefault().Qty)
                             .LessThan(helper.GetProperty(p => p.TotalQty)))
             };
             List<Order> items;
             var sqlCompiler = new SqlWhereClauseCompiler(query) { GenSelectPart = true };
             var sql = sqlCompiler.Compile();
             Console.WriteLine(sql);

 

【源码下载】

很多人感兴的可能都是有没有提供源码下载，特别是初学者；我想说的有源码拿在手上固然是有一种踏实的感觉，但是源码之外的设计思路更重要。

这个通用查询方案的源码并没有太多技术含量，设计思路也并不高大上，因为我一向都是个实用主义者。所以你完全有可能在了解我的思路之后，在此基 础上提炼升华，用更好的技术来实现你自己的通用查询方案也绝非难事，我此举开源仅为抛砖引玉，听取大家意见，博文开头也已经作出说明了。

源码我就不搞什么回贴发邮件了，但是源码还远未成熟，还有一些代码重构工作要做，另外也希望在得到园子里大牛们指点进一步完善代码后再上传到源码托管服务器上，所以这里暂时就用百度云盘分享给大家吧。

链接：http://pan.baidu.com/s/1bn7y7oF 密码：p2dg

最近更新下载

链接：http://pan.baidu.com/s/1o64u8UQ 密码：qo6i

 

代码已托管到开源中国，地址：http://git.oschina.net/xant77/Xant.Querier

 

【关于编译项目】

开发环境：Visual Studio 2013

第三方库：xunit、SQLite

扩展工具：xUnit.net runner for Visual Studio 2012 and 2013

将源码解压到磁盘上，打开解决方案，在"解决方案资源管理器"中显示有两个第三方库存在冲突

 

试过启用NuGet程序包还原，还原后编译能通过，但是执行时会报告缺少SQLite.Interop.dll文件，不知道有没有更好的办法， 一个可行的解决办法是：在Tester项目上点右键，选择"管理NuGet程序包..."，将已安装的2个包删除，然后再联机搜索这两个包安装上去。

注意搜索sqlite时会出现很多相关的包，请选择下图这个

 

之后便可以编译通过了，Tester项目可以编译后直接运行或是在"测试资源管理器"中点击"全部运行"查看测试方法执行结果。

 

如果看不到上图的画面，请先安装xUnit.net runner for Visual Studio 2012 and 2013

建议你先阅读XunitTest.cs文件中的代码，可以对整个项目有一个直观了解。

 

【写在最后】

博文除了图片以外绝大部分文字内容都是我在上下班乘坐地铁或公交时在手机上完成的，写作不昜，如果对你还有点用处或启发的话，望不吝点赞，谢谢！