日韩无码专区无码一级三级片|91人人爱网站中日韩无码电影|厨房大战丰满熟妇|AV高清无码在线免费观看|另类AV日韩少妇熟女|中文日本大黄一级黄色片|色情在线视频免费|亚洲成人特黄a片|黄片wwwav色图欧美|欧亚乱色一区二区三区

RELATEED CONSULTING
相關(guān)咨詢
選擇下列產(chǎn)品馬上在線溝通
服務(wù)時間:8:30-17:00
你可能遇到了下面的問題
關(guān)閉右側(cè)工具欄

新聞中心

這里有您想知道的互聯(lián)網(wǎng)營銷解決方案
C# 9 新特性:代碼生成器、編譯時反射

前言

今天 .NET 官方博客宣布 C# 9 Source Generators 第一個預(yù)覽版發(fā)布,這是一個用戶已經(jīng)喊了快 5 年特性,今天終于發(fā)布了。

10年積累的網(wǎng)站設(shè)計、做網(wǎng)站經(jīng)驗,可以快速應(yīng)對客戶對網(wǎng)站的新想法和需求。提供各種問題對應(yīng)的解決方案。讓選擇我們的客戶得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識你,你也不認(rèn)識我。但先網(wǎng)站策劃后付款的網(wǎng)站建設(shè)流程,更有滎陽免費網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。

簡介

Source Generators 顧名思義代碼生成器,它允許開發(fā)者在代碼編譯過程中獲取查看用戶代碼并且生成新的 C# 代碼參與編譯過程,并且可以很好的與代碼分析器集成提供 Intellisense、調(diào)試信息和報錯信息,可以用它來做代碼生成,因此也相當(dāng)于是一個加強版本的編譯時反射。

使用 Source Generators,可以做到這些事情:

  • 獲取一個 Compilation 對象,這個對象表示了所有正在編譯的用戶代碼,你可以從中獲取 AST 和語義模型等信息
  • 可以向 Compilation 對象中插入新的代碼,讓編譯器連同已有的用戶代碼一起編譯

Source Generators 作為編譯過程中的一個階段執(zhí)行:

編譯運行 -> [分析源代碼 -> 生成新代碼] -> 將生成的新代碼添加入編譯過程 -> 編譯繼續(xù)。

上述流程中,中括號包括的內(nèi)容即為 Source Generators 所參與的階段和能做到的事情。

作用

.NET 明明具備運行時反射和動態(tài) IL 織入功能,那這個 Source Generators 有什么用呢?

編譯時反射 - 0 運行時開銷

拿 ASP.NET Core 舉例,啟動一個 ASP.NET Core 應(yīng)用時,首先會通過運行時反射來發(fā)現(xiàn) Controllers、Services 等的類型定義,然后在請求管道中需要通過運行時反射獲取其構(gòu)造函數(shù)信息以便于進(jìn)行依賴注入。然而運行時反射開銷很大,即使緩存了類型簽名,對于剛剛啟動后的應(yīng)用也無任何幫助作用,而且不利于做 AOT 編譯。

Source Generators 將可以讓 ASP.NET Core 所有的類型發(fā)現(xiàn)、依賴注入等在編譯時就全部完成并編譯到最終的程序集當(dāng)中,最終做到 0 運行時反射使用,不僅利于 AOT 編譯,而且運行時 0 開銷。

除了上述作用之外,gRPC 等也可以利用此功能在編譯時織入代碼參與編譯,不需要再利用任何的 MSBuild Task 做代碼生成啦!

另外,甚至還可以讀取 XML、JSON 直接生成 C# 代碼參與編譯,DTO 編寫全自動化都是沒問題的。

AOT 編譯

Source Generators 的另一個作用是可以幫助消除 AOT 編譯優(yōu)化的主要障礙。

許多框架和庫都大量使用反射,例如System.Text.Json、System.Text.RegularExpressions、ASP.NET Core 和 WPF 等等,它們在運行時從用戶代碼中發(fā)現(xiàn)類型。這些非常不利于 AOT 編譯優(yōu)化,因為為了使反射能夠正常工作,必須將大量額外甚至可能不需要的類型元數(shù)據(jù)編譯到最終的原生映像當(dāng)中。

