カスタム Roslyn アナライザーを使用して一意の MessageKey を確保する

C# プロジェクトでの MessageKey の一意性の確保

コンパイル時に静的分析を使用して一意の MessageKey を検証する Roslyn Analyzer の実装。

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 の検証

LINQ とリフレクションを使用して、ランタイム テスト シナリオで一意の MessageKey を検証する代替アプローチ。

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. ロズリンアナライザーとは何ですか?
2. コンパイラと統合してコードを分析し、一意の `MessageKey` 値を保証するなどのルールを適用するツール。
3. Roslyn Analyzer はコードの品質をどのように向上させますか?
4. コンパイル時チェックを実行することで、重複キーなどの問題が運用環境に到達するのを防ぎます。
5. アナライザーはどのようなプログラミング手法を使用しますか?
6. RegisterSyntaxNodeAction を使用して、オブジェクト初期化子のような特定の構文ノードを分析します。
7. Roslyn Analyzer を他のルール用にカスタマイズできますか?
8. はい。DiagnosticDescriptor やその他の Roslyn API を使用してカスタム ルールを作成し、さまざまなコード標準を適用できます。
9. コンパイル時の検証にはどのような利点がありますか?
10. エラーを早期に検出し、デバッグ時間を短縮し、アプリケーション全体の信頼性を向上させます。 🚀
11. 代替ランタイム検証はどのように機能しますか?
12. リフレクションを使用してクラスを動的に検査し、LINQ を使用して実行中に重複キーを特定します。
13. コンパイル時検証と実行時検証ではどちらのアプローチが優れていますか?
14. コンパイル時間は開発にとってより効率的ですが、ランタイムはレガシー システムや動的に読み込まれるコンポーネントのテストに役立ちます。
15. Roslyn Analyzer を作成するときにどのような課題が発生する可能性がありますか?
16. Roslyn API を理解し、ビルド プロセスを遅くすることなくアナライザーが効率的に実行されるようにします。
17. Roslyn Analyzer は命名規則を強制できますか?
18. はい、拡張して命名パターンをチェックし、コーディング標準を強制することができます。
19. Roslyn Analyzer をテストするにはどうすればよいですか?
20. Microsoft.CodeAnalysis.Testing ライブラリで単体テストを使用して、さまざまなシナリオを検証します。
21. Roslyn Analyzer のサポートは C# に限定されますか?
22. いいえ、VB.NET などの他の .NET 言語でも使用できます。

Roslyn を使用したコード品質チェックの自動化

Roslyn Analyzer は、コーディング標準を強制し、プロジェクト内のデータの整合性を維持するための強力な方法を提供します。コンパイル中に重複する `MessageKey` フィールドを識別することで、開発者が重大なランタイム エラーを回避し、スムーズなデータベース操作を保証できるようになります。この統合により、プロアクティブなプログラミング実践の価値が強調されます。 🛠️

大規模なアプリケーションをスケーリングする場合でも、より小規模なコードベースを最適化する場合でも、Roslyn のようなツールは比類のない信頼性を提供します。特定のニーズに合わせたカスタム ルールを作成できるため、一意の識別子やその他の重要な制約を強制する多用途のソリューションとなり、効率的でエラーのない開発ワークフローが可能になります。 🚀