基於SqlSugar的開發框架循序漸進介紹（24）-- 使用Serialize.Linq對Lambda表達式進行序列化和反序列化

在上篇隨筆《基於SqlSugar的開發框架循序漸進介紹（23）-- Winform端管理系統中平滑增加對Web API對接的需求》中介紹了基於一個介面，實現對兩種不同接入方式（直接訪問資料庫實現，基於Web API代理類實現）的處理，由於定義的介面中，我們為了方便，也是用了Lambda表達式的進行一... ...

在上篇隨筆《基於SqlSugar的開發框架循序漸進介紹（23）-- Winform端管理系統中平滑增加對Web API對接的需求》中介紹了基於一個介面，實現對兩種不同接入方式（直接訪問資料庫實現，基於Web API代理類實現）的處理，由於定義的介面中，我們為了方便，也是用了Lambda表達式的進行一些參數的處理，那麼如果在Web API代理類中，Lambda表達式是不能直接傳遞給Web API的控制器的，那麼如何對這個Lambda表達式進行序列化和反序列化還原就是一個急需解決的問題。本篇隨筆介紹採用Serialize.Linq 第三方組件的方式實現對Lambda表達式進行序列化和反序列化的處理。

1、Lambda表達式的介面使用

Lambda 表達式本質上是一個匿名函數，是C#中一種特殊語法，它的引入，使得匿名方法更加簡單易用，最直接的是在方法體內調用代碼或者為委托傳入方法體的形式與過程變得更加優雅。使用Lambda表達式可大大減少代碼量，使得代碼更加的優美、簡潔，更有可觀性。由於Lambda表達式的便利性，因此雖然在整合多個接入實現比較麻煩一些，我依舊希望通過尋找方法實現對Lambda表達式的相容處理。

例如，以下就是一個根據名稱簡單進行判斷的Lambda表達式的處理。

/// <summary>
/// 新增狀態下的數據保存
/// </summary>
/// <returns></returns>
public async override Task<bool> SaveAddNew()
{
    CustomerInfo info = tempInfo;//必須使用存在的局部變數，因為部分信息可能被附件使用
    SetInfo(info);
    try
    {
        #region 新增數據
        //檢查是否還有其他相同關鍵字的記錄
        bool isExist = await BLLFactory<ICustomerService>.Instance.IsExistAsync(s=> s.Name.Equals(info.Name));
        if (isExist)
        {
            MessageDxUtil.ShowTips("指定的【姓名】已經存在，不能重覆添加，請修改");
            return false;
        }

        var success = await BLLFactory<ICustomerService>.Instance.InsertAsync(info);
        if (success)
        {
            //可添加其他關聯操作
            return true;
        }
        #endregion
    }
    catch (Exception ex)
    {
        LogTextHelper.Error(ex);
        MessageDxUtil.ShowError(ex.Message);
    }
    return false;
}

它的函數原型就是一個Lambda表達式，如下所示的定義

/// <summary>
/// 判斷是否存在指定條件的記錄
/// </summary>
/// <param name="input">表達式條件</param>
/// <returns></returns>
Task<bool> IsExistAsync(Expression<Func<TEntity, bool>> input);

有些稍微複雜一點的函數，如下定義所示。

/// <summary>
/// 獲取某欄位數據字典列表
/// </summary>
Task<List<string>> GetFieldList(Expression<Func<TEntity, object>> selector, Expression<Func<TEntity, bool>> where = null);

調用的時候，如下所示。

/// <summary>
/// 初始化數據字典
/// </summary>
private async void InitDictItem()
{
    //初始化代碼            
    var list = await BLLFactory<IFormService>.Instance.GetFieldList(s=> s.Category);
    this.txtCategory.BindDictItems(list, "");
}

不過簡單是簡單了，但是本身Lambda表達式不能直接傳遞給Web API端參數，因為它無法直接序列化進行傳遞。

我們在之前說過，接入兩種不同的數據提供方式。

因此我們為了繼續使用Lambda表達是的優點，就需要使用Serialize.Linq對Lambda表達式進行序列化和反序列化。這樣就可以在Web API端和Web API 代理端對Lambda表達式進行正常的使用了。