有了 Source Generators 之后,只需要做編譯時代碼生成便可以避免大部分的運行時反射的使用,讓 AOT 編譯優(yōu)化工具能夠更好的運行。

例子

INotifyPropertyChanged

寫過 WPF 或 UWP 的都知道,在 ViewModel 中為了使屬性變更可被發(fā)現(xiàn),需要實現(xiàn) INotifyPropertyChanged 接口,并且在每一個需要的屬性的 setter 處除法屬性更改事件:

 
 
 
  1. class MyViewModel : INotifyPropertyChanged 
  2. public event PropertyChangedEventHandler? PropertyChanged; 
  3.  
  4. private string _text; 
  5. public string Text 
  6. get => _text; 
  7. set 
  8. _text = value; 
  9. PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(Text))); 

當(dāng)屬性多了之后將會非常繁瑣,先前 C# 引入了 CallerMemberName 用于簡化屬性較多時候的情況:

 
 
 
  1. class MyViewModel : INotifyPropertyChanged 
  2. public event PropertyChangedEventHandler? PropertyChanged; 
  3.  
  4. private string _text; 
  5. public string Text 
  6. get => _text; 
  7. set 
  8. _text = value; 
  9. OnPropertyChanged(); 
  10.  
  11. protected virtual void OnPropertyChanged([CallerMemberName] string? propertyName = null) 
  12. PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName)); 

即,用 CallerMemberName 指示參數(shù),在編譯時自動填充調(diào)用方的成員名稱。

但是還是不方便。

如今有了 Source Generators,我們可以在編譯時生成代碼做到這一點了。

為了實現(xiàn) Source Generators,我們需要寫個實現(xiàn)了 ISourceGenerator 并且標(biāo)注了 Generator的類型。

