MyBatis将复杂查询写到SQL配置文件–SOD框架的SQL-MAP技术简介

引言

前天收看一片热门的博客, .NET高级工程师面试题之SQL篇
,要求找出每一个系的最高分,并且按系编号,学生编号升序排列。那个查询相比复杂,也正如典型,自从用了ORM后,很久没有写过SQL语句了,于是自己探究了下,自己也写了一个:

 WITH cte1 as (
 select stu.deptID,
        D.depName, 
        stu.stuid ,
        stu.stuName,
        score_sum.AllScore
    from dbo.Student stu
      inner join (select stuid ,SUM(score) as AllScore from dbo.Score group by stuid) score_sum      
          on  stu.stuid =score_sum.stuid 
      inner join dbo.Department D on stu.deptID= D.depID
)
 select cte1.* from cte1 
      inner join (select deptID, max(AllScore) maxScore from cte1  group by deptID) M
            on cte1.AllScore = M.maxScore and cte1.deptID=M.deptID
 order by cte1.deptID,
          cte1.stuid

 

俺们做事中时时碰到类似的扑朔迷离查询,但大规模的做法是把它写到BLL程序中,也有同学喜欢写在储存过程中,它有怎么着问题呢?

  • 写到程序中,
    • 容易养成拼接SQL的习惯,
    • 再就是SQL语句零散的分布到程序的各样地方,糟糕维护,
    • 并有可能暴发安全问题;
  • 写到存储过程,
    • 比方多了也欠好维护,
    • 与此同时程序调用不如直接调用SQL语句方便,
    • 配置的时候还得部署这一个囤积过程,系统上线复杂的时候,通常遗忘更新一七个存储过程。

除了,SQL语句不论写到程序中要么写在储存过程中,都有一个很大的先天不足,程序无法跨数据库平台!

如若把拥有的SQL语句都集中管理在一个配置文件中,那么程序编制和保障、发表都要方便广大,也便于跨数据库平台,甚至足以依照这多少个SQL配置文件,写个代码生成器,自动生成DAL层代码。
大名鼎鼎的 iBatis,MyBaits.Net
就是这般的机能,但它定义了一套复杂的条条框框,配置起来很复杂,项目可能80%的时辰都在写查询配置,假设没有代码工具开发工作量很大的。

自然,与MyBatis不平等之处,SOD框架并不看好将品种的询问都用SQL写到SqlMap文件,提出大家仅将复杂的SQL查询写到SqlMap配置文件,一般项目那类复杂查询也就20%左右,而对此80%的形似查询,使用ORM即可,框架同时补助ORM与SqlMap技术,这是SOD框架的一大特色!

SQL-MAP–集中管理SQL查询

PDF.NET
SOD框架
SQL-MAP功能以史为鉴了iBaits的牵记,不过大力简化它的配备并提供代码生成工具,可以自动化的做到DAL代码生成,下边是它的干活进程:

MyBatis 1

SOD框架提供了SqlMap配置文件管理器来治本和编排SQL配置文件,然后经过代码生成器生成DAL层代码,最终交给SODk框架执行。

编排SQL配置文件,如若通过上边说的部署工具来做,可以参照这篇著作:

PDF.NET之SQL-MAP使用图解

但这些程序太老,一向未曾立异,工具的下载地址是:

http://ft.codeplex.com/releases/view/65308

工具包含在这一个“集成开发工具”
内,通过菜单或者图标即可操作。下边是合二为一开发工具打开数据库并施行本文的查询的界面:

 

MyBatis 2

 

SQL-MAP配置管理工具不太好用,初学者学习概念可以试一试,但是要想熟习运用,推荐应用VS来写这一个SQL配置文件更便民。本文将向我们详细介绍那个历程。

一、编写SQL-MAP配置文件

1.1,建立SQL-MAP应用类型

正如图所示,新建一个
SqlMapDemo项目,在它其中先添加一个XML文件,文件命名为 SqlMap.config
,然后,找到地方的“集成开发工具”的设置目录,添加
SqlMap.xsd 文件。该公文很重大,它是咱们在VS里面编写XML文件能够有
智能提示 的关键。

MyBatis 3

 

添加了这多少个XSD文件到花色后,还亟需把下边的始末

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:noNamespaceSchemaLocation="SqlMap.xsd"  

专注:有关此详细内容,请参见《PDF.NET(PWMIS数据开发框架)之SQL-MAP目的和正规》。

1.2 使用XML智能提示

将上边的情节添加到刚才的SqlMap.config
文件中,这样,输入尖括号,或者输入空格,智能提示内容就出来,如下所示:

MyBatis 4

 

这是加上完整的SqlMap.config
文件,该公文完全手写,在智能提示的扶持下,编写仍旧很有利的。请小心安排文件内各类节点属性的情节,详细内容请看下边链接的文本。注意,这里要用
CDATA 来写SQL查询。

MyBatis 5

