使用 Roslyn 編譯器服務

.NET Core和 .NET 4.6中 的C# 6/7 中的編譯器Roslyn 一個重要的特性就是"Compiler as a Service"，簡單的講，就是就是將編譯器開放為一種可在代碼中調用的服務， 通常在工作流引擎 或是規則引擎中都需要一項功能是計算表達式， 在沒有Roslyn 之前我通常借助於Antlr [Antlr（“又一個語言識別工具”的縮寫）是一個最初用Java編寫的庫，可以根據特殊的語法（文法）來構建復雜的解析器代碼。它就像是一個用於語言解析的加強版的正則表達式。你可以編寫某種語言的語法規則，Antlr會為你生成代碼]，基於Antlr 有一個輕量級的C#編譯器服務Expression Evaluator 。

要在自己的代碼中使用Roslyn 執行C#腳本，首先進行如下幾步准備工作。

1、通過Nuget 安裝Microsoft.CodeAnalysis.CSharp.Scripting

2、在代碼中增加如下命名空間的引用。

using Microsoft.CodeAnalysis.CSharp.Scripting;
using Microsoft.CodeAnalysis.Scripting;

經典的HelloWorld

首先還是以經典的Hello World來開始介紹如何執行腳本吧。

static void Main(string[] args)
    {
           var options =
               ScriptOptions.Default
              .AddReferences("System.Runtime, Version=4.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");

           var bar = new Bar() { StaffId = 5686, UnitId = 2 , Age = 15};
           Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync("System.Console.WriteLine(\"hello world\");", options);

    }

從上述代碼中可以看出，執行一個腳本還是比較簡單的, 可以通過Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync() 函數執行自己的腳本了,如果我們要獲取腳本的返回值，也是很容易的。

var scriptState = CSharpScript.RunAsync<int>("3+2*5", ScriptOptions.Default);

Console.WriteLine(scriptState );

在會話中執行腳本

很多時候，我們無法一次執行所有的腳本，而是像shell中那樣輸入一句執行一句的。假如我們執行如下代碼

Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync("var i = 3;");
var result = Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync("i * 2");

得到的並不是我們想要的結果6，而是一個異常：

究其原因，是因為CSharpScript.RunAsync 函數每次都是在一個單獨的上下文中執行的，並不會和前面的語句產生關聯。如果我們要在CSharpScript.Create()函數創建一個腳本，通過函數ContinueWith 組成一個完整的腳本運行。正確方式如下：

var s0 = CSharpScript.Create("int x = 1;");
           var s1 = s0.ContinueWith("int y = 2;");           
           var s2 = s1.ContinueWith<int>("x + y");
           Console.WriteLine(s2.RunAsync().Result.ReturnValue);

在腳本和程序中共享數據

我們在執行腳本時，除了獲取腳本的輸出外，許多時候需要設置腳本的輸入，要設置輸入的方式也有許多。最直接的方式拼接腳本但這么做的效率和可維護性是十分差的。另外也可以通過傳統的IPC通信機制——文件、Socket等方式，這種方式一來比較麻煩，二來對於復雜的對象來說，還牽涉到序列化，也是非常不便。

Roslyn提供了一個更為簡單有效的解決辦法：在會話中傳入一個宿主對象，會話中的腳本程序也能訪問宿主對象的各成員變量。

namespace RoslynCosonle
{
    class Program
    {
        static void Main(string[] args)
        {
            var options =
                ScriptOptions.Default
               .AddReferences("System.Runtime, Version=4.1.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a");         

            var s0 = CSharpScript.Create("int x = 1;");
            var s1 = s0.ContinueWith("int y = 2;");           
            var s2 = s1.ContinueWith<int>("x + y");
            Console.WriteLine(s2.RunAsync().Result.ReturnValue);

          

           var bar = new Bar() { StaffId = 5686, UnitId = 2 , Age = 15};
            Microsoft.CodeAnalysis.CSharp.Scripting.CSharpScript.RunAsync("System.Console.WriteLine( (StaffId==5686 && UnitId==2)||( UnitId == 3|| Age >10) );", options, bar);

 
        }
    }

    public class Bar
    {
        public string Foo => "Hello World!";
       
        public int StaffId { get; set; }

        public int UnitId { get; set; }

        public int Age { get; set; }
    }

通過對象Bar 把握的輸入傳給表達式，然后表達式就可以計算結果，這個就是我們在工作流引擎里面要的表達式計算了。