Sikring af unikke meddelelsesnøgler med en brugerdefineret Roslyn Analyzer

Sikring af unikke MessageKeys i C#-projekter

Implementering af en Roslyn Analyzer til at validere unikke MessageKeys ved hjælp af statisk analyse på kompileringstidspunktet.

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

Validering af unikke meddelelsesnøgler ved hjælp af LINQ

En alternativ tilgang ved hjælp af LINQ og refleksion til at validere unikke MessageKeys i runtime testscenarier.

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

Almindelige spørgsmål om Roslyn Analyzers

1. Hvad er en Roslyn Analyzer?
2. Et værktøj, der integreres med compileren for at analysere kode og håndhæve regler, såsom at sikre unikke 'MessageKey'-værdier.
3. Hvordan forbedrer en Roslyn Analyzer kodekvaliteten?
4. Ved at udføre kompileringstidstjek forhindrer det problemer som duplikerede nøgler i at nå produktionen.
5. Hvilke programmeringsteknikker bruger analysatoren?
6. Den bruger RegisterSyntaxNodeAction til at analysere specifikke syntaksnoder som objektinitialisatorer.
7. Kan Roslyn Analyzers tilpasses til andre regler?
8. Ja, du kan skrive tilpassede regler ved hjælp af DiagnosticDescriptor og andre Roslyn API'er for at håndhæve en række kodestandarder.
9. Hvad er fordelene ved kompileringstidsvalidering?
10. Det fanger fejl tidligt, reducerer fejlretningstiden og forbedrer den overordnede applikationspålidelighed. 🚀
11. Hvordan fungerer den alternative runtime-validering?
12. Den bruger Reflection til dynamisk at inspicere klasser og LINQ til at identificere duplikerede nøgler under udførelse.
13. Hvilken tilgang er bedre: kompileringstids- eller runtime-validering?
14. Kompileringstid er mere effektiv til udvikling, mens runtime er nyttig til at teste ældre systemer eller dynamisk indlæste komponenter.
15. Hvilke udfordringer kan der opstå, når man laver en Roslyn Analyzer?
16. Forståelse af Roslyn API og sikre, at analysatoren fungerer effektivt uden at bremse byggeprocessen.
17. Kan Roslyn Analyzers håndhæve navnekonventioner?
18. Ja, de kan udvides til at kontrollere navnemønstre og håndhæve kodningsstandarder.
19. Hvordan tester man en Roslyn Analyzer?
20. Brug af enhedstest med Microsoft.CodeAnalysis.Testing-biblioteker til at validere forskellige scenarier.
21. Er Roslyn Analyzer-understøttelse begrænset til C#?
22. Nej, det kan også bruges til andre .NET-sprog som VB.NET.

Automatisering af kodekvalitetstjek med Roslyn

Roslyn Analyzer giver en effektiv måde at håndhæve kodningsstandarder og opretholde dataintegritet i dine projekter. Ved at identificere duplikerede `MessageKey`-felter under kompilering hjælper det udviklere med at undgå kritiske runtime-fejl og sikrer glatte databaseoperationer. Denne integration fremhæver værdien af ​​proaktiv programmeringspraksis. 🛠️

Uanset om du skalerer en stor applikation eller optimerer en mindre kodebase, tilbyder værktøjer som Roslyn uovertruffen pålidelighed. Evnen til at skrive tilpassede regler skræddersyet til specifikke behov gør det til en alsidig løsning til at håndhæve unikke identifikatorer og andre vigtige begrænsninger, hvilket muliggør strømlinede, fejlfrie udviklingsarbejdsgange. 🚀