Zapewnienie unikalnych kluczy wiadomości za pomocą niestandardowego analizatora Roslyn

Zapewnienie unikalności MessageKeys w projektach C#

Implementacja analizatora Roslyn w celu sprawdzania unikalnych kluczy MessageKey przy użyciu analizy statycznej w czasie kompilacji.

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);
                        }
                    }
                }
            }
        }
    }
}

Sprawdzanie unikalnych kluczy MessageKey przy użyciu LINQ

Alternatywne podejście wykorzystujące LINQ i refleksję do sprawdzania poprawności unikalnych MessageKeys w scenariuszach testowania w czasie wykonywania.

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; }
    }
}

Często zadawane pytania dotyczące analizatorów Roslyn

1. Co to jest analizator Roslyn?
2. Narzędzie integrujące się z kompilatorem w celu analizy kodu i egzekwowania reguł, takich jak zapewnienie unikalnych wartości `MessageKey`.
3. W jaki sposób Roslyn Analyzer poprawia jakość kodu?
4. Wykonując kontrole w czasie kompilacji, zapobiega przedostawaniu się do środowiska produkcyjnego problemów takich jak zduplikowane klucze.
5. Z jakich technik programowania korzysta analizator?
6. Używa RegisterSyntaxNodeAction do analizy określonych węzłów składni, takich jak inicjatory obiektów.
7. Czy analizatory Roslyn można dostosować do innych reguł?
8. Tak, możesz pisać niestandardowe reguły za pomocą DiagnosticDescriptor i innych interfejsów API Roslyn, aby egzekwować różne standardy kodu.
9. Jakie są zalety sprawdzania poprawności w czasie kompilacji?
10. Wcześnie wychwytuje błędy, skracając czas debugowania i poprawiając ogólną niezawodność aplikacji. 🚀
11. Jak działa alternatywna walidacja środowiska wykonawczego?
12. Używa Reflection do dynamicznej kontroli klas i LINQ do identyfikowania duplikatów kluczy podczas wykonywania.
13. Które podejście jest lepsze: sprawdzanie poprawności w czasie kompilacji czy w czasie wykonywania?
14. Czas kompilacji jest bardziej efektywny w przypadku programowania, podczas gdy czas wykonywania jest przydatny do testowania starszych systemów lub dynamicznie ładowanych komponentów.
15. Jakie wyzwania mogą pojawić się podczas tworzenia analizatora Roslyn?
16. Zrozumienie interfejsu API Roslyn i zapewnienie wydajnego działania analizatora bez spowalniania procesu kompilacji.
17. Czy Roslyn Analyzers może egzekwować konwencje nazewnictwa?
18. Tak, można je rozszerzyć, aby sprawdzać wzorce nazewnictwa i egzekwować standardy kodowania.
19. Jak przetestować analizator Roslyn?
20. Korzystanie z testów jednostkowych z bibliotekami Microsoft.CodeAnalytics.Testing w celu sprawdzenia poprawności różnych scenariuszy.
21. Czy obsługa Roslyn Analyzer ogranicza się do C#?
22. Nie, można go używać również w innych językach .NET, takich jak VB.NET.

Automatyzacja kontroli jakości kodu za pomocą Roslyn

Roslyn Analyzer zapewnia skuteczny sposób egzekwowania standardów kodowania i utrzymywania integralności danych w projektach. Identyfikując zduplikowane pola „MessageKey” podczas kompilacji, pomaga programistom uniknąć krytycznych błędów w czasie wykonywania i zapewnia płynne działanie bazy danych. Integracja ta podkreśla wartość praktyk proaktywnego programowania. 🛠️

Niezależnie od tego, czy skalujesz dużą aplikację, czy optymalizujesz mniejszą bazę kodu, narzędzia takie jak Roslyn oferują niezrównaną niezawodność. Możliwość pisania niestandardowych reguł dostosowanych do konkretnych potrzeb sprawia, że ​​jest to wszechstronne rozwiązanie do egzekwowania unikalnych identyfikatorów i innych ważnych ograniczeń, umożliwiając usprawnione, wolne od błędów przepływy prac programistycznych. 🚀