사용자 지정 Roslyn 분석기를 사용하여 고유한 MessageKey 보장

C# 프로젝트에서 MessageKey의 고유성 보장

컴파일 타임에 정적 분석을 사용하여 고유한 MessageKey의 유효성을 검사하는 Roslyn 분석기 구현.

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 유효성 검사

런타임 테스트 시나리오에서 고유한 MessageKey의 유효성을 검사하기 위해 LINQ 및 리플렉션을 사용하는 대체 접근 방식입니다.

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.CodeAnalytic.Testing 라이브러리와 함께 단위 테스트를 사용하여 다양한 시나리오를 검증합니다.
21. Roslyn 분석기 지원은 C#으로 제한됩니까?
22. 아니요, VB.NET과 같은 다른 .NET 언어에도 사용할 수 있습니다.

Roslyn으로 코드 품질 검사 자동화

Roslyn 분석기는 코딩 표준을 시행하고 프로젝트에서 데이터 무결성을 유지하는 강력한 방법을 제공합니다. 컴파일 중에 중복된 'MessageKey' 필드를 식별함으로써 개발자가 심각한 런타임 오류를 방지하고 원활한 데이터베이스 작업을 보장하는 데 도움이 됩니다. 이 통합은 사전 예방적 프로그래밍 방식의 가치를 강조합니다. 🛠️

대규모 애플리케이션을 확장하든 소규모 코드베이스를 최적화하든 Roslyn과 같은 도구는 비교할 수 없는 안정성을 제공합니다. 특정 요구 사항에 맞는 사용자 정의 규칙을 작성할 수 있는 기능을 통해 고유 식별자 및 기타 중요한 제약 조건을 적용하는 다목적 솔루션이 되어 간소화되고 오류 없는 개발 워크플로가 가능해집니다. 🚀