在意:假若要进行获得结果集的询问,需要在Sql-Map文件的一声令下节点里面使用
Select 节点,并且需要指明 ResultClass 的类别,它有下边三种可选值:

  1. ValueType –结果为值对象,比如Int,String之类的查询单值结果
  2. DataSet –数据集,默认
  3. EntityObject –单个实体类对象
  4. EntityList –实体类列表

留神:假若指定
ResultClass=”EntityObject” / ResultClass=”EntityList” ,那么需要同时说明ResultMap 属性,表示结果要映射到的现实品种,比如:

ResultClass=”EntityObject” ResultMap=”XXXNameSpace.YYYEntityClass”

至于此详细内容,请参见《PDF.NET(PWMIS数据开发框架)之SQL-MAP目的和业内》。

专注:<Script > 配置节,出了有Type表面数据库类型之外,还必须有 ConnectionString =”” Version=””
这样的情节,否则,下面的代码生成无法生成代码。

二、使用代码生成器

2.1 配置代码生成器

开辟PDF.NET集成开发工具,选取菜单
“配置”–SQL-MAP代码生成器配置,出现下面的界面:

在编写区域,鼠标右键菜单,启用用编辑,即使是第一次配置,请一定删除配置文件内的闽南语注释,否则配置文件格式不可能辨认。

MyBatis 6

这里关键配备SqlMap.config文件所在的一体化路径,输出代码的目录,以及命名空间等等。

编排完成,在编辑区的鼠标右键菜单上,启用“保存文件”的效应。

2.2 生成代码

假如下面配置不错,点击第二个工具栏的图标,就足以活动调用处
PDFCodeMaker.exe 程序,读取配置文件音讯,自动生成DAL代码文件,如下图:

MyBatis 7

6

MyBatis 8

然后,我们添加刚才生成的DAL代码文件到品种中,如上图。

三、使用SqlMap配置文件

3.1 SqlMap配置文件的接纳情势

SqlMap配置文件有2种采纳办法,

  • 在应用程序配置文件的AppSeting 配置节里面指定文件路径
  • 嵌入到程序集文件作为资源文件使用

在本示例中,选择嵌入式编译的形式,这样SQL语句的安全性更高,并且帮助一个系列中应用两个SqlMap配置文件,不过不如作为独立文件使用修改方便。如下图:

MyBatis 9

这种措施编译,该资源文件的名字就是
“程序集默认名字空间.目录名字.文件名字” ,这里的例子是
SqlMapDemo.SqlMap.config ,由于在跟目录下边,没有目录名字。

小心,要科学行使嵌入式SQL配置文件,还必须在该文件中提议”放到文件的先后集名称,资源文件名字“,如本例如下图绿色边框标记的有些所示:

 

MyBatis 10

SqMap.config 文件修改形成后,在此启动 PDFCodeMaker.exe
程序,重新生成DAL文件,如下所示,扩张了签入式文件的设置:

MyBatis 11

3.2 生成SqlMapDAL文件

反省发现,DAL类文件的名字空间不正确,这里修改下安排文件的 RootNameSpace
部分,如下图:

MyBatis 12

再一次生成DAL类文件,大家看看最后生成的SqlMapDAL类的情节:

MyBatis 13MyBatis 14

//使用该程序前请先引用程序集:PWMIS.Core,并且下面定义的名称空间前缀不要使用PWMIS,更多信息,请查看 http://www.pwmis.com/sqlmap 
// ========================================================================
// Copyright(c) 2008-2010 公司名称, All Rights Reserved.
// ========================================================================
using System;
using System.Data;
using System.Collections.Generic;
using PWMIS.DataMap.SqlMap;
using PWMIS.DataMap.Entity;
using PWMIS.Common;

namespace SqlMapDemo.SqlMapDAL
{
/// <summary>
/// 文件名:TestSqlMapClass.cs
/// 类 名:TestSqlMapClass
/// 版 本:1.0
/// 创建时间:2015/5/12 17:16:32
/// 用途描述:SQL-MAP示例测试程序
/// 其它信息:该文件由 PDF.NET Code Maker 自动生成,修改前请先备份!
/// </summary>
public partial class TestSqlMapClass
    : DBMapper 
{
    /// <summary>
    /// 默认构造函数
    /// </summary>
    public TestSqlMapClass()
    {
        Mapper.CommandClassName = "TestGroup";
        //CurrentDataBase.DataBaseType=DataBase.enumDataBaseType.SqlServer;
        Mapper.EmbedAssemblySource="SqlMapDemo,SqlMapDemo.SqlMap.config";//SQL-MAP文件嵌入的程序集名称和资源名称,如果有多个SQL-MAP文件建议在此指明。
    }


    /// <summary>
    /// 找出每一个系的最高分,并且按系编号,学生编号升序排列
    /// </summary>
    /// <returns></returns>
    public DataSet QueryStudentSores( ) 
    { 
            //获取命令信息
            CommandInfo cmdInfo=Mapper.GetCommandInfo("QueryStudentSores");
            //执行查询
            return CurrentDataBase.ExecuteDataSet(CurrentDataBase.ConnectionString, cmdInfo.CommandType, cmdInfo.CommandText ,null);
        //
    }//End Function


}//End Class

}//End NameSpace 

