使用Lua指令碼語言開發出高擴充套件性的系統，AgileEAS.NET SOA中介軟體Lua指令碼引擎介紹

一、前言

     AgileEAS.NET SOA 中介軟體平臺是一款基於基於敏捷並行開發思想和Microsoft .Net構件(元件)開發技術而構建的一個快速開發應用平臺。用於幫助中小型軟體企業建立一條適合市場快速變化的開發團隊，以達到節省開發成本、縮短開發時間，快速適應市場變化的目的。

     AgileEAS.NET SOA中介軟體平臺提供了敏捷快速開發軟體工程的最佳實踐，通過提供大量的基礎支撐功能如IOC、ORM、SOA、分散式體系及敏捷併發開發方法所支撐的外掛開發體系，以及提供了大量的實體、資料模型設計生成工具、程式碼生成工具，用於幫助中小軟體開發商快速成長。

     AgileEAS.NET平臺充分把握目前軟體行業快速發展的新趨勢，基於敏捷並行開發、快速適應市場這樣淳樸的軟體工程實踐，採用業界廣泛使用的Microsoft .Net構件(元件)開發技術實踐了這種開發思想，幫助軟體企業實現“敏捷變化、快速適合”的目標，從而幫助軟體企業在激烈的市場競爭中贏得先機並獲得更高的回報。

二、關於Lua語言

     Lua 是一個小巧的指令碼語言。是巴西里約熱內盧天主教大學（Pontifical Catholic University of Rio de Janeiro）裡的一個研究小組，由Roberto Ierusalimschy、Waldemar Celes 和 Luiz Henrique de Figueiredo所組成並於1993年開發。 其設計目的是為了嵌入應用程式中，從而為應用程式提供靈活的擴充套件和定製功能。

     Lua語言目前應用最廣泛的領域是遊戲程式設計領域，最早接觸和認識Lua也是因為在2008年玩金山的劍網3，通過解包讀過其中的一些遊戲指令碼，慢慢也看過一些其他遊戲的Lua指令碼，在我們開發自己的電子病歷系統的過程之中，引入了Lua指令碼語言實現那些可變性非常高的場景。

    .NET通過LuaInterface開源專案類庫實現對Lua的指令碼呼叫以及Lua與C#的相互繫結，有關於這此方面的內容請大家搜尋相關文章以獲得幫助。

     在AgileEAS.NET SOA5.0版本之中，我們決定把在開發過程之中形成的Lua指令碼引擎一併整合入AgileEAS.NET SOA中介軟體平臺,目前Lua指令碼語言被我們廣泛的應用電子病歷系統這中的病案自動評分、簡訊系統之中的互動式應答、和一些計劃任系統之中的計劃任務定義。

三、AgileEAS.NET SOA平臺Lua引擎

     AgileEAS.NET SOA5.0平臺目前使用的是Lua5.1版本，使用LuaInterface實現C#與Lua的相互繫結處理，平臺已經對其進行了二次封裝以提供統一的API支援，目前由EAS.LuaScript.dll程式集承載所有業務。

     AgileEAS.NET SOA平臺Lua引擎提供了以下介面或型別的API：

     ILuaEngine，定義為一個Lua指令碼引擎：

using System;

namespace EAS.LuaScript
{
    /// <summary>
    /// Lua指令碼解析引擎。
    /// </summary>
    /// <remarks>
    /// 用於完成程式之中嵌入的動態Lua指令碼，Lua指令碼在AgileEAS.NET SOA 中介軟體之中主要用於環境的各種引數的動態解析處理之中。
    /// </remarks>
    public interface ILuaEngine:IDisposable
    {
        /// <summary>
        /// 指令碼路徑。
        /// </summary>
        string ScriptDirectory
        {
            get;
            set;
        }

        /// <summary>
        /// 輸出重定向方法/用於除錯。
        /// </summary>
        Action<object> OutAction
        {
            get;
            set;
        }

        /// <summary>
        /// 註冊lua函式，實現Lua繫結。
        /// </summary>
        /// <param name="luaAPIClass">lua函式類</param>
        void BindLuaFunctions(object luaAPIClass);

        /// <summary>
        /// 執行lua指令碼檔案。
        /// </summary>
        /// <param name="luaFileName">指令碼檔名。</param>
        /// <returns>lua指令碼執行結果。</returns>
        object[] DoFile(string luaFileName);

