使用Roslyn腳本化C#代碼，C#動態腳本實現方案

時間 2019-11-30

標籤使用 roslyn 腳本 c# 代碼動態實現方案欄目 C# 简体版

原文原文鏈接

【前言】

　　Roslyn 是微軟公司開源的 .NET 編譯器。javascript

　　編譯器支持 C# 和 Visual Basic 代碼編譯，並提供豐富的代碼分析 API。html

　　Roslyn不單單能夠直接編譯輸出，難能難得的就是上述描述中的開放了編譯的API，使得代碼腳本化成爲了可能。java

　　關於Roslyn，本文不作過多介紹，由於再介紹的豐滿終究不及官方文檔介紹的細膩，各位請移步官方說明地址：https://github.com/dotnet/roslyn/wikigit

　　衆所周知，咱們實現的Filter每每是寫死的代碼在項目裏面的，一經發布，便不能隨時改動，有過Paas平臺開發經驗的同僚更能體會到租戶靈活配置個性化需求是一個難點。github

　　那麼，咱們怎麼能針對不一樣的業務邏輯靈活地在已經部署好地站點上制定不一樣地業務邏輯呢，讓咱們一塊兒走進這個世界。mvc

　　本文將經過一個小Demo的實現講述如何使用Roslyn腳本化代碼，以及如何採用腳本化的代碼對一個網站接口實現腳本控制Before和After過濾器的功效。工具

　　Demo 源碼地址：https://github.com/sevenTiny/Demo.CSharpScript單元測試

1、熟悉Roslyn API

首先項目中引入微軟腳本API相關的Nuget包

　　按順序引入下面三個Nuget包測試

　　Microsoft.CodeAnalysis.CSharp 　　網站

　　Microsoft.CodeAnalysis.Scripting　

　　Microsoft.CodeAnalysis.CSharp.Scripting

瞭解API

　　1.咱們寫一個Run腳本的Demo：

[Fact]
[Trait("desc", "調用動態建立的腳本方法")]
public void CallScriptFromText()
{
    string code1 = @"
    public class ScriptedClass
    {
        public string HelloWorld { get; set; }
        public ScriptedClass()
        {
            HelloWorld = ""Hello Roslyn!"";
        }
    }";

    var script = CSharpScript.RunAsync(code1).Result;

    var result = script.ContinueWithAsync<string>("new ScriptedClass().HelloWorld").Result;

    Assert.Equal("Hello Roslyn!", result.ReturnValue);
}

　　Demo中，咱們用字符串定義了一個類，並在其中寫了小段邏輯，經過Run方法和ContinueWityAsync方法分別執行了兩段腳本，最終的結果輸出了：

　"Hello Roslyn!"

　　2.咱們再寫一個腳本調用已存在的類的Demo：

　　首先咱們定義一個類型：

public class TestClass
{
    public string arg1 { get; set; }

    public string GetString()
    {
        return "hello world！";
    }

    public string DealString(string a)
    {
        return a;
    }
}

　　而後寫腳本執行該類型裏面的DealString方法（帶參數和返回值的）

[Trait("desc", "使用類的實例調用類的帶參數的方法，並獲取返回值")]
[Theory]
[InlineData("123")]
public void CallScriptFromAssemblyWithArgument(string x)
{
    var script = CSharpScript.Create<string>("return new TestClass().DealString(arg1);",
        ScriptOptions.Default
        .WithReferences(typeof(TestClass).Assembly)
        .WithImports("Test.Standard.DynamicScript"), globalsType: typeof(TestClass));

    script.Compile();

    var result = script.RunAsync(new TestClass { arg1 = x }).Result.ReturnValue;

    Assert.Equal(x, result.ToString());
}

　　RunAsync 方法傳遞參數，參數名必需要和參數類型的字段名稱一直才能夠識別

　　ScriptOptions.Default.WithReferences 明確程序集要引用的類型，相似於引用一個dll

　　ScriptOptions.Default.WithImports 明確代碼中引用的類型，相似於using

　　globalsType: typeof(TestClass) 指定了傳遞參數須要用到的類型（API不支持隱式的參數，只能定義一個明確類型傳遞參數）

　　script.Compile(); 方法將腳本編譯並保存到內存中，待調用

　　script.RunAsync(new TestClass { arg1 = x }).Result.ReturnValue 調用腳本並傳遞參數獲取返回值，x=「123」，單元測試傳遞的參數

　　而後咱們便獲得了「123」的返回值

更多API

　　更多的API咱們能夠從官方介紹文檔中輕鬆獲得

　　官方WIKI：https://github.com/dotnet/roslyn/wiki/Scripting-API-Samples

2、一個MVC Action Before/After Filter（Action執行先後過濾器）的Demo

　　首先說明項目背景及功能

運行.netcore mvc站點，點擊菜單欄的進入Demo便獲得下面界面
咱們定義了一個Action，按序號建立了100條記錄用於數據演示
before 腳本的name參數是從url獲取到的name參數，返回結果將做爲100條Demo數據的「Name」字段Contains方法的參數至關於Linq .Where(t=>t.Name.Contains(name));
after 腳本是將 Where 語句過濾後的結果集做爲參數，而後執行完腳本中的代碼後，返回結果展現在了下面的頁面上
能夠簡單理解爲before是校驗url參數的，after是二次處理結果數據的
爲了方便測試，咱們的腳本都是從本地文件讀寫的

　　Demo的管道形式的數據流以下：

　　Demo界面：

　　咱們從代碼中能夠看到上述描述的數據流程：

　　ss是執行文件保存的Before腳本後的結果

　　而後咱們把他看成校驗Name的參數

　　result是data數據執行After腳本以後的結果，而後咱們將最終的結果返回到界面

　　測試Demo的提供：

using System.Collections.Generic;

namespace Demo.CSharpScript.Models
{
    /// <summary>
    /// 測試實體
    /// </summary>
    public class DemoModel
    {
        public int ID { get; set; }
        public int Age { get; set; }
        public string Name { get; set; }
        public string Desc { get; set; }

        /// <summary>
        /// 測試數據
        /// </summary>
        /// <returns></returns>
        public static List<DemoModel> GetDemoDatas()
        {
            var list = new List<DemoModel>();
            for (int i = 0; i < 100; i++)
            {
                list.Add(new DemoModel { ID = i, Age = i, Name = $"7tiny_{i}", Desc = $"第{i}條測試數據" });
            }
            return list;
        }
    }
}