2、採用Serialize.Linq 對Lambda表達式進行序列化和反序列化的處理

首先在需要的地方，引入Serialize.Linq對Lambda表達式進行序列化和反序列化處理。

為了更好通用的實現Lambda表達式的正常序列化為文本，以及對文本的反序列化到Lambda表達式，我們這裡編寫了一個擴展函數，以便更方便的處理。

    /// <summary>
    /// 對Lambda表達式的序列號和反序列化處理
    /// </summary>
    public static class SerializeExtension
    {
        /// <summary>
        /// 序列化 LINQ Expression 表達式為JSON文本
        /// </summary>
        /// <typeparam name="TEntity">處理對象類型</typeparam>
        /// <typeparam name="TResult">返回結果類型</typeparam>
        /// <param name="express"></param>
        /// <returns></returns>
        public static string SerializeText<TEntity, TResult>(this Expression<Func<TEntity, TResult>> express)
        {
            //使用Serialize.Linq組件序列化表達式，傳遞給API端，API端需要對應反序列化的處理操作進行轉換Expression
            var serializer = new ExpressionSerializer(new JsonSerializer());
            var expressJson = serializer.SerializeText(express);

            //接收端的反序列化處理
            //var express = (Expression<Func<TEntity, TResult>>)serializer.DeserializeText(expressJson);

            return expressJson;
        }

        /// <summary>
        /// 反序列化JSON文本為LINQ Expression 表達式
        /// </summary>
        /// <typeparam name="TEntity">處理對象類型</typeparam>
        /// <typeparam name="TResult">返回結果類型</typeparam>
        /// <param name="text"></param>
        /// <returns></returns>
        public static Expression<Func<TEntity, TResult>> DeserializeText<TEntity, TResult>(this string json)
        {
            Expression<Func<TEntity, TResult>> express = null;
            if (!string.IsNullOrWhiteSpace(json))
            {
                var serializer = new ExpressionSerializer(new JsonSerializer());
                express = (Expression<Func<TEntity, TResult>>)serializer.DeserializeText(json);
            }
            return express;
        }
    }

這樣我們來看看兩個對Lambda表達式的Web API代理類的封裝處理代碼

        /// <summary>
        /// 根據條件，獲取所有記錄
        /// </summary>
        public virtual async Task<ListResultDto<TEntity>> GetAllAsync(Expression<Func<TEntity, bool>> input, string orderBy = null)
        {
            var express = input.SerializeText(); //使用擴展函數處理生成JSON
            var postData = new
            {
                express,
                orderBy
            };
            return await DoActionAsync<ListResultDto<TEntity>>("all-expression", postData, HttpVerb.Post);
        }

        /// <summary>
        /// 根據條件計算記錄數量
        /// </summary>
        /// <returns></returns>
        public virtual async Task<long> CountAsync(Expression<Func<TEntity, bool>> input)
        {
            var expressJson = input.SerializeText(); //使用擴展函數處理生成JSON
            return await DoActionAsync<long>("count-expression", expressJson, HttpVerb.Post);
        }

而對應的在Web API的基類控制器中，我們對這個通用的實現處理下就可以了

        /// <summary>
        /// 根據條件，獲取所有記錄
        /// </summary>
        [HttpPost]
        [Route("all-expression")]
        public async Task<ListResultDto<TEntity>> GetAllAsync(ExpressionOrderDto input)
        {
            ListResultDto<TEntity>? result = null;

            string json = input.expression;
            var express = json.DeserializeText<TEntity, bool>();

            if (express != null)
            {
                result = await _service.GetAllAsync(express!);
            }

            return result;
        }

        [HttpPost]
        [Route("count-expression")]
        public virtual async Task<long> CountAsync(dynamic expressJson)
        {
            long result = 0;
            string json = expressJson;
            var express = json.DeserializeText<TEntity, bool>();

            if (express != null)
            {
                result = await _service.CountAsync(express!);
            }
            return result;
        }

這樣在伺服器端的Web API控制器上，就還原了原先的Lambda表達式，可以正常的接收到客戶端提交的條件處理了。