        /// <summary>
        /// 執行lua指令碼文字。
        /// </summary>
        /// <param name="chunk">lua指令。</param>
        /// <returns>lua指令碼執行結果。</returns>
        object[] DoString(string chunk);

        /// <summary>
        /// 呼叫Lua函式。
        /// </summary>
        /// <param name="luaFunction">函式名稱。</param>
        /// <param name="args">呼叫引數。</param>
        /// <returns>lua指令碼執行結果。</returns>
        object[] Invoke(string luaFunction, params object[] args);
    }
}

     其中指令碼路徑ScriptDirectory指示Lua指令碼檔案的儲存位置，在DoFile執行指令碼文過程之中如果傳入為相關路徑則可以自動在ScriptDirectory之中定址，ScriptDirectory預設為當前程式目錄。

     DoFile：執行指令碼檔案並且返回執行結果。

     DoString：執行指令碼程式碼並且返回執行結果。

     Invoke：執行指定的指令碼函式。

      LuaFunctionAttribute，Lua指令碼函式特性：

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

namespace EAS.LuaScript
{
    /// <summary>
    /// Lua函式描述特性。
    /// </summary>
    /// <remarks>
    /// 用於標記Lua介面方法。
    /// </remarks>
    [AttributeUsage(AttributeTargets.Method,
                    Inherited = false, AllowMultiple = false)]
    [Serializable]
    public class LuaFunctionAttribute : Attribute
    {
        /// <summary>
        /// 初始化LuaFunctionAttribute物件例項。
        /// </summary>
        /// <param name="name">函式名稱。</param>
        public LuaFunctionAttribute(string name)
            : this(name, string.Empty)
        {

        }

        /// <summary>
        /// 初始化LuaFunctionAttribute物件例項。
        /// </summary>
        /// <param name="name">函式名稱。</param>
        /// <param name="description">函式描述。</param>
        public LuaFunctionAttribute(string name, string description)
            : this(name, description,null)
        {

        }

        /// <summary>
        /// 初始化LuaFunctionAttribute物件例項。
        /// </summary>
        /// <param name="name">函式名稱。</param>
        /// <param name="description">函式描述。</param>
        /// <param name="funcParams">引數說明。</param>
        public LuaFunctionAttribute(string name, string description, params string[] funcParams)
        {
            this.Name = name;
            this.Description = description;
            this.Params = funcParams;
        }

        /// <summary>
        /// 函式名稱。
        /// </summary>
        public string Name
        {
            get;
            internal set;
        }

        /// <summary>
        /// 函式描述。
        /// </summary>
        public string Description
        {
            get;
            internal set;
        }

        /// <summary>
        /// 引數說明。
        /// </summary>
        public string[] Params
        {
            get;
            internal set;
        }
    }
}

     用於C#向Lua暴露函式介面，實現C#方法與Lua指令碼函式的繫結，也可以實現為把C#的方法暴露給Lua指令碼呼叫，如以下程式碼：

/// <summary>
/// 執行指定的非查詢命令。
/// </summary>
/// <param name="commandText">要執行的命令語句。該語句必須是標準的資料庫語句。</param>
/// <returns>返回命令影響的行數。</returns>
[LuaFunction("ExecuteSql", "執行指定的非查詢命令，返回執行所影響的行數。", "要執行的SQL語句")]
public int Execute(string commandText)
{
    IDataAccessor da = this.GetComponent();
    if (da != null)
    {
        return da.Execute(commandText);
    }
    else
    {
        return -1;
    }
}

     其目標早實現C#方法Execute與Lua指令碼函式ExecuteSql之間的繫結，當在Lua教本之中呼叫ExecuteSql，即會執行Execute方法。

     LuaFramework，Lua框架，為Lua指令碼引用最重要的API：

#region 程式集 EAS.LuaScript.dll, v4.0.30319
// G:\Health.Work\AgileEMR4.0\Publish\EAS.LuaScript.dll
#endregion

using System;

namespace EAS.LuaScript
{
    // 摘要:
    //     Lua指令碼執行框架/上下文。
    //
    // 備註:
    //     應用系統之中呼叫Lua指令碼的入口。
    public sealed class LuaFramework
    {
        // 摘要:
        //     LuaFramework物件的唯一例項。
        public static LuaFramework Instance { get; }

