讓C#語言充當自身指令碼！——.NET中的動態編譯

阿新 • • 發佈：2018-12-31

程式碼的動態編譯並執行是.NET平臺提供給我們的很強大的一個工具，用以靈活擴充套件（當然是面對內部開發人員）複雜而無法估算的邏輯，並通過一些額外的程式碼來擴充套件我們已有的應用程式。這在很大程度上給我們提供了另外一種擴充套件的方式（當然這並不能算是嚴格意義上的擴充套件，但至少為我們提供了一種思路）。
動態程式碼執行可以應用在諸如模板生成，外加邏輯擴充套件等一些場合。一個簡單的例子，為了網站那的響應速度，HTML靜態頁面往往是我們最好的選擇，但基於資料驅動的網站往往又很難用靜態頁面實現，那麼將動態頁面生成html的工作或許就是一個很好的應用場合。另外，對於一些模板的套用，我們同樣可以用它來做。另外這本身也是外掛編寫的方式。

最基本的動態編譯

.Net為我們提供了很強大的支援來實現這一切我們可以去做的基礎，主要應用的兩個名稱空間是：System.CodeDom.Compiler和Microsoft.CSharp或Microsoft.VisualBasic。另外還需要用到反射來動態執行你的程式碼。動態編譯並執行程式碼的原理其實在於將提供的原始碼交予CSharpCodeProvider來執行編譯（其實和CSC沒什麼兩樣），如果沒有任何編譯錯誤，生成的IL程式碼會被編譯成DLL存放于于記憶體並載入在某個應用程式域（預設為當前）內並通過反射的方式來呼叫其某個方法或者觸發某個事件等。之所以說它是外掛編寫的一種方式也正是因為與此，我們可以通過預先定義好的藉口來組織和擴充套件我們的程式並將其交還給主程式去觸發。一個基本的動態編譯並執行程式碼的步驟包括：
將要被編譯和執行的程式碼讀入並以字串方式儲存
宣告CSharpCodeProvider物件例項
呼叫CSharpCodeProvider例項的CompileAssemblyFromSource方法編譯
用反射生成被生成物件的例項（Assembly.CreateInstance）
呼叫其方法

以下程式碼片段包含了完整的編譯和執行過程：

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Microsoft.CSharp;
using System.CodeDom.Compiler;
using System.Reflection;

namespace DynamicCompileBase
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            //get the code to compile
            string strSourceCode = this.txtSource.Text;

            // 1.Create a new CSharpCodePrivoder instance
            CSharpCodeProvider objCSharpCodePrivoder = new CSharpCodeProvider();

            // 2.Sets the runtime compiling parameters by crating a new CompilerParameters instance
            CompilerParameters objCompilerParameters = new CompilerParameters();
            objCompilerParameters.ReferencedAssemblies.Add("System.dll");
            objCompilerParameters.ReferencedAssemblies.Add("System.Windows.Forms.dll");
            objCompilerParameters.GenerateInMemory = true;

            // 3.CompilerResults: Complile the code snippet by calling a method from the provider
            CompilerResults cr = objCSharpCodePrivoder.CompileAssemblyFromSource(objCompilerParameters, strSourceCode);

            if (cr.Errors.HasErrors)
            {
                string strErrorMsg = cr.Errors.Count.ToString() + " Errors:";

                for (int x = 0; x < cr.Errors.Count; x++)
                {
                    strErrorMsg = strErrorMsg + "/r/nLine: " +
                                 cr.Errors[x].Line.ToString() + " - " +
                                 cr.Errors[x].ErrorText;
                }

                this.txtResult.Text = strErrorMsg;
                MessageBox.Show("There were build erros, please modify your code.", "Compiling Error");
                return;
            }

            // 4. Invoke the method by using Reflection
            Assembly objAssembly = cr.CompiledAssembly;
            object objClass = objAssembly.CreateInstance("Dynamicly.HelloWorld");

            if (objClass == null)
            {
                this.txtResult.Text = "Error: " + "Couldn't load class.";
                return;
            }

            object[] objCodeParms = new object[1];
            objCodeParms[0] = "Allan.";

            string strResult = (string)objClass.GetType().InvokeMember(
                       "GetTime", BindingFlags.InvokeMethod, null, objClass, objCodeParms);
            this.txtResult.Text = strResult;
        }
    }
}

需要解釋的是，這裡我們在傳遞編譯引數時設定了GenerateInMemory為true,這表明生成的DLL會被載入在記憶體中（隨後被預設引用入當前應用程式域）。在呼叫GetTime方法時我們需要加入引數，傳遞object型別的陣列並通過Reflection的InvokeMember來呼叫。在建立生成的Assembly中的物件例項時，需要注意用到的名稱空間是你輸入程式碼的真實名稱空間。以下是我們輸入的測試程式碼（為了方便，所有的程式碼都在外部輸入，動態執行時不做調整）：