SqlMapDemo.SqlMapDAL

3.3 团队开发

集体支付日常提到到文件修改争辩,SqlMap配置文件也会遇见,要是我们不去修改同一个Command配置,用源代码管理器的自行合并功能是尚未问题的。

一旦是独占式签出管理,那么一个开发人士使用SqlMap文件,其它一个就只有等待了,但框架提供了变更的模式来化解这多少个题目。

  • 按功能模块划分DAL程序集,每个DAL程序集一个SqlMap.config文件,拔取嵌入式编译;
  • 在一个DAL程序项目上确立六个SqlMap.config文件,采取嵌入式编译 。

专注:提出每一个开发人士负责一个SqlMap.config文件的管住,然后分别安排自己的PDFCodeMaker.exe.config

 

3.4 切换数据库

在同一个SqlMap.config 文件之中添加新的 <Script Type=””
节点,比如Oracle
,然后将原来数据库类型的SQL查询改写成当下项目标SQL查询语句 ,程序会基于DBMapper的AdoHelper的实际上类型自动拔取正确的<Script
Type=”” 节点,从而成就数据库切换,实现您的行使体系跨数据库的功力。

其余,也可以此外建立一个SqlMap.config
文件,里面专门写新的数据库下边的SQL语句,我们往日一个银行的类型,就是这般从SqlServer移植到PostgreSql的。

四、运行SQL-MAP程序

4.1 配置连接字符串

SQL-MAP DAL类程序仍然通过AdoHelper
对象来举办,这里充裕一个应用程序配置文件:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <connectionStrings>
    <add name ="default" connectionString="Data Source=.;Initial Catalog=TestDB;Integrated Security=True" providerName="SqlServer"/>
  </connectionStrings>
</configuration>

4.2 运行程序

然后,就足以写如下的代码来测试SQL-MAP程序了:

 class Program
 {
     static void Main(string[] args)
     {
         Console.WriteLine("PDF.NET SOD框架 SqlMap示例程序--2015.5.12-------");
         Console.WriteLine("http://www.pwmis.com/sqlmap ---------");

         SqlMapDemo.SqlMapDAL.TestSqlMapClass test = new SqlMapDAL.TestSqlMapClass();

         //AdoHelper db = new SqlServer();
         //取最后一个连接配置
         AdoHelper db = MyDB.GetDBHelper();
         //SQL-MAP DAL 默认也会取最后一个连接配置,所以下面一行代码可以注释
         //test.CurrentDataBase = db;
         DataSet data = test.QueryStudentSores();

         Console.WriteLine("查询到记录数量:{0}",data.Tables[0].Rows.Count);
         Console.WriteLine("测试完成。");
         Console.Read();
     }
 }

结果运行如下:

MyBatis 15

设置一个断点,我们来看看 ”SQL-MAP DAL对象“的Mapper对象有什么样内容:

MyBatis 16

在当下窗口输入 test.Mapper
,回车,就可看出地点的内容了。这里展现了刚刚配置的SQL-MAP嵌入式文件的岗位和文件优秀的门路:SqlMapFile
属性。

 下面是事无巨细的结果:

test.Mapper
{PWMIS.DataMap.SqlMap.SqlMapper}
    _CommandClassName: "TestGroup"
    _DataBase: {PWMIS.DataProvider.Data.SqlServer}
    _dataBaseType: SqlServer
    _embedAssemblySource: "SqlMapDemo,SqlMapDemo.SqlMap.config"
    _ParaChar: "@"
    _ParamsMap: {PWMIS.Common.ParamMapType[0]}
    _ParasLenth: 0
    _ResultClass: ValueType
    _ResultMap: ""
    _SqlMapFile: "@R://SqlMapDemo,SqlMapDemo.SqlMap.config"

 结语

测试完全正确,使用 SOD框架的SQL-MAP 技术是不是很简单?

连续都只需要修改下文件之中的SQL语句就行了,

五回配置,一键生成!

这就是,SOD框架的SQL-MAP
技术的特点!结合SOD框架的ORM功用,它完全可以取代MyBatis.Net 。

谢谢我们关心PDF.NET
SOD框架,这是一个开源免费的框架,详细信息请看官网
http://www.pwmis.com/sqlmap

框架开源项目地址:http://pwmis.codeplex.com
,本项目示范代码已经签入到codeplex 上,大家可以由此SVN下载使用。

本篇程序已经提供了独立的下载:MyBatis 17    
Sql-Map Demo

正文相关视频播放和下载点击这里》》

网站地图xml地图