[原創]修正SubSonic v2.2.1的一處BUG，以及如何使用SubSonic進行多表查詢、子查詢以及數據庫分頁

相信很多同學都用過SubSonic，在07 - 10年ORM興起的時代，SubSonic可以說是DotNet開發人員的救星。雖說現在 EntityFramework大有一統江湖的趨勢，不過在DotNet2.0框架下，SubSonic依然是為數不多的選擇。

 

最近在維護基於 ExtAspNet 的通用權限管理項目 AppBox ，在使用SubSonic進行多表查詢和數據庫分頁時遇到了點問題，下面我會詳細分享這一經過，以及如何通過修改SubSonic的源代碼來修正這一問題。

 

我要實現如下的功能

我要實現的功能非常簡單：用戶管理，角色管理，角色用戶管理（一個用戶可以屬於多個角色）。相信很多同學閉着眼睛就能把數據庫給構造出來，不是嗎？

 

1. 用戶表

 

2. 角色表

 

3. 角色用戶表

 

其中用戶管理和角色管理都很簡單，我要實現的角色用戶管理界面如下所示：

1. 查看角色下的所有用戶

 

2. 向角色添加現有用戶

 

 

 

數據庫查詢時遇到問題

在查看角色下的所有用戶頁面，需要進行表關聯，相關的SubSonic代碼如下所示：

// 查詢 X_User 表
SqlQuery q = new Select().From<XUser>();
q.Where("1").IsEqualTo("1");

// 在用戶名稱中搜索
string searchText = ttbSearchUser.Text.Trim();
if (!String.IsNullOrEmpty(searchText))
{
    q.And(XUser.NameColumn).ContainsString(searchText);
}

// 過濾選中角色下的所有用戶
object[] values = Grid1.DataKeys[Grid1.SelectedRowIndexArray[0]];
int roleId = Convert.ToInt32(values[0]);
SqlQuery subQ = new Select(XRoleUser.UserIdColumn).From<XRoleUser>().Where(XRoleUser.RoleIdColumn).IsEqualTo(roleId);

q.And(XUser.IdColumn).In(subQ);


// 在查詢添加之后，排序和分頁之前獲取總記錄數
// Grid1總共有多少條記錄
Grid2.RecordCount = q.GetRecordCount();

// 排列
q.OrderBys.Add(GetSortExpression(Grid2, XUser.Schema));

// 數據庫分頁
q.Paged(Grid2.PageIndex + 1, Grid2.PageSize);
items = q.ExecuteAsCollection<XUserCollection>();

令人不解的時，居然報如下錯誤：

 

很明顯，SubSonic生成的SQL腳本不對，經過調試發現生成的腳本如下所示：

DECLARE @Page int
DECLARE @PageSize int

SET @Page = 1
SET @PageSize = 20

SET NOCOUNT ON

-- create a temp table to hold order ids
DECLARE @TempTable TABLE (IndexId int identity, _keyID Int)

-- insert the table ids and row numbers into the memory table
INSERT INTO @TempTable
(
    _keyID
)
SELECT [dbo].[X_User].[Id]
FROM [dbo].[X_User]
WHERE 1 = @10
AND [dbo].[X_User].[Id] IN (SELECT [dbo].[X_RoleUser].[UserId]
    FROM [dbo].[X_RoleUser]
    WHERE [dbo].[X_RoleUser].[RoleId] = @RoleId0
    )

AND 1 = @10
AND [dbo].[X_User].[Id] IN (SELECT [dbo].[X_RoleUser].[UserId]
    FROM [dbo].[X_RoleUser]
    AND [dbo].[X_RoleUser].[RoleId] = @RoleId0
    )

 ORDER BY Name DESC

-- select only those rows belonging to the proper page
SELECT [dbo].[X_User].[Id], [dbo].[X_User].[Name], [dbo].[X_User].[Password], [dbo].[X_User].[Enabled], [dbo].[X_User].[Email], [dbo].[X_User].[Gender], [dbo].[X_User].[RealName], [dbo].[X_User].[QQ], [dbo].[X_User].[MSN], [dbo].[X_User].[CellPhone], [dbo].[X_User].[OfficePhone], [dbo].[X_User].[HomePhone], [dbo].[X_User].[Remark], [dbo].[X_User].[DeptId], [dbo].[X_User].[RoleId], [dbo].[X_User].[CreateTime]