通過這樣的迂迴的方式，我們就可以在常規的介面，以及Web API的代理類中，都可以使用到Lambda表達式帶來的便利性了，而不需要為了相容而拋棄Lambda表達式介面參數的方式了。

我們可以把其中相關的Lambda表達式，放在一個區塊中，方便查看和處理，如下代碼所示是在服務端的Web API控制器的基類函數處理代碼。

系列文章：

《基於SqlSugar的開發框架的循序漸進介紹（1）--框架基礎類的設計和使用》

《基於SqlSugar的開發框架循序漸進介紹（2）-- 基於中間表的查詢處理》

《基於SqlSugar的開發框架循序漸進介紹（3）-- 實現代碼生成工具Database2Sharp的整合開發》

《基於SqlSugar的開發框架循序漸進介紹（4）-- 在數據訪問基類中對GUID主鍵進行自動賦值處理》

《基於SqlSugar的開發框架循序漸進介紹（5）-- 在服務層使用介面註入方式實現IOC控制反轉》

《基於SqlSugar的開發框架循序漸進介紹（6）-- 在基類介面中註入用戶身份信息介面》

《基於SqlSugar的開發框架循序漸進介紹（7）-- 在文件上傳模塊中採用選項模式【Options】處理常規上傳和FTP文件上傳》

《基於SqlSugar的開發框架循序漸進介紹（8）-- 在基類函數封裝實現用戶操作日誌記錄》

《基於SqlSugar的開發框架循序漸進介紹（9）-- 結合Winform控制項實現欄位的許可權控制》

《基於SqlSugar的開發框架循序漸進介紹（10）-- 利用axios組件的封裝，實現對後端API數據的訪問和基類的統一封裝處理》

《基於SqlSugar的開發框架循序漸進介紹（11）-- 使用TypeScript和Vue3的Setup語法糖編寫頁面和組件的總結》

《基於SqlSugar的開發框架循序漸進介紹（12）-- 拆分頁面模塊內容為組件，實現分而治之的處理》

《基於SqlSugar的開發框架循序漸進介紹（13）-- 基於ElementPlus的上傳組件進行封裝，便於項目使用》

《基於SqlSugar的開發框架循序漸進介紹（14）-- 基於Vue3+TypeScript的全局對象的註入和使用》

《基於SqlSugar的開發框架循序漸進介紹（15）-- 整合代碼生成工具進行前端界面的生成》

《基於SqlSugar的開發框架循序漸進介紹（16）-- 工作流模塊的功能介紹》

《基於SqlSugar的開發框架循序漸進介紹（17）-- 基於CSRedis實現緩存的處理》

《基於SqlSugar的開發框架循序漸進介紹（18）-- 基於代碼生成工具Database2Sharp，快速生成Vue3+TypeScript的前端界面和Winform端界面》

《基於SqlSugar的開發框架循序漸進介紹（19）-- 基於UniApp+Vue的移動前端的功能介紹》

《基於SqlSugar的開發框架循序漸進介紹（20）-- 在基於UniApp+Vue的移動端實現多條件查詢的處理》

《基於SqlSugar的開發框架循序漸進介紹（21）-- 在工作流列表頁面中增加一些轉義信息的輸出，在後端進行內容轉換》

《基於SqlSugar的開發框架循序漸進介紹（22）-- Vue3+TypeScript的前端工作流模塊中實現統一的表單編輯和表單詳情查看處理》

《基於SqlSugar的開發框架循序漸進介紹（23）-- Winform端管理系統中平滑增加對Web API對接的需求》

《基於SqlSugar的開發框架循序漸進介紹（24）-- 使用Serialize.Linq對Lambda表達式進行序列化和反序列化》

專註於代碼生成工具、.Net/.NetCore 框架架構及軟體開發，以及各種Vue.js的前端技術應用。著有Winform開發框架/混合式開發框架、微信開發框架、Bootstrap開發框架、ABP開發框架、SqlSugar開發框架等框架產品。
轉載請註明出處：撰寫人：伍華聰 http://www.iqidi.com