Memastikan MessageKeys Unik dengan Roslyn Analyzer Kustom

Memastikan Keunikan MessageKeys dalam Proyek C#

Implementasi Roslyn Analyzer untuk memvalidasi MessageKeys unik menggunakan analisis statis pada waktu kompilasi.

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

Memvalidasi MessageKeys Unik Menggunakan LINQ

Pendekatan alternatif menggunakan LINQ dan refleksi untuk memvalidasi MessageKeys unik dalam skenario pengujian runtime.

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

Pertanyaan Umum Tentang Roslyn Analyzer

1. Apa itu Penganalisis Roslyn?
2. Alat yang terintegrasi dengan compiler untuk menganalisis kode dan menegakkan aturan, seperti memastikan nilai `MessageKey` yang unik.
3. Bagaimana cara Roslyn Analyzer meningkatkan kualitas kode?
4. Dengan melakukan pemeriksaan waktu kompilasi, hal ini mencegah masalah seperti kunci duplikat mencapai produksi.
5. Teknik pemrograman apa yang digunakan penganalisis?
6. Ia menggunakan RegisterSyntaxNodeAction untuk menganalisis node sintaksis tertentu seperti penginisialisasi objek.
7. Bisakah Roslyn Analyzer disesuaikan untuk aturan lain?
8. Ya, Anda dapat menulis aturan khusus menggunakan DiagnosticDescriptor dan API Roslyn lainnya untuk menerapkan berbagai standar kode.
9. Apa keuntungan dari validasi waktu kompilasi?
10. Ini mendeteksi kesalahan lebih awal, mengurangi waktu debugging dan meningkatkan keandalan aplikasi secara keseluruhan. 🚀
11. Bagaimana cara kerja validasi runtime alternatif?
12. Ia menggunakan Refleksi untuk memeriksa kelas secara dinamis dan LINQ untuk mengidentifikasi kunci duplikat selama eksekusi.
13. Pendekatan mana yang lebih baik: validasi waktu kompilasi atau waktu proses?
14. Waktu kompilasi lebih efisien untuk pengembangan, sedangkan waktu proses berguna untuk menguji sistem lama atau komponen yang dimuat secara dinamis.
15. Tantangan apa saja yang mungkin timbul saat membuat Roslyn Analyzer?
16. Memahami Roslyn API dan memastikan penganalisis bekerja secara efisien tanpa memperlambat proses pembangunan.
17. Bisakah Roslyn Analyzers menerapkan konvensi penamaan?
18. Ya, mereka dapat diperluas untuk memeriksa pola penamaan dan menegakkan standar pengkodean.
19. Bagaimana Anda menguji Roslyn Analyzer?
20. Menggunakan pengujian unit dengan pustaka Microsoft.CodeAnalysis.Testing untuk memvalidasi berbagai skenario.
21. Apakah dukungan Roslyn Analyzer terbatas pada C#?
22. Tidak, ini bisa digunakan untuk bahasa .NET lain seperti VB.NET juga.

Mengotomatiskan Pemeriksaan Kualitas Kode dengan Roslyn

Roslyn Analyzer menyediakan cara ampuh untuk menerapkan standar pengkodean dan menjaga integritas data dalam proyek Anda. Dengan mengidentifikasi duplikat kolom `MessageKey` selama kompilasi, hal ini membantu pengembang menghindari kesalahan runtime kritis dan memastikan kelancaran operasi database. Integrasi ini menyoroti nilai praktik pemrograman proaktif. 🛠️

Baik Anda menskalakan aplikasi besar atau mengoptimalkan basis kode yang lebih kecil, alat seperti Roslyn menawarkan keandalan yang tak tertandingi. Kemampuan untuk menulis aturan khusus yang disesuaikan dengan kebutuhan spesifik menjadikannya solusi serbaguna untuk menerapkan pengidentifikasi unik dan batasan penting lainnya, memungkinkan alur kerja pengembangan yang efisien dan bebas kesalahan. 🚀