FROM [dbo].[X_User]
INNER JOIN [dbo].[X_RoleUser] ON [dbo].[X_User].[Id] = [dbo].[X_RoleUser].[UserId]

INNER JOIN @TempTable t ON [dbo].[X_User].[Id] = t._keyID
WHERE t.IndexId BETWEEN ((@Page - 1) * @PageSize + 1) AND (@Page * @PageSize)

這里面有兩處錯誤：

1. 首先，25 – 29 行的Where子句重復了，相信這個問題一直存在於SubSonic2.2中，只不過大家都沒發現而已

2. 其次，重復的子查詢中Where被替換成了AND，導致這個子查詢沒有Where子句，從而報錯！

 

如果撇去分頁的SQL腳本不管，正確的SQL腳本應該是這樣的：

SELECT [dbo].[X_User].[Id]
FROM [dbo].[X_User]
WHERE 1 = @10
AND [dbo].[X_User].[Id] IN (SELECT [dbo].[X_RoleUser].[UserId]
    FROM [dbo].[X_RoleUser]
    WHERE [dbo].[X_RoleUser].[RoleId] = @RoleId0
    )

 ORDER BYName DESC

很明顯，SubSonic在生成帶子查詢的分頁SQL腳本時除了問題。

 

修改SubSonic的源代碼

從Github下載SubSonic2.0的源代碼：https://nodeload.github.com/subsonic/SubSonic-2.0/zip/master

其實下載下來的是SubSonic2.2.1，找到其中的 SqlQuery\SqlGenerators\ANSISqlGenerator.cs 文件：

public virtual string BuildPagedSelectStatement()
{
    // 省略的代碼...

    string wheres = GenerateWhere();

    //have to doctor the wheres, since we're using a WHERE in the paging
    //bits. So change all "WHERE" to "AND"
    string tweakedWheres = wheres.Replace("WHERE", "AND");

    // 省略的代碼...

    string sql = string.Format(PAGING_SQL, idColumn, String.Concat(fromLine, joins, wheres), String.Concat(tweakedWheres, orderby, havings),
        String.Concat(select, fromLine, joins), query.CurrentPage, query.PageSize, sqlType);
    return sql;
}

其中 tweakedWheres 是關鍵，作者還特別指出要把其中 WHERE 替換成 AND，殊不知這樣做對子查詢是破壞性操作，而且下面連接SQL腳本時重復添加了WHERE子句。

修改后的代碼：

public virtual string BuildPagedSelectStatement()
{
    // 省略的代碼...

    string wheres = GenerateWhere();

    //have to doctor the wheres, since we're using a WHERE in the paging
    //bits. So change all "WHERE" to "AND"
    //string tweakedWheres = wheres.Replace("WHERE", "AND");

    // 省略的代碼...

    string sql = string.Format(PAGING_SQL, idColumn, String.Concat(fromLine, joins, wheres), String.Concat(orderby, havings),
        String.Concat(select, fromLine, joins), query.CurrentPage, query.PageSize, sqlType);
    return sql;
}

 

搞定!

 

子查詢與表關聯查詢（查看角色下所有用戶）

在上面的例子中，我們使用的是子查詢，對於“查看角色下所有用戶”這個案例，我們還有如下另一種解決辦法（效果完全一樣）：

 

// 查詢 X_User 表
SqlQuery q = new Select().From<XUser>().InnerJoin(XRoleUser.UserIdColumn, XUser.IdColumn);
q.Where("1").IsEqualTo("1");

// 在用戶名稱中搜索
string searchText = ttbSearchUser.Text.Trim();
if (!String.IsNullOrEmpty(searchText))
{
    q.And(XUser.NameColumn).ContainsString(searchText);
}

// 過濾選中角色下的所有用戶
object[] values = Grid1.DataKeys[Grid1.SelectedRowIndexArray[0]];
int roleId = Convert.ToInt32(values[0]);
q.And(XRoleUser.RoleIdColumn).IsEqualTo(roleId);


// 在查詢添加之后，排序和分頁之前獲取總記錄數
// Grid1總共有多少條記錄
Grid2.RecordCount = q.GetRecordCount();

