讓程式碼幫我們寫程式碼（一）
Hello，大家好，又是好久不見，最近太忙了（藉口）。看了下紀錄檔，有 2 個月沒寫文章了。為了證明公眾號還活著，今天必須更新一下了。
在我們的開發過程中，總有那麼些需求是那麼的變態。常規的方案已經無法滿足。比如某些規則非常複雜，而客戶又經常要修改它。那麼我們可能需要把這部分程式碼直接做為組態檔提取出來。在每次修改後直接熱更新進我們的程式。比如我們做低程式碼工具的時候可能需要根據使用者的輸入直接動態生成某些型別。再比如我們做 BI 工具的時候可能需要根據使用者選擇的表直接動態生成 Entity 的型別。碰到類似需求的時候我們該怎麼辦？今天就來整理一下 .NET 平臺關於動態程式碼生成的一些技術方案。
ClassDescription
public class ClassDescription
{
public string ModuleName { get; set; }
public string AssemblyName { get; set; }
public string ClassName { get; set; }
public List<PropertyDescription> Properties { get; set; }
}
public class PropertyDescription
{
public string Name { get; set; }
public Type Type { get; set; }
}
在正式開始編寫動態程式碼生成的核心程式碼之前，首先我們定義一個 ClassDescription 類來幫助描述需要生成的 class 長啥樣。裡面主要是描述了一些類名，屬性名，屬性型別等資訊。
Emit
在 .NET Core 之前我們要動態生成一個 class 那麼幾乎 Emit 是首先技術。當然 Emit 在 .NET Core 中依然可以使用。System.Reflection.Emit 的名稱空間這樣的，所以很明顯還是反射技術的一種。普通的反射可能只是動態來獲取程式集裡的後設資料，然後操作或者執行它。而 Emit 可以完全動態的建立一個程式集或者類。那麼讓我們看看怎麼用 Emit 來動態生成一個 class 吧。
比如我們現在需要動態生成一個 User 類，如果正常編寫那麼大概長這樣：
public class User {
public string Name { get;set;}
public int Age {get;set;}
}
下面讓我們來用 Emit 動態建立它：
首先，用 ClassDescription 來定義 User 類，它裡面有 2 個屬性 Name，Age。
var userClassDesc = new ClassDescription()
{
AssemblyName = "X",
ModuleName = "X",
ClassName = "User",
Properties = new List<PropertyDescription> {
new PropertyDescription {
Type = typeof(string),
Name = "Name"
},
new PropertyDescription
{
Type = typeof(int),
Name = "Age"
}
}
};
接著就是正式使用 Emit 來編寫這個類了。整個過程大概可以分這麼幾步：
- 定義 assembly
- 定義 module
- 定義 class
- 定義 properties
上面的程式碼，如果看過 IL 的同學就比較熟悉了，這個程式碼基本就是在手寫 IL 了。其中要注意的是：屬性的定義要分 2 步，除了定義屬性外，還需要定義 Get Set 方法，然後跟屬性關聯起來。因為大家都知道，屬性其實只是封裝了方法而已。
public Type Generate(ClassDescription clazz)
{
MethodAttributes getSetAttr =
MethodAttributes.Public | MethodAttributes.SpecialName |
MethodAttributes.HideBySig;
// define class
var assemblyBuilder = AssemblyBuilder.DefineDynamicAssembly(new AssemblyName(clazz.AssemblyName), AssemblyBuilderAccess.Run);
var moduleBuilder = assemblyBuilder.DefineDynamicModule(clazz.ModuleName);
var typeBuilder = moduleBuilder.DefineType(clazz.ClassName, TypeAttributes.Public | TypeAttributes.Class | TypeAttributes.AutoClass | TypeAttributes.AnsiClass);
foreach (var item in clazz.Properties)
{
var propName = item.Name;
var fieldName = $"_{propName}";
var typee = item.Type;
//define field
var fieldBuilder = typeBuilder.DefineField(fieldName,
typee,
FieldAttributes.Private);
//define property
var propBuilder = typeBuilder.DefineProperty(propName, PropertyAttributes.SpecialName, typee, Type.EmptyTypes);
//define getter
var getPropMthdBldr = typeBuilder.DefineMethod($"get{fieldName}", getSetAttr, typee, Type.EmptyTypes);
var getIL = getPropMthdBldr.GetILGenerator();
getIL.Emit(OpCodes.Ldarg_0);
getIL.Emit(OpCodes.Ldfld, fieldBuilder);
getIL.Emit(OpCodes.Ret);
//define setter
var setPropMthdBldr = typeBuilder.DefineMethod($"set{fieldName}", getSetAttr, null, new Type[] { typee });
var idSetIL = setPropMthdBldr.GetILGenerator();
idSetIL.Emit(OpCodes.Ldarg_0);
idSetIL.Emit(OpCodes.Ldarg_1);
idSetIL.Emit(OpCodes.Stfld, fieldBuilder);
idSetIL.Emit(OpCodes.Ret);
// connect prop to getter setter
propBuilder.SetGetMethod(getPropMthdBldr);
propBuilder.SetSetMethod(setPropMthdBldr);
}
//create type
var type = typeBuilder.CreateType();
return type;
}
下面讓我們編寫一個單元測試來測試一下：
var userClassDesc = new ClassDescription()
{
AssemblyName = "X",
ModuleName = "X",
ClassName = "User",
Properties = new List<PropertyDescription> {
new PropertyDescription {
Type = typeof(string),
Name = "Name"
},
new PropertyDescription
{
Type = typeof(int),
Name = "Age"
}
}
};
var generator = new ClassGeneratorByEmit();
var type = generator.Generate(userClassDesc);
dynamic user = Activator.CreateInstance(type, null);
Assert.IsNotNull(user);
user.Name = "mj";
Assert.AreEqual("mj", user.Name);
user.Age = 18;
Assert.AreEqual(18, user.Age);
獲得 type 之後，我們使用反射來建立 User 的範例物件。然後通過 dynamic 來給屬性賦值跟取值，避免了繁瑣的反射程式碼。
執行上面的測試程式碼，單元測試綠色，通過了。
Roslyn
Roslyn 是微軟最新開源的程式碼分析，編譯工具。它提供了非常多的高階 API 來讓使用者在執行時分析程式碼，生成程式集、類。所以它現在是執行時程式碼生成的偏好設定。下面讓我們看看怎麼使用 Roslyn 來實現動態生成一個 User class 。
在使用 Roslyn 之前我們需要安裝一個 nuget 包：
Microsoft.CodeAnalysis.CSharp
我們平時正常編寫的程式碼，其實就是一堆字串，通過編譯器編譯後變成了 IL 程式碼。那麼使用的 Roslyn 的時候過程也是一樣的。我們首先就是要使用程式碼來生成這個 User class 的字串模板。然後把這段字串交給 Roslyn 去分析與編譯。編譯完後就可以獲得這個 class 的 Type 了。
public Type Generate(ClassDescription clazz)
{
const string clzTemp =
@"
using System;
using System.Runtime;
using System.IO;
namespace WdigetEngine
{
public class @className
{
@properties
}
}
";
const string propTemp =
@"
public @type @propName { get;set; }
";
var properties = new StringBuilder("");
foreach (var item in clazz.Properties)
{
string strProp = propTemp.Replace("@type", item.Type.Name).Replace("@propName", item.Name);
properties.AppendLine(strProp);
}
string sourceCode = clzTemp.Replace("@className", clazz.ClassName).Replace("@properties", properties.ToString());
Console.Write(sourceCode);
var syntaxTree = SyntaxFactory.ParseSyntaxTree(sourceCode);
var compilation = CSharpCompilation.Create(
syntaxTrees: new[] { syntaxTree },
assemblyName: $"{clazz.AssemblyName}.dll",
options: new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary),
references: AppDomain.CurrentDomain.GetAssemblies().Where(x=> !x.IsDynamic).Select(x => MetadataReference.CreateFromFile(x.Location))
);
Assembly compiledAssembly;
using (var stream = new MemoryStream())
{
var compileResult = compilation.Emit(stream);
if (compileResult.Success)
{
compiledAssembly = Assembly.Load(stream.GetBuffer());
}
else
{
throw new Exception("Roslyn compile err .");
}
}
var types = compiledAssembly.GetTypes();
return types.FirstOrDefault(c => c.Name == clazz.ClassName);
}
使用同樣的測試用例來測試一下 ：
var generator = new ClassGeneratorByRoslyn();
var type = generator.Generate(userClassDesc);
dynamic user = Activator.CreateInstance(type, null);
Assert.IsNotNull(user);
user.Name = "mj";
Assert.AreEqual("mj", user.Name);
user.Age = 18;
Assert.AreEqual(18, user.Age);
測試同樣通過了。
通過以上程式碼我們可以發現使用 Roslyn 來動態生成程式碼的難度其實要比 Emit 簡單不少。因為使用 Roslyn 的過程更接近於我們手寫程式碼，而 Emit 的話是手寫 IL ，顯然手寫 IL 對於一般同學來說是更困難的。
Natasha
如果還是覺得 Roslyn 操作起來麻煩，那麼還可以使用 NCC 旗下開源專案 Natasha。Natasha 做為 Roslyn 的封裝，所以放到 Roslyn 下面一起講。
什麼是 Natasha ？
Natasha 是基於 Roslyn 的 C# 動態程式集構建庫，該庫允許開發者在執行時使用 C# 程式碼構建域 / 程式集 / 類 / 結構體 / 列舉 / 介面 / 方法等，使得程式在執行的時候可以增加新的模組及功能。Natasha 整合了域管理/外掛管理，可以實現域隔離，域解除安裝，熱拔插等功能。 該庫遵循完整的編譯流程，提供完整的錯誤提示， 可自動新增參照，完善的資料結構構建模板讓開發者只專注於程式集指令碼的編寫，相容 netcoreapp3.0+, 跨平臺，統一、簡便的鏈式 API。
https://github.com/dotnetcore/Natasha
下面我們演示下使用 Natasha 來構建這個 User Class ：
首先使用 nuget 安裝 natasha 類庫：
DotNetCore.Natasha.CSharp
編寫 class 生成的程式碼：
public Type Generate()
{
NClass nClass = NClass.DefaultDomain();
nClass
.Namespace("MyNamespace")
.Public()
.Name("User")
.Property(prop => prop
.Type(typeof(string))
.Name("Name")
.Public()
)
.Property(prop => prop
.Type(typeof(int))
.Name("Age")
.Public()
);
return nClass.GetType();
}
以上就是使用 natasha 動態編譯一個型別的程式碼，程式碼量直線下降，而且支援鏈式呼叫，非常的優雅。
CodeDom
在沒有 Roslyn 之前，微軟還有一項技術 CodeDom ，同樣可以根據字串模板來執行時生成程式碼。他的使用跟 Roslyn 非常相似，同樣是在模擬手寫程式碼的過程。但是現在這項技術僅限於 .Net Framework 上使用了，微軟並沒有合併到 .NET Core 上來，github 上也有相關討論，因為已經有了 Roslyn ，微軟覺得這個技術已經沒有意義了。
不管怎麼樣這裡還是演示一下如何使用 CodeDom 來動態生成程式碼：
public Type Generate(ClassDescription clazz)
{
const string clzTemp =
@"
namespace WdigetEngine {
public class @className
{
@properties
}
}
";
const string propTemp =
@"
public @type @propName { get;set; }
";
var properties = new StringBuilder("");
foreach (var item in clazz.Properties)
{
string strProp = propTemp.Replace("@type", item.Type.Name).Replace("@propName", item.Name);
properties.AppendLine(strProp);
}
string sourceCode = clzTemp.Replace("@className", clazz.ClassName).Replace("@properties", properties.ToString());
Console.Write(sourceCode);
var codeProvider = new CSharpCodeProvider();
CompilerParameters param = new CompilerParameters(new string[] { "System.dll" });
CompilerResults result = codeProvider.CompileAssemblyFromSource(param, sourceCode);
Type t = result.CompiledAssembly.GetType(clazz.ClassName);
return t;
}
以上程式碼需要在 .NET Framework 上測試。整個過程跟 Roslyn 高度相似，不再囉嗦了。
總結
通過以上我們大概總結了 3 種方案（Emit , Roslyn （含 natasha） , CodeDom）來實現執行時程式碼生成。現在最推薦的是 Roslyn 方案。因為它的過程比較符合手寫程式碼的感覺，而且他還提供了程式碼分析功能，能返回編寫程式碼的語法錯誤等資訊，非常有助於 debug 。如果你現在有動態程式碼生成的需求，那麼 Roslyn 是你的最佳選擇。
未完待續
除了以上 3 種程式碼生成技術，其實還有一種程式碼生成技術： Source Generator 。Source Generator 在最近幾個版本的 .NET 中是一個非常重要的技術。通過它可以讓程式的效能很大的提升。下一篇我們就來說說 Source Generator 。
敬請期待。
QQ群：1022985150 VX：kklldog 一起探討學習.NET技術
作者：Agile.Zhou(kklldog)
出處：http://www.cnblogs.com/kklldog/
本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段宣告，且在文章頁面明顯位置給出原文連線，否則保留追究法律責任的權利。