完整的 Source Generators 代碼如下:

 
 
 
  1. using System; 
  2. using System.Collections.Generic; 
  3. using System.Linq; 
  4. using System.Text; 
  5. using Microsoft.CodeAnalysis; 
  6. using Microsoft.CodeAnalysis.CSharp; 
  7. using Microsoft.CodeAnalysis.CSharp.Syntax; 
  8. using Microsoft.CodeAnalysis.Text; 
  9.  
  10. namespace MySourceGenerator 
  11. [Generator] 
  12. public class AutoNotifyGenerator : ISourceGenerator 
  13. private const string attributeText = @" 
  14. using System; 
  15. namespace AutoNotify 
  16. [AttributeUsage(AttributeTargets.Field, Inherited = false, AllowMultiple = false)] 
  17. sealed class AutoNotifyAttribute : Attribute 
  18. public AutoNotifyAttribute() 
  19. public string PropertyName { get; set; } 
  20. "; 
  21.  
  22. public void Initialize(InitializationContext context) 
  23. // 注冊一個語法接收器,會在每次生成時被創(chuàng)建 
  24. context.RegisterForSyntaxNotifications(() => new SyntaxReceiver()); 
  25.  
  26. public void Execute(SourceGeneratorContext context) 
  27. // 添加 Attrbite 文本 
  28. context.AddSource("AutoNotifyAttribute", SourceText.From(attributeText, Encoding.UTF8)); 
  29.  
  30. // 獲取先前的語法接收器  
  31. if (!(context.SyntaxReceiver is SyntaxReceiver receiver)) 
  32. return; 
  33.  
  34. // 創(chuàng)建處目標(biāo)名稱的屬性 
  35. CSharpParseOptions options = (context.Compilation as CSharpCompilation).SyntaxTrees[0].Options as CSharpParseOptions; 
  36. Compilation compilation = context.Compilation.AddSyntaxTrees(CSharpSyntaxTree.ParseText(SourceText.From(attributeText, Encoding.UTF8), options)); 
  37.  
  38. // 獲取新綁定的 Attribute,并獲取INotifyPropertyChanged 
  39. INamedTypeSymbol attributeSymbol = compilation.GetTypeByMetadataName("AutoNotify.AutoNotifyAttribute"); 
  40. INamedTypeSymbol notifySymbol = compilation.GetTypeByMetadataName("System.ComponentModel.INotifyPropertyChanged"); 
  41.  
  42. // 遍歷字段,只保留有 AutoNotify 標(biāo)注的字段 
  43. List fieldSymbols = new List(); 
  44. foreach (FieldDeclarationSyntax field in receiver.CandidateFields) 
  45. SemanticModel model = compilation.GetSemanticModel(field.SyntaxTree); 
  46. foreach (VariableDeclaratorSyntax variable in field.Declaration.Variables) 
  47. // 獲取字段符號信息,如果有 AutoNotify 標(biāo)注則保存 
  48. IFieldSymbol fieldSymbol = model.GetDeclaredSymbol(variable) as IFieldSymbol; 
  49. if (fieldSymbol.GetAttributes().Any(ad => ad.AttributeClass.Equals(attributeSymbol, SymbolEqualityComparer.Default))) 
  50. fieldSymbols.Add(fieldSymbol); 
  51.  
  52. // 按 class 對字段進(jìn)行分組,并生成代碼 
  53. foreach (IGrouping group in fieldSymbols.GroupBy(f => f.ContainingType)) 
  54. string classSource = ProcessClass(group.Key, group.ToList(), attributeSymbol, notifySymbol, context); 
  55. context.AddSource($"{group.Key.Name}_autoNotify.cs", SourceText.From(classSource, Encoding.UTF8)); 
  56.  
  57. private string ProcessClass(INamedTypeSymbol classSymbol, List fields, ISymbol attributeSymbol, ISymbol notifySymbol, SourceGeneratorContext context) 
  58. if (!classSymbol.ContainingSymbol.Equals(classSymbol.ContainingNamespace, SymbolEqualityComparer.Default)) 
  59. // TODO: 必須在頂層,產(chǎn)生診斷信息 
  60. return null; 
  61.  
  62. string namespaceName = classSymbol.ContainingNamespace.ToDisplayString(); 
  63.  
  64. // 開始構(gòu)建要生成的代碼 
  65. StringBuilder source = new StringBuilder($@" 
  66. namespace {namespaceName} 
  67. {{ 
  68. public partial class {classSymbol.Name} : {notifySymbol.ToDisplayString()} 
  69. {{ 
  70. "); 
  71.  
  72. // 如果類型還沒有實現(xiàn) INotifyPropertyChanged 則添加實現(xiàn) 
  73. if (!classSymbol.Interfaces.Contains(notifySymbol)) 
  74. source.Append("public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;"); 
  75.  
  76. // 生成屬性 
  77. foreach (IFieldSymbol fieldSymbol in fields) 
  78. ProcessField(source, fieldSymbol, attributeSymbol); 
  79.  
  80. source.Append("} }"); 
  81. return source.ToString(); 
  82.  
  83. private void ProcessField(StringBuilder source, IFieldSymbol fieldSymbol, ISymbol attributeSymbol) 
  84. // 獲取字段名稱 
  85. string fieldName = fieldSymbol.Name; 
  86. ITypeSymbol fieldType = fieldSymbol.Type; 
  87.  
  88. // 獲取 AutoNotify Attribute 和相關(guān)的數(shù)據(jù) 
  89. AttributeData attributeData = fieldSymbol.GetAttributes().Single(ad => ad.AttributeClass.Equals(attributeSymbol, SymbolEqualityComparer.Default)); 
  90. TypedConstant overridenNameOpt = attributeData.NamedArguments.SingleOrDefault(kvp => kvp.Key == "PropertyName").Value; 
  91.  
  92. string propertyName = chooseName(fieldName, overridenNameOpt); 
  93. if (propertyName.Length == 0 || propertyName == fieldName) 
  94. //TODO: 無法處理,產(chǎn)生診斷信息 
  95. return; 
  96.  
  97. source.Append($@" 
  98. public {fieldType} {propertyName}  
  99. {{ 
  100. get  
  101. {{ 
  102. return this.{fieldName}; 
  103. }} 
  104. set 
  105. {{ 
  106. this.{fieldName} = value; 
  107. this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof({propertyName}))); 
  108. }} 
  109. }} 
  110. "); 
  111.  
  112. string chooseName(string fieldName, TypedConstant overridenNameOpt) 
  113. if (!overridenNameOpt.IsNull) 
  114. return overridenNameOpt.Value.ToString(); 
  115.  
  116. fieldName = fieldName.TrimStart('_'); 
  117. if (fieldName.Length == 0) 
  118. return string.Empty; 
  119.  
  120. if (fieldName.Length == 1) 
  121. return fieldName.ToUpper(); 
  122.  
  123. return fieldName.Substring(0, 1).ToUpper() + fieldName.Substring(1); 
  124.  
  125.  
  126. // 語法接收器,將在每次生成代碼時被按需創(chuàng)建 
  127. class SyntaxReceiver : ISyntaxReceiver 
  128. public List CandidateFields { get; } = new List(); 
  129.  
  130. // 編譯中在訪問每個語法節(jié)點時被調(diào)用,我們可以檢查節(jié)點并保存任何對生成有用的信息 
  131. public void OnVisitSyntaxNode(SyntaxNode syntaxNode) 
  132. // 將具有至少一個 Attribute 的任何字段作為候選 
  133. if (syntaxNode is FieldDeclarationSyntax fieldDeclarationSyntax 
  134. && fieldDeclarationSyntax.AttributeLists.Count > 0) 
  135. CandidateFields.Add(fieldDeclarationSyntax); 

有了上述代碼生成器之后,以后我們只需要這樣寫 ViewModel 就會自動生成通知接口的事件觸發(fā)調(diào)用:

 
 
 
  1. public partial class MyViewModel 
  2. [AutoNotify] 
  3. private string _text = "private field text"; 
  4.  
  5. [AutoNotify(PropertyName = "Count")] 
  6. private int _amount = 5; 

上述代碼將會在編譯時自動生成以下代碼參與編譯:

 
 
 
  1. public partial class MyViewModel : System.ComponentModel.INotifyPropertyChanged 
  2. public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged; 
  3.  
  4. public string Text 
  5. get  
  6. return this._text; 
  7. set 
  8. this._text = value; 
  9. this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof(Text))); 
  10.  
  11. public int Count 
  12. get  
  13. return this._amount; 
  14. set 
  15. this._amount = value; 
  16. this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof(Count))); 