        // 摘要:
        //     註冊lua函式，實現Lua繫結。
        //
        // 引數:
        //   luaAPIClass:
        //     lua函式類
        public static void BindLuaFunctions(object luaAPIClass);
        //
        // 摘要:
        //     從應用程式上下文環境之中獲取指定名稱的物件例項。
        //
        // 引數:
        //   componentKey:
        //     元件名稱。
        //
        // 返回結果:
        //     物件例項。
        public object GetComponent(string componentKey);
        //
        // 摘要:
        //     Lua指令碼引擎。
        public static ILuaEngine GetLuaEngine();
        //
        // 摘要:
        //     Lua指令碼引擎。
        public static ILuaEngine GetLuaEngine(string scriptDirectory);
        //
        // 摘要:
        //     取系統時間。
        [LuaFunction("GetTime", "取系統時間")]
        public DateTime GetTime();
    }
}

     其中BindLuaFunctions方法實現C#方法與Lua函式的繫結註冊，呼叫時傳入需要註冊方法所在的C#類物件例項即可。
     GetLuaEngine獲取一個ILuaEngine，為之後的執行指令碼作準備，呼叫GetLuaEngine可選傳入scriptDirectory引數，scriptDirectory為Lua指令碼儲存目錄。

     AgileEAS.NET SOA中介軟體已經為大家提供了少數的幾個預定義API繫結：

helpcmd(cmdName) - Show help for a given command or package
help() - List available commands.
Include(luaFileName) - 預載入指定的指令碼檔案
echo(message) - 顯示Lua除錯資訊，用於Lua的動態除錯。
Echo(message) - 顯示Lua除錯資訊，用於Lua的動態除錯。
WriteLog(message) - 寫日誌記錄，用於Lua指令碼的動態除錯。
GetTime() - 取系統時間
GetComponent(componentKey) - 從應用程式上下文環境之中獲取指定名稱的物件例項
GetAccount() - 求當前賬戶資訊
ExecuteSql(commandText) - 執行指定的非查詢命令，返回執行所影響的行數。
QuerySql(commandText, resultType) - 執行給定的資料庫查詢命令，返回執行結果，返回結果由resultType引數決定。
QuerySqlScalar(commandText) - 執行給定的資料庫查詢命令，僅返回第一行第一列結果
QuerySqlMatrix(commandText) - 執行給定的資料庫查詢命令，返回第一個查詢結果Matrix
QuerySqlDictionary(commandText) - 執行給定的資料庫查詢命令，返回第一行的Key-Value
QuerySqlList(commandText) - 執行給定的資料庫查詢命令，返回第一行的Key-Value
QuerySqlDataSet(commandText) - 執行給定的資料庫查詢命令，返回查詢結果集
QuerySqlDataTable(commandText) - 執行給定的資料庫查詢命令，返回查詢結果集的第一個DataTable
GetDataSet() - 求當前系統的帳套資訊

     大家也可以基於AgileEAS.NET SOA 平臺Lua引擎擴充套件自己的LuaAPI。

四、AgileEAS.NET SOA平臺Lua引擎應用案例

     在我12年的醫療行業開發之中，做過多年的電子病歷，開發、指導開發過多套電子病歷系統，在電子病歷系統之中，有以下幾個問題一直得不到好的解決方案：

     在電子病歷質控之中有一個自動質控評分，其由程式自動的預先為某個病案打出一個得分：

     在沒有使用Lua教本之前呢，也是能實現這種自動評分，但是為了實現這樣的功能，系統設計之中就會要增加一些輔助的表和大量的輔助設計以幫助完成這樣的功能，因為畢竟不存在統一的評分規則，所以這個設計會極其的複雜，以致於很難把這樣的功能做好，或者說在成本和效益估量之中，得不償失。

     另外還有比較簡單的例子就是電子病歷之間的巨集替換問題，在書寫電子病歷的過程之中需要動態的插入如病人基本資訊、醫院名稱這樣的東西進入病歷，但是因為其資料來源並不是唯一確定的，如果不使用動態指令碼設計，那麼其程式這中就會存在大量的硬編碼，並且如果想要在後期實施階段增加巨集，那麼則必須要修改程式才能完成。

     下面我們就以自動評分案例向大家講解一下是如何實現功能的呢：

     首先，系統之中必須管理和維護用於自動評分的所有評分規則：

     這裡與其他很多開發者的做法不一樣的是，對於每個缺陷專案，我們都為其提供了一個評分規則的指令碼的設計,例如對於缺陷“*缺入院記錄”的評分指令碼如下:

