Забезпечення унікальних ключів повідомлень за допомогою спеціального аналізатора Roslyn

Забезпечення унікальності MessageKeys у проектах C#

Реалізація Roslyn Analyzer для перевірки унікальних MessageKeys за допомогою статичного аналізу під час компіляції.

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

Альтернативний підхід із використанням LINQ і рефлексії для перевірки унікальних MessageKeys у сценаріях тестування під час виконання.

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 та інших API Roslyn, щоб забезпечити дотримання різноманітних стандартів коду.
9. Які переваги перевірки під час компіляції?
10. Він виявляє помилки на ранній стадії, скорочуючи час налагодження та підвищуючи загальну надійність програми. 🚀
11. Як працює альтернативна перевірка середовища виконання?
12. Він використовує Reflection для динамічної перевірки класів і LINQ для виявлення дублікатів ключів під час виконання.
13. Який підхід кращий: перевірка під час компіляції чи виконання?
14. Час компіляції більш ефективний для розробки, тоді як час виконання корисний для тестування застарілих систем або динамічно завантажуваних компонентів.
15. Які проблеми можуть виникнути під час створення аналізатора Roslyn?
16. Розуміння API Roslyn і забезпечення ефективної роботи аналізатора без уповільнення процесу збірки.
17. Чи може Roslyn Analyzer забезпечити дотримання умов іменування?
18. Так, їх можна розширити, щоб перевірити шаблони іменування та застосувати стандарти кодування.
19. Як перевірити аналізатор Roslyn?
20. Використання модульних тестів із бібліотеками Microsoft.CodeAnalysis.Testing для перевірки різних сценаріїв.
21. Чи підтримка Roslyn Analyzer обмежена C#?
22. Ні, його також можна використовувати для інших мов .NET, наприклад VB.NET.

Автоматизація перевірки якості коду за допомогою Roslyn

Roslyn Analyzer надає потужний спосіб забезпечити дотримання стандартів кодування та підтримувати цілісність даних у ваших проектах. Визначаючи повторювані поля `MessageKey` під час компіляції, це допомагає розробникам уникнути критичних помилок під час виконання та забезпечує безперебійну роботу бази даних. Ця інтеграція підкреслює цінність практик проактивного програмування. 🛠️

Незалежно від того, масштабуєте ви велику програму чи оптимізуєте меншу кодову базу, такі інструменти, як Roslyn, пропонують неперевершену надійність. Можливість писати користувацькі правила, адаптовані до конкретних потреб, робить його універсальним рішенням для застосування унікальних ідентифікаторів та інших важливих обмежень, забезпечуючи оптимізовані робочі процеси розробки без помилок. 🚀