Đảm bảo Khóa tin nhắn duy nhất bằng Trình phân tích Roslyn tùy chỉnh

Đảm bảo tính duy nhất của MessageKeys trong dự án C#

Triển khai Trình phân tích Roslyn để xác thực các Khóa thông báo duy nhất bằng cách sử dụng phân tích tĩnh tại thời điểm biên dịch.

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

Xác thực các MessageKey duy nhất bằng LINQ

Một cách tiếp cận khác sử dụng LINQ và phản ánh để xác thực các MessageKey duy nhất trong các tình huống thử nghiệm thời gian chạy.

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

Các câu hỏi thường gặp về Máy phân tích Roslyn

1. Máy phân tích Roslyn là gì?
2. Một công cụ tích hợp với trình biên dịch để phân tích mã và thực thi các quy tắc, chẳng hạn như đảm bảo các giá trị `MessageKey` duy nhất.
3. Trình phân tích Roslyn cải thiện chất lượng mã như thế nào?
4. Bằng cách thực hiện kiểm tra thời gian biên dịch, nó sẽ ngăn chặn các vấn đề như khóa trùng lặp được đưa vào sản xuất.
5. Máy phân tích sử dụng kỹ thuật lập trình nào?
6. Nó sử dụng RegisterSyntaxNodeAction để phân tích các nút cú pháp cụ thể như trình khởi tạo đối tượng.
7. Máy phân tích Roslyn có thể được tùy chỉnh cho các quy tắc khác không?
8. Có, bạn có thể viết các quy tắc tùy chỉnh bằng cách sử dụng DiagnosticDescriptor và các API Roslyn khác để thực thi nhiều tiêu chuẩn mã khác nhau.
9. Ưu điểm của việc xác thực thời gian biên dịch là gì?
10. Nó phát hiện lỗi sớm, giảm thời gian gỡ lỗi và cải thiện độ tin cậy của ứng dụng tổng thể. 🚀
11. Xác thực thời gian chạy thay thế hoạt động như thế nào?
12. Nó sử dụng Reflection để kiểm tra động các lớp và LINQ để xác định các khóa trùng lặp trong khi thực thi.
13. Cách tiếp cận nào tốt hơn: xác thực thời gian biên dịch hoặc thời gian chạy?
14. Thời gian biên dịch hiệu quả hơn cho việc phát triển, trong khi thời gian chạy rất hữu ích cho việc kiểm tra các hệ thống cũ hoặc các thành phần được tải động.
15. Những thách thức nào có thể phát sinh khi tạo Trình phân tích Roslyn?
16. Hiểu API Roslyn và đảm bảo máy phân tích hoạt động hiệu quả mà không làm chậm quá trình xây dựng.
17. Máy phân tích Roslyn có thể thực thi các quy ước đặt tên không?
18. Có, chúng có thể được mở rộng để kiểm tra các kiểu đặt tên và thực thi các tiêu chuẩn mã hóa.
19. Làm thế nào để bạn kiểm tra Máy phân tích Roslyn?
20. Sử dụng các bài kiểm tra đơn vị với thư viện Microsoft.CodeAnalysis.Testing để xác thực các kịch bản khác nhau.
21. Hỗ trợ của Trình phân tích Roslyn có bị giới hạn ở C# không?
22. Không, nó cũng có thể được sử dụng cho các ngôn ngữ .NET khác như VB.NET.

Tự động kiểm tra chất lượng mã với Roslyn

Trình phân tích Roslyn cung cấp một cách mạnh mẽ để thực thi các tiêu chuẩn mã hóa và duy trì tính toàn vẹn dữ liệu trong các dự án của bạn. Bằng cách xác định các trường `MessageKey` trùng lặp trong quá trình biên dịch, nó giúp các nhà phát triển tránh được các lỗi thời gian chạy nghiêm trọng và đảm bảo hoạt động cơ sở dữ liệu trơn tru. Sự tích hợp này làm nổi bật giá trị của việc thực hành lập trình chủ động. 🛠️

Cho dù bạn đang mở rộng quy mô một ứng dụng lớn hay tối ưu hóa cơ sở mã nhỏ hơn, các công cụ như Roslyn đều mang lại độ tin cậy chưa từng có. Khả năng viết các quy tắc tùy chỉnh phù hợp với nhu cầu cụ thể khiến nó trở thành một giải pháp linh hoạt để thực thi các mã định danh duy nhất và các ràng buộc quan trọng khác, cho phép quy trình phát triển hợp lý, không có lỗi. 🚀