C# - 获取罗列形貌 - 使用增量源生成器

前言

C# 获取罗列形貌的方法有很多, 常用的有通过 DescriptionAttribute 反射获取, 进阶的可以加上缓存机制, 减少反射的开销。本日我们还提供一种更加高效的方法,通过增量源生成器生成获取罗列形貌的代码。这是在编译层面实现的, 无需反射, 性能更高。

本文的演示代码基于 VS2022 + .NET 8.0 + .NET Standard 2.0

1. 基本反射

这种方法是最常用的方法, 但是反射开销比较大。

1. public enum Color
2. {
3.     [Description("红色")]
4.     Red,
5.     [Description("绿色")]
6.     Green,
7.     [Description("蓝色")]
8.     Blue
9. }
11. public static string GetDescription(Color color)
12. {
13.     var fieldInfo = typeof(Color).GetField(color.ToString());
14.     var descriptionAttribute = fieldInfo.GetCustomAttribute<DescriptionAttribute>();
15.     return descriptionAttribute?.Description;
16. }

复制代码

2. 反射 + 缓存

缓存机制可以减少反射的开销, 避免反射过于频繁。

1. private static readonly Dictionary<Color, string> _descriptionCache = new Dictionary<Color, string>();
3. public static string GetDescription(Color color)
4. {
5.     if (_descriptionCache.TryGetValue(color, out var description))
6.     {
7.         return description;
8.     }
10.     var fieldInfo = typeof(Color).GetField(color.ToString());
11.     var descriptionAttribute = fieldInfo.GetCustomAttribute<DescriptionAttribute>();
12.     description = descriptionAttribute?.Description;
13.     _descriptionCache.Add(color, description);
14.     return description;
15. }

复制代码

3. 反射 + 缓存 + 泛型类 (保举)

泛型可以减少代码重复。下面的代码为基本实现, 没有考虑线程安全问题。线程安全问题可以通过锁机制解决。可以使用静态构造函数初始化缓存。或者使用 ConcurrentDictionary 代替 Dictionary。或者使用 Lazy 代替缓存。

1. public class EnumDescription<T> where T : Enum
2. {
3.     private static readonly Dictionary<T, string> _descriptionCache = new Dictionary<T, string>();
5.     public static string GetDescription(T value)
6.     {
7.         if (_descriptionCache.TryGetValue(value, out var description))
8.         {
9.             return description;
10.         }
12.         var fieldInfo = typeof(T).GetField(value.ToString());
13.         var descriptionAttribute = fieldInfo.GetCustomAttribute<DescriptionAttribute>();
14.         description = descriptionAttribute?.Description;
15.         _descriptionCache.Add(value, description);
16.         return description;
17.     }
18. }

复制代码

4. 增量源生成器 (消除反射)

创建增量源生成器类库项目 (.NET Standard 2.0)

• 创建一个基于 .NET Standard 2.0 的类库项目名为: SourceGenerator
  
• 添加 NuGet 包 Microsoft.CodeAnalysis.CSharp 版本 4.8.0
  

1. <Project Sdk="Microsoft.NET.Sdk">
2.         <PropertyGroup>
3.                 <TargetFramework>netstandard2.0</TargetFramework>
4.                 <LangVersion>latest</LangVersion>
5.                 <EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
6.         </PropertyGroup>
8.         <ItemGroup>
9.                 <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />
10.         </ItemGroup>
11. </Project>

复制代码

• 添加 EnumDescriptionGenerator 类, 实现 IIncrementalGenerator 接口
  