using System;

namespace Dynamicly
{
    public class HelloWorld
    {
        public string GetTime(string strName)
        {
            return  "Welcome " + strName + ", Check in at " + System.DateTime.Now.ToString();
        }
    }
}

執行附件中提供的程式，可以很容易得到以下結果：

改進的執行過程

現在一切看起來很好，我們可以編譯程式碼並把程式碼載入到當前應用程式域中來參與我們的活動，但你是否想過去解除安裝掉這段程式呢？更好的去控制程式呢？另外，當你執行這個程式很多遍的時候，你會發現佔用記憶體很大，而且每次執行都會增大記憶體使用。是否需要來解決這個問題呢？當然需要，否則你會發現這個東西根本沒用，我需要執行的一些大的應用會讓我的伺服器crzay，不堪重負而瘋掉的。
要解決這個問題我們需要來了解一下應用程式域。.NET Application Domain是.NET提供的執行和承載一個活動的程序（Process）的容器，它將這個程序執行所需的程式碼和資料，隔離到一個小的範圍內，稱為Application Domain。當一個應用程式執行時，Application Domains將所有的程式集/元件集載入到當前的應用程式域中，並根據需要來呼叫。而對於動態生成的程式碼/程式集，我們看起來好像並沒有辦法去管理它。其實不然，我們可以用Application Domain提供的管理程式集的辦法來動態載入和移除Assemblies來達到我們的提高效能的目的。具體怎麼做呢，在前邊的基礎上增加以下步驟：
建立另外一個Application Domain
動態建立（編譯）程式碼並儲存到磁碟
建立一個公共的遠端呼叫介面
建立遠端呼叫介面的例項。並通過這個介面來訪問其方法。
換句話來講就是將物件載入到另外一個AppDomain中並通過遠端呼叫的方法來呼叫。所謂遠端呼叫其實也就是跨應用程式域呼叫，所以這個物件（動態程式碼）必須繼承於MarshalByRefObject類。為了複用，這個介面被單獨提到一個工程中，並提供一個工廠來簡化每次的呼叫操作：

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

namespace RemoteAccess
{
    /// <summary>
    /// Interface that can be run over the remote AppDomain boundary.
    /// </summary>
    public interface IRemoteInterface
    {
        object Invoke(string lcMethod, object[] Parameters);
    }

    /// <summary>
    /// Factory class to create objects exposing IRemoteInterface
    /// </summary>
    public class RemoteLoaderFactory : MarshalByRefObject
    {
        private const BindingFlags bfi = BindingFlags.Instance | BindingFlags.Public | BindingFlags.CreateInstance;
        public RemoteLoaderFactory() { }
        public IRemoteInterface Create(string assemblyFile, string typeName, object[] constructArgs)
        {
            return (IRemoteInterface)Activator.CreateInstanceFrom(
                     assemblyFile, typeName, false, bfi, null, constructArgs,
                     null, null, null).Unwrap();
        }
    }
}

接下來在原來基礎上需要修改的是：
將編譯成的DLL儲存到磁碟中。
建立另外的AppDomain。
獲得IRemoteInterface介面的引用。（將生成的DLL載入到額外的AppDomain）
呼叫InvokeMethod方法來遠端呼叫。
可以通過AppDomain.Unload()方法解除安裝程式集。
以下是完整的程式碼，演示瞭如何應用這一方案。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Microsoft.CSharp;
using System.CodeDom.Compiler;
using System.Reflection;
using RemoteAccess;

