將復雜查詢寫到SQL配置文件--SOD框架的SQL-MAP技術簡介

 

可以參考作者的《SOD框架“企業級”應用數據架構實戰》了解本文相關的內容。

引言

今天看到一片熱門的博客， .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代碼生成，下面是它的工作過程：

SOD框架提供了SqlMap配置文件管理器來管理和編寫SQL配置文件，然后通過代碼生成器生成DAL層代碼，最后交給SODk框架執行。

編寫SQL配置文件，如果通過上面說的配置工具來做，可以參考這篇文章：

PDF.NET之SQL-MAP使用圖解

但這個程序太老，一直沒有更新，工具的下載地址是：

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

工具包含在這個“集成開發工具” 內，通過菜單或者圖標即可操作。下面是集成開發工具打開數據庫並執行本文的查詢的界面：

 

 

SQL-MAP配置管理工具不太好用，初學者學習概念可以試一試，但是要想熟練應用，推薦使用VS來寫這個SQL配置文件更方便。本文將向大家詳細介紹這個過程。

一、編寫SQL-MAP配置文件

1.1，建立SQL-MAP應用項目

如下圖所示，新建一個 SqlMapDemo項目，在它里面先添加一個XML文件，文件命名為 SqlMap.config ,然后，找到上面的“集成開發工具”的安裝目錄，添加 SqlMap.xsd 文件。該文件很重要，它是我們在VS里面編寫XML文件能夠有 智能提示 的關鍵。

 

添加了這個XSD文件到項目后，還需要把下面的內容

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

注意：有關此詳細內容，請參見《PDF.NET（PWMIS數據開發框架）之SQL-MAP目標和規范》。

1.2 使用XML智能提示

將上面的內容添加到剛才的SqlMap.config 文件中，這樣，輸入尖括號，或者輸入空格，智能提示內容就出來，如下所示：

 

這是添加完整的SqlMap.config 文件，該文件完全手寫，在智能提示的幫助下，編寫還是很方便的。請注意配置文件內各個節點屬性的內容，詳細內容請看上面鏈接的文件。注意，這里要用 CDATA 來寫SQL查詢。

注意:如果要執行獲得結果集的查詢,需要在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代碼生成器配置，出現下面的界面：

在編輯區域，鼠標右鍵菜單，啟用用編輯，如果是第一次配置，請一定刪除配置文件內的中文注釋，否則配置文件格式無法識別。

這里主要配置SqlMap.config文件所在的完整路徑，輸出代碼的目錄，以及命名空間之類。

編輯完成，在編輯區的鼠標右鍵菜單上，啟用“保存文件”的功能。

2.2 生成代碼

如果上面配置正確，點擊第二個工具欄的圖標，就可以自動調用處 PDFCodeMaker.exe 程序，讀取配置文件信息，自動生成DAL代碼文件，如下圖：

6

之后，我們添加剛才生成的DAL代碼文件到項目中，如上圖。

三、使用SqlMap配置文件

3.1 SqlMap配置文件的使用方式

SqlMap配置文件有2種使用方式，

• 在應用程序配置文件的AppSeting 配置節里面指定文件路徑
• 嵌入到程序集文件作為資源文件使用

在本示例中，采用嵌入式編譯的方式，這樣SQL語句的安全性更高，並且支持一個項目中使用多個SqlMap配置文件，但是不如作為獨立文件使用修改方便。如下圖：

這種方式編譯，該資源文件的名字就是 “程序集默認名字空間.目錄名字.文件名字” ，這里的例子是 SqlMapDemo.SqlMap.config ,由於在跟目錄下面，沒有目錄名字。

注意，要正確使用嵌入式SQL配置文件，還必須在該文件中指出"嵌入文件的程序集名稱,資源文件名字“，如本例如下圖紅色邊框標記的部分所示：

 

SqMap.config 文件修改完成后，在此啟動 PDFCodeMaker.exe 程序，重新生成DAL文件，如下所示，增加了簽入式文件的設置：

3.2 生成SqlMapDAL文件

檢查發現，DAL類文件的名字空間不正確，這里修改下配置文件的 RootNameSpace 部分，如下圖：

重新生成DAL類文件，我們看看最后生成的SqlMapDAL類的內容：

//使用該程序前請先引用程序集：PWMIS.Core，並且下面定義的名稱空間前綴不要使用ＰＷＭＩＳ，更多信息，請查看 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 

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查詢改寫成當前類型的ＳＱＬ查詢語句　，程序會根據ＤＢＭａｐｐｅｒ的ＡｄｏＨｅｌｐｅｒ的實際類型自動選擇正確的<Script Type="" 節點，從而完成數據庫切換，實現你的應用系統跨數據庫的功能。

另外，也可以另外建立一個SqlMap.config 文件，里面專門寫新的數據庫下面的ＳＱＬ語句，我們以前一個銀行的項目，就是這樣從ＳｑｌＳｅｒｖｅｒ移植到ＰｏｓｔｇｒｅＳｑｌ的。

四、運行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();
     }
 }

結果運行如下:

設置一個斷點，我們來看看 ”SQL-MAP DAL對象“的Mapper對象有哪些內容：

在及時窗口輸入 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下載使用。

本篇程序已經提供了獨立的下載：     Sql-Map Demo

本文相關視頻播放和下載，點擊這里》》