-----------------------------------------------------------------------------------------------
-- 建立人   :  魏瓊東
-- 建立時間    : 2013-09-05
-- 效果備註    : *缺入院記錄評分指令碼。
--               GetErrorNumber,求缺陷數量，由指令碼計算出本缺陷數量
----------------------------------------------------------------------------------------------
------------------------不怎麼華麗的分割線--------------------------------------
function GetErrorNumber(patient,errorItem)

    --呼叫C#，求監控專案
    local monitorItem = GetMonitorItem("B01")
    --監控表示式,無表示式返回0
    local script = monitorItem.Expression
    if script == nil then
        return 0
    elseif script == "" then
        return 0
    end

    --載入監控指令碼
    ExecuteScript(script)
    --執行監控函式NeedWrite，如果需要寫則預標存在此缺陷
    local need = NeedWrite(patient,monitorItem)

    if need == 1 then
        return 1
    else
        return 0
    end

end

這樣的設計的目標是將缺陷的評分動作都由Lua指令碼實現，而在應用程式之中並不存在針對缺陷制定不同的評分規則的情況，只有呼叫指令碼進行評分的程式碼：

/// <summary>
/// 求指定患者、指定缺陷的缺陷數。
/// </summary>
/// <param name="pRoot"></param>
/// <param name="errorItem"></param>
/// <returns></returns>
public static int GetErrorNumber(ILuaEngine m_Lua, PatientRoot pRoot, ErrorDict errorItem)
{
    if (string.IsNullOrEmpty(errorItem.Expression))  //無評分指令碼
    {
        return 0;
    }

    string m_file = System.IO.Path.Combine(LuaEx.ScriptDirectory, string.Format("emr\\error\\{0}.lua", errorItem.ErrorCode));
    if (!System.IO.File.Exists(m_file))
    {
        return 0;
    }

    try
    {
        m_Lua.DoFile(m_file);  //載入指令碼

        object[] vs = m_Lua.Invoke("GetErrorNumber", pRoot, errorItem);  //執行函式。
        if (vs != null && vs.Length > 0)
        {
            return int.Parse(vs[0].ToString());
        }
        else
        {
            return 0;
        }
    }
    catch
    {
        return 0;
    }
}

這樣的好處在於，主體程式變的極其的簡單一致，不需要各種判斷和各種規則，並且靈活自動，可以做到政策變化或者客戶需求變化導到的各種評分規則的修改，則會靈活自如。

     實踐證明，使用動態指令碼語言擴充套件現在系統的系統是一種低投入高產出的工作，對於應對這種高擴充套件性和高定製性的專案是一個非常好的選擇，這個可以解釋遊戲程式設計之中大量使用Lua語言的事實，針對NPC、劇情書寫相關的處理指令碼，讓遊戲的後期變更，調整變得簡單可行。

四、聯絡我們

     為完善、改進和推廣AgileEAS.NET而成立了敏捷軟體工程實驗室，是一家研究、推廣和發展新技術，並致力於提供具有自主智慧財產權的業務基礎平臺軟體，以及基於業務基礎平臺開發的管理軟體的專業軟體提供商。主要業務是為客戶提供軟體企業研發管理解決方案、企業管理軟體開發，以及相關的技術支援，管理及技術諮詢與培訓業務。

     AgileEAS.NET SOA中介軟體平臺自2004年秋呱呱落地一來，我就一直在逐步完善和改進，也被應用於保險、醫療、電子商務、房地產、鐵路、教育等多個應用，但一直都是以我個人在推廣，2010年因為我辭職休息，我就想到把AgileEAS.NET推向市場，讓更多的人使用。

     我的技術團隊成員都是合作多年的老朋友，因為這個平臺是免費的，所以也沒有什麼收入，都是由程式設計師的那種理想與信念堅持，在此我感謝一起奮鬥的朋友。

團隊網站：http://www.agilelab.cn，

AgileEAS.NET網站：http://www.smarteas.net

官方部落格:http://eastjade.cnblogs.com

QQ:47920381,AgileEAS.NET

QQ群：113723486（AgileEAS SOA 平臺）/上限1000人

199463175（AgileEAS SOA 交流）/上限1000人

212867943（AgileEAS.NET研究）/上限500人

147168308（AgileEAS.NET應用）/上限500人

172060626（深度AgileEAS.NET平臺）/上限500人

116773358（AgileEAS.NET 平臺）/上限500人

125643764（AgileEAS.NET探討）/上限500人

193486983（AgileEAS.NET 平臺）/上限500人

郵件:james@agilelab.cn,mail.james@qq.com,

電話：18629261335。