CQRS：CQRS+AJAX架構 之 查詢（Q）模型設計

背景

准備采用CQRS架構，之前也簡單的應用過（只是把讀和寫在程序級別進行了分離），這篇文章是我最近幾天的思考，寫下來希望大家多提意見。這篇文章不會涉及Command端的設計，重點關注如何設計查詢。

真心的希望大家看完后能給出你們的意見和想法。

什么是CQRS

CQRS：Command Query Responsibility Separation。我喜歡職責分離，這也是我采用這種架構的原因，確實能帶來單一職責的優點。

簡單的CQRS

復雜的CQRS

CQRS的常見查詢需求

下面是系統的一些查詢需求：

查詢面板

高級查詢

數據行級別的權限

如：個人、部門、分公司、品種。

固定約束

如：啟用、合法、租戶ID。

需求總結

CQRS的查詢設計

充分利用SQL和動態類型的優勢，不做太多無謂的封裝。

關鍵決策：

1. 1. 直接查詢數據庫返回Dynamic類型，不需要定義強類型。
   2. 直接用SQL，支持動態查詢面板和動態數據行權限。目前沒有找到封裝SQL的理由，最多是在外圍再封裝一層，但是不會隱藏SQL（我之前寫過一個簡單的查詢對象）。
   3. 利用一些策略防止SQL注入和權限提升（這篇文章不介紹）。

示例代碼

下載地址：http://happy.codeplex.com/SourceControl/latest。

AJAX程序

/// <reference path="Ext/ext-all-debug-w-comments.js" />

Ext.onReady(function () {
    var query = {
        TableOrViewName: 'Users',
        WhereClause: "Name NOT LIKE '%段%'"
    };

    Ext.Ajax.request({
        url: 'TestDynamicQuery/Fetch',
        method: 'POST',
        params: { query: Ext.encode(query) },
        success: function (response) {
            console.log(response.responseText);
        }
    });

    query = {
        TableOrViewName: 'Users',
        WhereClause: "Age >= 20 AND Age <= 27"
    };

    Ext.Ajax.request({
        url: 'TestDynamicQuery/Fetch',
        method: 'POST',
        params: { query: Ext.encode(query) },
        success: function (response) {
            console.log(response.responseText);
        }
    });
});

萬能查詢控制器

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Web.Mvc;

using Newtonsoft.Json;

using Happy.Query;

namespace Happy.Web.Mvc
{
    /// <summary>
    /// 動態查詢控制器。
    /// </summary>
    public abstract class DynamicQueryController<TDynamicQueryService> : AjaxController
        where TDynamicQueryService : IDynamicQueryService
    {
        /// <summary>
        /// 動態查詢服務。
        /// </summary>
        protected abstract TDynamicQueryService QueryService { get; }

        /// <summary>
        /// 獲取分頁數據，面向表格。
        /// </summary>
        public ActionResult Page(DynamicQueryObject query)
        {
            var result = this.QueryService.Page(query);

            return this.Json(result);
        }

        /// <summary>
        /// 獲取列表數據，面向不需要分頁的表格或下拉框。
        /// </summary>
        public ActionResult Fetch(DynamicQueryObject query)
        {
            var result = this.QueryService.Fetch(query);

            return this.NewtonsoftJson(result);
        }

        /// <summary>
        /// 獲取一個數據，面向表單。
        /// </summary>
        public ActionResult SingleOrDefault(DynamicQueryObject query)
        {
            var result = this.QueryService.Fetch(query);

            return this.NewtonsoftJson(result);
        }
    }
}

萬能查詢對象

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Happy.Query
{
    /// <summary>
    /// 動態查詢對象。
    /// </summary>
    public sealed class DynamicQueryObject
    {
        /// <inheritdoc />
        public DynamicQueryObject()
        {
            this.Columns = new List<string>();
            this.Page = 1;
            this.ItemsPerPage = 25;
        }

        /// <summary>
        /// 表或試圖名字。
        /// </summary>
        public string TableOrViewName { get; set; }

        /// <summary>
        /// 表或試圖名字。
        /// </summary>
        public List<string> Columns { get; set; }

        /// <summary>
        /// Where子句。
        /// </summary>
        public string WhereClause { get; set; }

        /// <summary>
        /// Order子句。
        /// </summary>
        public string OrderClause { get; set; }

        /// <summary>
        /// 第幾頁數據。
        /// </summary>
        public long Page { get; set; }

        /// <summary>
        /// 每頁條數。
        /// </summary>
        public long ItemsPerPage { get; set; }
    }
}

備注

寫這篇文章的目的，是系統大家多給些意見，我想知道你們是如何應對這種查詢需求的。