基于.net standard 的動(dòng)態(tài)編譯實(shí)現(xiàn)代碼

更新時(shí)間：2018年07月19日 17:03:36 作者：Tourist

這篇文章主要介紹了基于.net standard 的動(dòng)態(tài)編譯實(shí)現(xiàn)代碼,非常不錯(cuò)，具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

在上篇文章[基于.net core 微服務(wù)的另類實(shí)現(xiàn)]結(jié)尾處，提到了如何方便自動(dòng)的生成微服務(wù)的客戶端代理，使對于調(diào)用方透明，同時(shí)將枯燥的東西使用框架集成，以提高使用便捷性。在嘗試了基于 Emit 中間語言后，最終決定使用生成代碼片段然后動(dòng)態(tài)編譯的模式實(shí)現(xiàn)。

1.背景:

其一在前文中，我們通過框架實(shí)現(xiàn)了微服務(wù)面向使用者的透明調(diào)用，但是需要為每個(gè)服務(wù)寫一個(gè)客戶端代理，顯得異常繁瑣，其二項(xiàng)目中前端站點(diǎn)使用了傳統(tǒng)的.Net Framework 框架，后端微服務(wù)我們使用了.Net Core 框架改造，短時(shí)間將前端站點(diǎn)調(diào)整成 .Net Core 框架亦不現(xiàn)實(shí)，為了能同時(shí)支持這兩種框架。如何 .Net Standard 框架來自動(dòng)創(chuàng)建微服務(wù)的客戶端代理成為我們必須解決的問題。

2.問題轉(zhuǎn)化

我們在回頭簡單看一下我們現(xiàn)在期望的微服務(wù)客戶端代理長的樣子：

通過上面分析，我們只需要將服務(wù)接口中的每個(gè)方法，判斷是否有返回值，如果有返回值調(diào)用Invoke<ReturnType>方法，沒有返回值調(diào)用InvokeWithoutReturn方法，然后依次將接口名，方法名以及方法的參數(shù)按順序傳入即可。各位如果是熟悉Java的同學(xué)，這個(gè)問題很容易解決，使用動(dòng)態(tài)代理創(chuàng)建一個(gè)這樣的匿名類即可，但在.net 的世界里，動(dòng)態(tài)代理的實(shí)現(xiàn)確顯得異常麻煩。
首先想到是通過中間語言 IL 的 Emit 實(shí)現(xiàn)，但無奈這個(gè)使用起來實(shí)在是太不友好了，幾經(jīng)折騰最終還是選擇放棄了，后又想到其實(shí)可以通過動(dòng)態(tài)生成這個(gè)代碼片段，動(dòng)態(tài)編譯后加載到系統(tǒng)程序集中，應(yīng)該就可以了。于是在這個(gè)方向的指引下，我們嘗試著去一步步實(shí)現(xiàn)這個(gè)問題。

3.解決方案

如何生成這個(gè)代碼片段？通過上面的分析，我們知道只需要將接口反射獲取其中的公共方法，并將接口的每個(gè)方法簽名原樣復(fù)制，在根據(jù)接口方法是否有返回值分別調(diào)用RemoteServiceProxy基類中相關(guān)方法即可，不過需要特殊注意的泛型方法翻譯，以下是生成這個(gè)代碼片段的參考實(shí)現(xiàn).

尋找出為服務(wù)接口程序集文件，并處理每個(gè)文件

private static StringBuilder CreateApiProxyCode()
{
 var path = GetBinPath();
 var dir = new DirectoryInfo(path);
 //獲取項(xiàng)目中微服務(wù)接口文件
 var files = dir.GetFiles("XZL*.Api.dll");
 var codeStringBuilder = new StringBuilder(1024);
 //添加必要的using
 codeStringBuilder
 .AppendLine("using System;")
 .AppendLine("using System.Collections.Generic;")
 .AppendLine("using System.Text;")
 .AppendLine("using XZL.Infrastructure.ApiService;")
 .AppendLine("using XZL.Infrastructure.Defines;")
 .AppendLine("using XZL.Model;")
 .AppendLine("namespace XZL.ApiClientProxy")
 .AppendLine("{"); //namespace begin
 //處理每個(gè)文件中的接口信息
 foreach (var file in files)
 {
 CreateApiProxyCodeFromFile(codeStringBuilder, file);
 }
 codeStringBuilder.AppendLine("}"); //namespace end
 return codeStringBuilder;
}

處理每個(gè)文件中的接口類型，并將每個(gè)程序集的依賴程序集找出來，方便后面動(dòng)態(tài)編譯