非常方便!

使用時,將 Source Generators 部分作為一個獨立的 .NET Standard 2.0 程序集(暫時不支持 2.1),用以下方式引入到你的項目即可:

 
 
 
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  

注意需要 .NET 5 preview 3 或以上版本,并指定語言版本為 preview :

 
 
 
  1.  
  2. preview 
  3.  

另外,Source Generators 需要引入兩個 nuget 包:

 
 
 
  1.  
  2.  
  3.  
  4.  

限制

Source Generators 僅能用于訪問和生成代碼,但是不能修改已有代碼,這有一定原因是出于安全考量。

文檔

Source Generators 處于早期預(yù)覽階段,docs.microsoft.com 上暫時沒有相關(guān)文檔,關(guān)于它的文檔請訪問在 roslyn 倉庫中的文檔:

設(shè)計文檔

使用文檔

后記

目前 Source Generators 仍處于非常早期的預(yù)覽階段,API 后期還可能會有很大的改動,因此現(xiàn)階段不要用于生產(chǎn)。

另外,關(guān)于與 IDE 的集成、診斷信息、斷點調(diào)試信息等的開發(fā)也在進(jìn)行中,請期待后續(xù)的 preview 版本吧。


分享名稱:C# 9 新特性:代碼生成器、編譯時反射
網(wǎng)頁網(wǎng)址:http://www.5511xx.com/article/cojepog.html