1. using System.Linq;
2. using System.Text;
3. using Microsoft.CodeAnalysis;
4. using Microsoft.CodeAnalysis.CSharp.Syntax;
5. using Microsoft.CodeAnalysis.Text;
8. [Generator]
9. public class EnumDescriptionGenerator : IIncrementalGenerator
10. {
11.     public void Initialize(IncrementalGeneratorInitializationContext context)
12.     {
13.         var enumDeclarations = context.SyntaxProvider
14.            .CreateSyntaxProvider(
15.                 predicate: (syntaxNode, _) => syntaxNode is EnumDeclarationSyntax,
16.                 transform: (generatorSyntaxContext, _) =>
17.                 {
18.                     var enumDeclaration = (EnumDeclarationSyntax)generatorSyntaxContext.Node;
19.                     var enumSymbol = generatorSyntaxContext.SemanticModel.GetDeclaredSymbol(enumDeclaration) as INamedTypeSymbol;
20.                     return new { EnumDeclaration = enumDeclaration, EnumSymbol = enumSymbol };
21.                 })
22.            .Where(t => t.EnumSymbol != null)
23.            .Collect();
25.         var compilationAndEnums = context.CompilationProvider.Combine(enumDeclarations);
27.         context.RegisterSourceOutput(compilationAndEnums, (sourceProductionContext, tuple) =>
28.         {
29.             var compilation = tuple.Left;
30.             var enums = tuple.Right;
32.             foreach (var item in enums)
33.             {
34.                 var enumDeclaration = item.EnumDeclaration;
35.                 var enumSymbol = item.EnumSymbol;
37.                 if (!enumSymbol.GetMembers("GetDescription").Any())
38.                 {
39.                     var source = GenerateSourceCode(enumSymbol);
40.                     sourceProductionContext.AddSource($"{enumSymbol.Name}Descriptions.g.cs", SourceText.From(source, Encoding.UTF8));
41.                 }
42.             }
44.         });
45.     }
48.     // 生成枚举描述扩展方法的代码
49.     private static string GenerateSourceCode(INamedTypeSymbol enumSymbol)
50.     {
51.         var enumName = enumSymbol.Name;
52.         var namespaceName = enumSymbol.ContainingNamespace?.ToString() ?? "Global";
54.         var sb = new StringBuilder();
55.         sb.AppendLine($"namespace {namespaceName};");
56.         sb.AppendLine($"public static partial class {enumName}Extensions");
57.         sb.AppendLine("{");
58.         sb.AppendLine($"    public static string GetDescription(this {enumName} value) =>");
59.         sb.AppendLine("        value switch");
60.         sb.AppendLine("        {");
62.         // 4. 遍历枚举成员
63.         foreach (var member in enumSymbol.GetMembers().Where(m => m.Kind == SymbolKind.Field))
64.         {
65.             var description = member.GetAttributes()
66.                 .FirstOrDefault(a => a.AttributeClass?.Name == "DescriptionAttribute")
67.                 ?.ConstructorArguments.FirstOrDefault().Value?.ToString()
68.                 ?? member.Name;
70.             sb.AppendLine($"            {enumName}.{member.Name} => "{description}",");
71.         }
73.         sb.AppendLine("            _ => string.Empty");
74.         sb.AppendLine("        };");
75.         sb.AppendLine("}");
76.         return sb.ToString();
77.     }
78. }

复制代码

创建控制台主项目 MainProject

• 使用 .NET 8.0 , 引用 SourceGenerator 项目, 留意引用方式如下:
  

1. <Project Sdk="Microsoft.NET.Sdk">
3.         <PropertyGroup>
4.                 <OutputType>Exe</OutputType>
5.                 <TargetFramework>net8.0</TargetFramework>
6.                 <ImplicitUsings>enable</ImplicitUsings>
7.                 <Nullable>enable</Nullable>
8.         </PropertyGroup>
10.         <ItemGroup>
11.                 <ProjectReference Include="..\SourceGenerator\SourceGenerator.csproj" OutputItemType="Analyzer" ReferenceOutputAssembly="false" />
12.         </ItemGroup>
14. </Project>

复制代码

• 在 MainProject 中使用生成的罗列形貌扩展方法
  

1. namespace MainProject;
3. class Program
4. {
5.     static void Main()
6.     {
7.         foreach (var color in Enum.GetValues<Color>())
8.         {
9.             Console.WriteLine(color.GetDescription());
10.         }
11.         Console.ReadKey();
12.     }
13. }

复制代码

• 编译运行, 编译器会自动生成罗列形貌扩展方法的代码。
  

演示程序截图:

总结

通过增量源生成器, 我们可以在编译期自动生成获取罗列形貌的代码, 无需反射, 性能更高。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。