private static void CreateApiProxyCodeFromFile(StringBuilder fileCodeBuilder, FileInfo file)
 {
 try
 {
 Assembly apiAssembly = Assembly.Load(file.Name.Substring(0, file.Name.Length - 4));
 var types = apiAssembly
 .GetTypes()
 .Where(c => c.IsInterface && c.IsPublic)
 .ToList();
 var apiSvcType = typeof(IApiService);
 bool isNeed = false;
 foreach (Type type in types)
 {
 //找出期望的接口類型
 if (!apiSvcType.IsAssignableFrom(type))
 {
 continue;
 }
 //找出接口的所有方法
 var methods = type.GetMethods(BindingFlags.Public 
 | BindingFlags.FlattenHierarchy 
 | BindingFlags.Instance);
 if (!methods.Any())
 {
 continue;
 }
 //定義代理類名,以及實(shí)現(xiàn)接口和繼承RemoteServiceProxy
 fileCodeBuilder.AppendLine($"public class {type.FullName.Replace(".", "_")}Proxy :" +
  $"RemoteServiceProxy, {type.FullName}")
 .AppendLine("{"); //class begin
 //處理每個(gè)方法
 foreach (var mth in methods)
 {
 CreateApiProxyCodeFromMethod(fileCodeBuilder, type, mth);
 }
 fileCodeBuilder.AppendLine("}"); //class end
 isNeed = true;
 }
 if (isNeed)
 {
 var apiRefAsms = apiAssembly.GetReferencedAssemblies();
 refAssemblyList.Add(apiAssembly.GetName());
 refAssemblyList.AddRange(apiRefAsms);
 }
 }
 catch
 {
 }
 }

處理接口中的每個(gè)方法

private static void CreateApiProxyCodeFromMethod(
 StringBuilder fileCodeBuilder, 
 Type type,
 MethodInfo mth)
{
 var isMthReturn = !mth.ReturnType.Equals(typeof(void));
 fileCodeBuilder.Append("public ");
 //添加返回值
 if (isMthReturn)
 {
 fileCodeBuilder.Append(GetFriendlyTypeName(mth.ReturnType)).Append(" ");
 }
 else
 {
 fileCodeBuilder.Append(" void ");
 }
 //方法參數(shù)開始
 fileCodeBuilder.Append(mth.Name).Append("("); 
 var mthParams = mth.GetParameters();
 if (mthParams.Any())
 {
 var mthparaList = new List<string>();
 foreach (var p in mthParams)
 {
 mthparaList.Add(GetFriendlyTypeName(p.ParameterType) + " " + p.Name);
 }
 fileCodeBuilder.Append(string.Join(",", mthparaList));
 }
 //方法參數(shù)結(jié)束
 fileCodeBuilder.Append(")");
 //方法體開始
 fileCodeBuilder.AppendLine("{"); 
 if (isMthReturn)
 {
 //返回值
 fileCodeBuilder.Append("return Invoke<")
 .Append(GetFriendlyTypeName(mth.ReturnType))
 .Append(">");
 }
 else
 {
 fileCodeBuilder.Append(" InvokeWithoutReturn");
 }
 //拼接接口名及方法名
 fileCodeBuilder.Append($"(\"{type.FullName}\",\"{mth.Name}\"");
 //方法本身參數(shù)
 if (mthParams.Any())
 {
 fileCodeBuilder.Append(",").Append(string.Join(",", mthParams.Select(t => t.Name)));
 }
 fileCodeBuilder.Append(");");
 //方法體結(jié)束
 fileCodeBuilder.AppendLine("}"); 
}

獲取泛型類型字符串

private static string GetFriendlyTypeName(Type type)
{
 if (!type.IsGenericType)
 {
 return type.FullName;
 }
 string friendlyName = type.Name;
 int iBacktick = friendlyName.IndexOf('`');
 if (iBacktick > 0)
 {
 friendlyName = friendlyName.Remove(iBacktick);
 }
 friendlyName += "<";
 Type[] typeParameters = type.GetGenericArguments();
 for (int i = 0; i < typeParameters.Length; ++i)
 {
 string typeParamName = GetFriendlyTypeName(typeParameters[i]);
 friendlyName += (i == 0 ? typeParamName : "," + typeParamName);
 }
 friendlyName += ">";
 return friendlyName;
}

如何添加依賴

既然是要編譯源碼，那么源碼中的依賴必不可少，在上一步中我們已經(jīng)將每個(gè)程序集的依賴一并找出，接下來我們將這些依賴全部整理出來

