C# 代碼中調用 Javascript 代碼段以提高應用程序的配置靈活性(使用 Javascript .NET 與 Jint)

一般來說，我們需要在開發應用軟件的配置文件中，添加一些參數，用於后續用戶根據實際情況，自行調整。

配置參數，可以放在配置文件中、環境變量中、或數據庫表中(如果使用了數據庫的話)。通常，配置數據，以 key/value 的形式。

有時候，這種  key/value 的形式，不足以滿足用戶需求。比如，系統中有個定時刪除臨時文件的 job ，我們希望在客戶工廠的生產交接班期間及員工吃飯時間，比如客戶工廠生產交接班時間為 5:30 - 6:00 , 23:00-23:30, 中途吃飯時間為 11:00, 4:00。

也許，可以用正則表達式，來實現以上的功能。但實際情況一調查，我們發現，客戶用戶懂正則表達式的基本沒有，我們自己公司軟件開發人員懂正則表達式的也很少。如果做成正則表達式方式，后續代碼交接之后，能不能維護/修改，也很難說。

這樣，我們找到了"以 Javascript 的代碼段，進行判斷，作為配置參數值"，這樣可以完美地解決我們的問題。Javascript 基本語法簡單，客戶用戶也可自行更改。

 

對於可在 C# 代碼中使用的 Javascript 引擎，我們找到了兩個:  Javascript .NET 與 Jint。前者依賴於 Goolge V8 引擎，運行時需要 Microsoft C Runtime Libraries, 后者則是純 C# 代碼組件。

為同時測試這兩種，我們先進行代碼抽象: 

Javascript 代碼，可能無 package/namespace ，可能無 function ，只是一段代碼。但無論如何，調用前賦值、調用程序、調用后獲取需要的數值，這個基本邏輯，是不會變的。

a. 基礎類定義如下：

using System.Collections.Generic;

namespace xxxx
{
    public interface IJavascriptEngine
    {
        /// <summary>
        /// 執行一段 Javascript 代碼，傳入一些參數，得到一些數值
        /// </summary>
        /// <param name="strJavascriptCode"></param>
        /// <param name="inputParameters"></param>
        /// <param name="outputNameValues">傳入時，只填key, 保留 value為空；返回時，填寫value</param>
        void Execute(string strJavascriptCode, Dictionary<string, object> inputParameters, Dictionary<string, object> outputNameValues);
    }
}

 

b. Javascript .NET 實現以上接口的代碼如下:

using System.Collections.Generic;

namespace dispatch_service.srv
{
    public class JsNetJavascriptEngineSrv : IJavascriptEngine
    {
        public virtual void Execute(string strJavascriptCode, Dictionary<string, object> inputParameters, Dictionary<string, object> outputNameValues)
        {
            using (Noesis.Javascript.JavascriptContext context = new Noesis.Javascript.JavascriptContext())
            {
                //step 1, 初始化各個變量值
                foreach (KeyValuePair<string, object> pair in inputParameters)
                {
                    context.SetParameter(pair.Key, pair.Value);
                }

                //step 2, 執行 Javascript 代碼，可能是多個函數，或無函數的代碼段
                context.Run(strJavascriptCode);

                //step 3, 讀取所需的變量值，暫存到 nonNullKeyValues 變量中。
                Dictionary<string, object> nonNullKeyValues = new Dictionary<string, object>();
                foreach (KeyValuePair<string, object> pair in outputNameValues)
                {
                    object value = context.GetParameter(pair.Key);
                    if (value != null)
                    {
                        nonNullKeyValues[pair.Key] = value;
                    }
                }

                //step 4，將暫存的變量值，通過 outputNameValues 返回。
                foreach (KeyValuePair<string, object> pair in nonNullKeyValues)
                {
                    outputNameValues[pair.Key] = pair.Value;
                }
            }
        }
    }
    
}

 

c. Jint 實現此接口的代碼如下:

using System.Collections.Generic;
using Jint;

namespace xxxx
{
    public class JintJavascriptEngineSrv : IJavascriptEngine
    {
        public virtual void Execute(string strJavascriptCode, Dictionary<string, object> inputParameters, Dictionary<string, object> outputNameValues)
        {
            Engine en = new Engine();
           
            //step 1, 初始化各個變量值
            foreach (KeyValuePair<string, object> pair in inputParameters)
            {
                en.SetValue(pair.Key, pair.Value);
            }
               
            //step 2, 執行 Javascript 代碼，可能是多個函數，或無函數的代碼段
            en.Execute(strJavascriptCode);

            //step 3, 讀取所需的變量值，暫存到 nonNullKeyValues 變量中。
            Dictionary<string, object> nonNullKeyValues = new Dictionary<string, object>();
            foreach (KeyValuePair<string, object> pair in outputNameValues)
            {
                Jint.Native.JsValue value = en.GetValue(pair.Key);
                if (value != null)
                {
                    nonNullKeyValues[pair.Key] = value.ToObject();
                }
            }

            //step 4，將暫存的變量值，通過 outputNameValues 返回。
            foreach (KeyValuePair<string, object> pair in nonNullKeyValues)
            {
                outputNameValues[pair.Key] = pair.Value;
            }

        }
    }
}

 

d. 最后，調用代碼里，可以自由切換以上兩種 Javascript 引擎:

                Dictionary<string, object> inputParameters = new Dictionary<string, object>();
                //給 inputParameters 填充數值，此處無需填充。

                Dictionary<string, object> outputNameValues = new Dictionary<string, object>();
                //給 outputNameValues 填充 key 值，此處需得到 canRunNow 變量數值。
                outputNameValues["canRunNow"] = null;

            //IJavascriptEngine eng = new JsNetJavascriptEngineSrv();  9 IJavascriptEngine eng = new JintJavascriptEngineSrv(); 10 
                eng.Execute(jsStr, inputParameters, outputNameValues);
                object objValue = outputNameValues["canRunNow"];
                System.Nullable<bool> bValue =(System.Nullable<bool>) objValue;
                if (bValue != null && bValue.Value)
                {
                    needRunNow = true;
                }

 

e. 附上 Javascript 代碼段:

var nowTime=new Date(); var canRunNow = false; var nowHour = nowTime.getHours();  var nowMin = nowTime.getMinutes();  if ( nowHour == 22 && nowMin == 0 ) {canRunNow = true;}

或:

var nowTime=new Date(); var canRunNow = false; var nowMin = nowTime.getMinutes(); var nowSec = nowTime.getSeconds(); if ( nowSec % 3 == 0 ) {canRunNow = true;}

這樣配置就很靈活了。

當然，這里的 Javascript 代碼段 , 作為配置參數 (key/value 中的 value)，我們把它的多個代碼寫成一行。其實，不寫成一行，也是可行的。

 

-----------------------------------------------------------------------------------------------------------------------

轉發請注明出處。當心我晚上變大灰狼來摸你肚子喲。我是 jacklondon , at , cnblogs.com. 

開源項目 velocityweb 維護人。上海折桂軟件有限公司負責人。當前在開發及推廣折桂打印平台系統、折桂上傳平台系統。 http://zheguisoft.com ; http://www.cnblogs.com/jacklondon ;