Обеспечение уникальности MessageKeys с помощью пользовательского анализатора Roslyn

Обеспечение уникальности MessageKeys в проектах C#

Реализация Roslyn Analyser для проверки уникальных 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 Analyser улучшает качество кода?
4. Выполняя проверки во время компиляции, он предотвращает попадание в рабочую среду таких проблем, как дублирование ключей.
5. Какие методы программирования использует анализатор?
6. Он использует RegisterSyntaxNodeAction для анализа определенных узлов синтаксиса, таких как инициализаторы объектов.
7. Можно ли настроить Roslyn Analysers для других правил?
8. Да, вы можете писать собственные правила, используя DiagnosticDescriptor и другие API-интерфейсы Roslyn, чтобы обеспечить соблюдение различных стандартов кода.
9. Каковы преимущества проверки во время компиляции?
10. Он обнаруживает ошибки на ранней стадии, сокращая время отладки и повышая общую надежность приложения. 🚀
11. Как работает альтернативная проверка времени выполнения?
12. Он использует Reflection для динамической проверки классов и LINQ для выявления повторяющихся ключей во время выполнения.
13. Какой подход лучше: проверка во время компиляции или во время выполнения?
14. Время компиляции более эффективно для разработки, а время выполнения полезно для тестирования устаревших систем или динамически загружаемых компонентов.
15. Какие проблемы могут возникнуть при создании анализатора Roslyn?
16. Понимание API Roslyn и обеспечение эффективной работы анализатора без замедления процесса сборки.
17. Могут ли Roslyn Analysers обеспечить соблюдение соглашений об именах?
18. Да, их можно расширить для проверки шаблонов именования и соблюдения стандартов кодирования.
19. Как проверить анализатор Roslyn?
20. Использование модульных тестов с библиотеками Microsoft.CodeAnaанализ.Testing для проверки различных сценариев.
21. Ограничена ли поддержка Roslyn Analyser C#?
22. Нет, его можно использовать и для других языков .NET, таких как VB.NET.

Автоматизация проверок качества кода с помощью Roslyn

Roslyn Analyser предоставляет мощный способ обеспечить соблюдение стандартов кодирования и обеспечить целостность данных в ваших проектах. Выявляя повторяющиеся поля `MessageKey` во время компиляции, это помогает разработчикам избежать критических ошибок во время выполнения и обеспечивает бесперебойную работу базы данных. Эта интеграция подчеркивает ценность методов упреждающего программирования. 🛠️

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