//緩存程序集依賴
 var references = new List<MetadataReference>(); 
 var refAsmFiles = new List<string>();
 //系統(tǒng)依賴
 var sysRefLocation = typeof(Enumerable).GetTypeInfo().Assembly.Location;
 refAsmFiles.Add(sysRefLocation);
 //refAsmFiles原本緩存的程序集依賴
 refAsmFiles.Add(typeof(object).GetTypeInfo().Assembly.Location);
 refAsmFiles.AddRange(refAssemblyList.Select(t => Assembly.Load(t).Location).Distinct().ToList());
 //傳統(tǒng).NetFramework 需要添加mscorlib.dll
 var coreDir = Directory.GetParent(sysRefLocation);
 var mscorlibFile = coreDir.FullName + Path.DirectorySeparatorChar + "mscorlib.dll";
 if (File.Exists(mscorlibFile))
 {
 references.Add(MetadataReference.CreateFromFile(mscorlibFile));
 }
 var apiAsms = refAsmFiles.Select(t => MetadataReference.CreateFromFile(t)).ToList();
 references.AddRange(apiAsms);
 //當(dāng)前程序集依賴
 var thisAssembly = Assembly.GetEntryAssembly();
 if (thisAssembly != null)
 {
 var referencedAssemblies = thisAssembly.GetReferencedAssemblies();
 foreach (var referencedAssembly in referencedAssemblies)
 {
 var loadedAssembly = Assembly.Load(referencedAssembly);
 references.Add(MetadataReference.CreateFromFile(loadedAssembly.Location));
 }
 }

編譯

有了代碼片段, 也有了編譯程序集依賴, 接下來就是最重要的編譯了.

//定義編譯后文件名
var path = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Proxy");
if (!Directory.Exists(path))
{
 Directory.CreateDirectory(path);
}
var apiRemoteProxyDllFile = Path.Combine(path, 
 apiRemoteAsmName + DateTime.Now.ToString("yyyyMMddHHmmssfff") + ".dll");
var tree = SyntaxFactory.ParseSyntaxTree(codeBuilder.ToString());
var compilation = CSharpCompilation.Create(apiRemoteAsmName)
 .WithOptions(new CSharpCompilationOptions(OutputKind.DynamicallyLinkedLibrary))
 .AddReferences(references)
 .AddSyntaxTrees(tree);
//執(zhí)行編譯
EmitResult compilationResult = compilation.Emit(apiRemoteProxyDllFile);
if (compilationResult.Success)
{
 // Load the assembly
 apiRemoteAsm = Assembly.LoadFrom(apiRemoteProxyDllFile);
}
else
{
 foreach (Diagnostic codeIssue in compilationResult.Diagnostics)
 {
 string issue = $"ID: {codeIssue.Id}, Message: {codeIssue.GetMessage()}," +
 $" Location: { codeIssue.Location.GetLineSpan()}, " +
 $"Severity: { codeIssue.Severity}";
 AppRuntimes.Instance.Loger.Error("自動(dòng)編譯代碼出現(xiàn)異常," + issue);
 }
}

結(jié)語

在經(jīng)過以上處理后，雖算不上完美，但順利的實(shí)現(xiàn)了我們期望的樣子，在之前的GetService中，當(dāng)發(fā)現(xiàn)屬于遠(yuǎn)程服務(wù)的時(shí)候，只需要類似如下形式返回代理對象即可。同時(shí)為增加調(diào)用更加順暢，我們將此編譯的時(shí)機(jī)定在了發(fā)生在程序啟動(dòng)的時(shí)候，ps 當(dāng)然或許還有一些其他更合適的時(shí)機(jī).

static ConcurrentDictionary<string, Object> svcInstance = new ConcurrentDictionary<string, object>();
var typeName = "XZL.ApiClientProxy." + typeof(TService).FullName.Replace(".", "_") + "Proxy";
object obj = null;
if (svcInstance.TryGetValue(typeName, out obj) && obj != null)
{
 return (TService)obj;
}
try
{
 obj = (TService)apiRemoteAsm.CreateInstance(typeName);
 svcInstance.TryAdd(typeName, obj);
}
catch
{
 throw new ICVIPException($"未找到 {typeof(TService).FullName} 的有效代理");
}
return (TService)obj;

總結(jié)

以上所述是小編給大家介紹的基于.net standard 的動(dòng)態(tài)編譯實(shí)現(xiàn)代碼，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對腳本之家網(wǎng)站的支持！

您可能感興趣的文章: