使用自定义 Roslyn 分析器确保唯一的 MessageKey

确保 C# 项目中 MessageKey 的唯一性

实现 Roslyn 分析器，以在编译时使用静态分析来验证唯一的 MessageKey。

using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.CSharp.Syntax;
using Microsoft.CodeAnalysis.Diagnostics;
namespace UniqueMessageKeyAnalyzer
{
    [DiagnosticAnalyzer(LanguageNames.CSharp)]
    public class MessageKeyAnalyzer : DiagnosticAnalyzer
    {
        private static readonly DiagnosticDescriptor Rule = new DiagnosticDescriptor(
            \"UMK001\",
            \"Duplicate MessageKey detected\",
            \"MessageKey '{0}' is defined multiple times\",
            \"Design\",
            DiagnosticSeverity.Error,
            isEnabledByDefault: true);
        public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray.Create(Rule);
        public override void Initialize(AnalysisContext context)
        {
            context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
            context.EnableConcurrentExecution();
            context.RegisterSyntaxNodeAction(AnalyzeNode, SyntaxKind.ObjectInitializerExpression);
        }
        private static void AnalyzeNode(SyntaxNodeAnalysisContext context)
        {
            var initializer = (InitializerExpressionSyntax)context.Node;
            var messageKeyAssignments = new List<string>();
            foreach (var expression in initializer.Expressions)
            {
                if (expression is AssignmentExpressionSyntax assignment &&
                    assignment.Left.ToString() == \"MessageKey\")
                {
                    var value = context.SemanticModel.GetConstantValue(assignment.Right);
                    if (value.HasValue && value.Value is string messageKey)
                    {
                        if (messageKeyAssignments.Contains(messageKey))
                        {
                            var diagnostic = Diagnostic.Create(Rule, assignment.GetLocation(), messageKey);
                            context.ReportDiagnostic(diagnostic);
                        }
                        else
                        {
                            messageKeyAssignments.Add(messageKey);
                        }
                    }
                }
            }
        }
    }
}

使用 LINQ 验证唯一的 MessageKey

另一种方法是使用 LINQ 和反射在运行时测试场景中验证唯一的 MessageKey。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
namespace MessageKeyValidation
{
    public class Program
    {
        public static void Main(string[] args)
        {
            var errorCodes = typeof(ErrorMessages)
                .GetFields(BindingFlags.Public | BindingFlags.Static)
                .Select(field => field.GetValue(null) as ErrorMessageCode)
                .Where(code => code != null)
                .ToList();
            var duplicateKeys = errorCodes
                .GroupBy(code => code.MessageKey)
                .Where(group => group.Count() > 1)
                .Select(group => group.Key)
                .ToList();
            if (duplicateKeys.Any())
            {
                Console.WriteLine(\"Duplicate MessageKeys found:\");
                foreach (var key in duplicateKeys)
                {
                    Console.WriteLine(key);
                }
            }
            else
            {
                Console.WriteLine(\"All MessageKeys are unique.\");
            }
        }
    }
    public class ErrorMessages
    {
        public static readonly ErrorMessageCode Error1 = new ErrorMessageCode { MessageKey = \"00001\" };
        public static readonly ErrorMessageCode Error2 = new ErrorMessageCode { MessageKey = \"00002\" };
        public static readonly ErrorMessageCode Error3 = new ErrorMessageCode { MessageKey = \"00001\" }; // Duplicate
    }
    public class ErrorMessageCode
    {
        public string MessageKey { get; set; }
    }
}

有关 Roslyn 分析仪的常见问题

1. 什么是 Roslyn 分析仪？
2. 与编译器集成的工具，用于分析代码和强制执行规则，例如确保唯一的“MessageKey”值。
3. Roslyn 分析器如何提高代码质量？
4. 通过执行编译时检查，它可以防止重复密钥等问题到达生产环境。
5. 分析仪使用什么编程技术？
6. 它使用 RegisterSyntaxNodeAction 来分析特定语法节点，例如对象初始值设定项。
7. Roslyn 分析器可以针对其他规则进行定制吗？
8. 是的，您可以使用 DiagnosticDescriptor 和其他 Roslyn API 编写自定义规则来强制执行各种代码标准。
9. 编译时验证有哪些优点？
10. 它可以及早发现错误，减少调试时间并提高整体应用程序的可靠性。 🚀
11. 替代运行时验证如何工作？
12. 它使用 Reflection 动态检查类，并使用 LINQ 来识别执行期间的重复键。
13. 哪种方法更好：编译时验证还是运行时验证？
14. 编译时对于开发来说更加高效，而运行时对于测试遗留系统或动态加载的组件非常有用。
15. 创建 Roslyn 分析仪时会出现哪些挑战？
16. 了解 Roslyn API 并确保分析器高效执行，而不会减慢构建过程。
17. Roslyn 分析器可以强制执行命名约定吗？
18. 是的，它们可以扩展以检查命名模式并强制执行编码标准。
19. 如何测试 Roslyn 分析仪？
20. 使用 Microsoft.CodeAnalysis.Testing 库进行单元测试来验证不同的场景。
21. Roslyn 分析器支持仅限于 C# 吗？
22. 不，它也可以用于其他 .NET 语言，例如 VB.NET。

使用 Roslyn 自动执行代码质量检查

Roslyn 分析器提供了一种强大的方法来执行编码标准并维护项目中的数据完整性。通过在编译过程中识别重复的“MessageKey”字段，它可以帮助开发人员避免严重的运行时错误并确保数据库操作顺利。这种集成凸显了主动编程实践的价值。 🛠️

无论您是扩展大型应用程序还是优化较小的代码库，Roslyn 等工具都可以提供无与伦比的可靠性。根据特定需求编写自定义规则的能力使其成为强制执行唯一标识符和其他重要约束的多功能解决方案，从而实现简化、无错误的开发工作流程。 🚀