namespace DynamicCompileAppDomain
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void button1_Click(object sender, EventArgs e)
        {
            // get the code to compile
            string strSourceCode = this.txtSource.Text;

            // 0. Create an addtional AppDomain
            AppDomainSetup objSetup = new AppDomainSetup();
            objSetup.ApplicationBase = AppDomain.CurrentDomain.BaseDirectory;
            AppDomain objAppDomain = AppDomain.CreateDomain("MyAppDomain", null, objSetup);

            // 1.Create a new CSharpCodePrivoder instance
            CSharpCodeProvider objCSharpCodePrivoder = new CSharpCodeProvider();

            // 2.Sets the runtime compiling parameters by crating a new CompilerParameters instance
            CompilerParameters objCompilerParameters = new CompilerParameters();
            objCompilerParameters.ReferencedAssemblies.Add("System.dll");
            objCompilerParameters.ReferencedAssemblies.Add("System.Windows.Forms.dll");

            // Load the remote loader interface
            objCompilerParameters.ReferencedAssemblies.Add("RemoteAccess.dll");

            // Load the resulting assembly into memory
            objCompilerParameters.GenerateInMemory = false;
            objCompilerParameters.OutputAssembly = "DynamicalCode.dll";

            // 3.CompilerResults: Complile the code snippet by calling a method from the provider
            CompilerResults cr = objCSharpCodePrivoder.CompileAssemblyFromSource(objCompilerParameters, strSourceCode);

            if (cr.Errors.HasErrors)
            {
                string strErrorMsg = cr.Errors.Count.ToString() + " Errors:";

                for (int x = 0; x < cr.Errors.Count; x++)
                {
                    strErrorMsg = strErrorMsg + "/r/nLine: " +
                                 cr.Errors[x].Line.ToString() + " - " +
                                 cr.Errors[x].ErrorText;
                }

                this.txtResult.Text = strErrorMsg;
                MessageBox.Show("There were build erros, please modify your code.", "Compiling Error");
                return;
            }

            // 4. Invoke the method by using Reflection
            RemoteLoaderFactory factory = (RemoteLoaderFactory)objAppDomain.CreateInstance("RemoteAccess", "RemoteAccess.RemoteLoaderFactory").Unwrap();

            // with help of factory, create a real 'LiveClass' instance
            object objObject = factory.Create("DynamicalCode.dll", "Dynamicly.HelloWorld", null);

            if (objObject == null)
            {
                this.txtResult.Text = "Error: " + "Couldn't load class.";
                return;
            }

            // *** Cast object to remote interface, avoid loading type info
            IRemoteInterface objRemote = (IRemoteInterface)objObject;

            object[] objCodeParms = new object[1];
            objCodeParms[0] = "Allan.";
            string strResult = (string)objRemote.Invoke("GetTime", objCodeParms);
            this.txtResult.Text = strResult;

            //Dispose the objects and unload the generated DLLs.
            objRemote = null;
            AppDomain.Unload(objAppDomain);
            System.IO.File.Delete("DynamicalCode.dll");
        }
    }
}

對於客戶端的輸入程式，我們需要繼承於MarshalByRefObject類和IRemoteInterface介面，並新增對RemoteAccess程式集的引用。以下為輸入：

using System;
using System.Reflection;
using RemoteAccess;

namespace Dynamicly
{
    public class HelloWorld : MarshalByRefObject,IRemoteInterface
    {
        public object Invoke(string strMethod,object[] Parameters)
        {
            return this.GetType().InvokeMember(strMethod, BindingFlags.InvokeMethod,null,this,Parameters);
        }

        public string GetTime(string strName)
        {
            return  "Welcome " + strName + ", Check in at " + System.DateTime.Now.ToString();
        }
    }
}

這樣，你可以通過適時的編譯，載入和解除安裝程式集來保證你的程式始終處於一個可控消耗的過程，並且達到了動態編譯的目的，而且因為在不同的應用程式域中，讓你的本身的程式更加安全和健壯。

最後附上示例程式原始碼：

示例程式共有4個專案：

DynamicCompileBase是本文無應用程式域動態編譯的例子（無法釋放記憶體）

RemoteAccess是遠端呼叫應用程式域的庫

DynamicCompileAppDomain是遠端呼叫應用程式域動態編譯的示例程式（能夠將C#程式碼編譯為臨時DLL，動態載入並執行，然後釋放，最後刪除臨時DLL）

讓C#語言充當自身指令碼！——.NET中的動態編譯

讓C#語言充當自身指令碼！——.NET中的動態編譯

讓C#語言充當自身腳本！——.NET中的動態編譯

學習C語言的第二天！

今天給大家分享一篇關於幾個C語言幾個難題！

在VS中如何讓C#語言編寫的程式自動以管理員身份執行

如何學習c語言，零基礎C語言的學習方法！

使用tolua++建立基於C\C++語言的lua指令碼

如何讓C語言函式返回一個二維陣列

[C語言]大放送！C語言操作符大總結

個人學習c語言的一些經驗！

用C語言輸出自身的程式原始碼（Quine）

【VS2013】C語言呼叫Python指令碼環境搭建、函式呼叫和呼叫demo.py指令碼an

c語言編寫螺旋矩陣！

C語言二分法查找數列中指定數字

梓益C語言學習筆記之鏈表＆動態內存＆文件

C語言 Struct 結構體在 Java 中的體現

一個博客萌新的C語言之旅（持續更新中....）

一個部落格萌新的C語言之旅（持續更新中....）

C語言：求10 個整數中最大值

C語言異或運算在程式設計中的妙用

讓C#語言充當自身指令碼！——.NET中的動態編譯

相關推薦