// 排列
q.OrderBys.Add(GetSortExpression(Grid2, XUser.Schema));

// 數據庫分頁
q.Paged(Grid2.PageIndex + 1, Grid2.PageSize);
items = q.ExecuteAsCollection<XUserCollection>();

 

再來看下這段代碼生成的SQL腳本（修正SubSonic2.2.1中的BUG后）：

DECLARE @Page int
DECLARE @PageSize int

SET @Page = 1
SET @PageSize = 20

SET NOCOUNT ON

-- create a temp table to hold order ids
DECLARE @TempTable TABLE (IndexId int identity, _keyID Int)

-- insert the table ids and row numbers into the memory table
INSERT INTO @TempTable
(
    _keyID
)
SELECT [dbo].[X_User].[Id]
FROM [dbo].[X_User]
INNER JOIN [dbo].[X_RoleUser] ON [dbo].[X_User].[Id] = [dbo].[X_RoleUser].[UserId]
    WHERE 1 = @10
    AND [dbo].[X_RoleUser].[RoleId] = @RoleId1

ORDER BY Name DESC

-- select only those rows belonging to the proper page
SELECT [dbo].[X_User].[Id], [dbo].[X_User].[Name], [dbo].[X_User].[Password], [dbo].[X_User].[Enabled], [dbo].[X_User].[Email], [dbo].[X_User].[Gender], [dbo].[X_User].[RealName], [dbo].[X_User].[QQ], [dbo].[X_User].[MSN], [dbo].[X_User].[CellPhone], [dbo].[X_User].[OfficePhone], [dbo].[X_User].[HomePhone], [dbo].[X_User].[Remark], [dbo].[X_User].[DeptId], [dbo].[X_User].[RoleId], [dbo].[X_User].[CreateTime]

FROM [dbo].[X_User]
INNER JOIN [dbo].[X_RoleUser] ON [dbo].[X_User].[Id] = [dbo].[X_RoleUser].[UserId]

INNER JOIN @TempTable t ON [dbo].[X_User].[Id] = t._keyID
WHERE t.IndexId BETWEEN ((@Page - 1) * @PageSize + 1) AND (@Page * @PageSize)

 

向當前角色添加現有用戶

對於這個情況，我們要注意一點，就是供選擇的現有用戶不應當包括哪些已經屬於當前角色的用戶，可以用子查詢來實現：

SqlQuery q = new Select().From<XUser>(); //.LeftOuterJoin(XRoleUser.UserIdColumn, XUser.IdColumn);
q.Where("1").IsEqualTo("1");

// 在職務名稱中搜索
string searchText = ttbSearchMessage.Text.Trim();
if (!String.IsNullOrEmpty(searchText))
{
    q.And(XUser.NameColumn).ContainsString(searchText);
}

// 排除已經屬於本角色的用戶
int currentRoleId = GetQueryIntValue("id");
SqlQuery subQ = new Select(XRoleUser.UserIdColumn).From<XRoleUser>().Where(XRoleUser.RoleIdColumn).IsEqualTo(currentRoleId);

q.And(XUser.IdColumn).NotIn(subQ);
//q.And(XUser.IdColumn).IsNotEqualTo(1);

// 只列出不在當前角色中的用戶
//q.AndExpression(XUser.RoleIdColumn.ColumnName).IsNotEqualTo(GetQueryIntValue("id")).Or(XUser.RoleIdColumn).IsNull().CloseExpression();

// 在查詢添加之后，排序和分頁之前獲取總記錄數
// Grid1總共有多少條記錄
Grid1.RecordCount = q.GetRecordCount();

// 排列
q.OrderBys.Add(GetSortExpression(Grid1, XUser.Schema));

// 數據庫分頁
q.Paged(Grid1.PageIndex + 1, Grid1.PageSize);
XUserCollection items = q.ExecuteAsCollection<XUserCollection>();

 

小結

雖然SubSonic2.2的代碼已經不更新了，但是在實際應用中，我們可以恰當的修正其源代碼來滿足需求，這也歸功於開源的力量。同時也希望大家能多關注同樣是完全開源的ExtAspNet（基於ExtJS的專業ASP.NET2.0控件庫）。

 

注：AppBox是捐贈軟件，也就是說你可以通過捐贈作者來獲得AppBox源代碼。