उदाहरण के रूप में एनकैप्सुलेशन परीक्षण का उपयोग करते हुए एक रोसलिन विश्लेषक बनाना

रोजलिन क्या है?

रोजलिन माइक्रोसॉफ्ट के C # और VisualBasic .NET भाषाओं के लिए ओपन सोर्स कंपाइलर और कोड एनालिसिस एपीआई का एक सेट है।

रोसलिन विश्लेषक कोड का विश्लेषण करने, त्रुटियों को खोजने और उन्हें ठीक करने के लिए एक शक्तिशाली उपकरण है।

सिंटेक्स ट्री और सिमेंटिक मॉडल

कोड का विश्लेषण करने के लिए, आपको वाक्यविन्यास के पेड़ और अर्थ मॉडल की समझ होनी चाहिए, क्योंकि ये स्थैतिक विश्लेषण के दो मुख्य घटक हैं।

एक वाक्यविन्यास वृक्ष एक तत्व है जो कार्यक्रम के स्रोत कोड के आधार पर बनाया गया है, और कोड विश्लेषण के लिए आवश्यक है। कोड के विश्लेषण के दौरान, यह इसके साथ चलता है।

प्रत्येक कोड में एक सिंटैक्स ट्री होता है। अगली कक्षा की वस्तु के लिए

class A { void Method() { } } 

वाक्यविन्यास वृक्ष इस तरह दिखेगा:

सिंटैक्सट्री का एक प्रकार एक सिंटैक्स ट्री है। तीन मुख्य तत्वों को पेड़ में प्रतिष्ठित किया जा सकता है: सिंटेक्सनॉड्स, सिंटैक्सटॉक्सेंस, सिंटेक्सट्रीविया।

सिंटेक्सनोड्स सिंटैक्स कंस्ट्रक्शन, अर्थात् घोषणाओं, ऑपरेटरों, अभिव्यक्तियों आदि का वर्णन करते हैं। C # में, सिंटैक्स कन्स्ट्रक्शंस प्रकार के एक वर्ग का प्रतिनिधित्व करते हैं SyntaxNode

Syntaxtokens तत्वों का वर्णन करता है जैसे: पहचानकर्ता, कीवर्ड, विशेष वर्ण। C # में, यह एक प्रकार का सिंटेक्सटोकन वर्ग है।

सिंटेक्सट्रिविया उन तत्वों का वर्णन करता है जो संकलित नहीं होंगे, अर्थात् रिक्त स्थान, लाइनफीड, टिप्पणियां, प्रीप्रोसेसर निर्देश। C # में, इसे SyntaxTrivia प्रकार के एक वर्ग द्वारा परिभाषित किया गया है।

सिमेंटिक मॉडल वस्तुओं और उनके प्रकारों के बारे में जानकारी का प्रतिनिधित्व करता है। इस उपकरण के लिए धन्यवाद, आप एक गहन और जटिल विश्लेषण कर सकते हैं। C # में, इसे SemanticModel के एक वर्ग द्वारा परिभाषित किया गया है।

एक विश्लेषक बनाना

स्थैतिक विश्लेषक बनाने के लिए, आपको निम्न .NETCompilerPlatformSDK घटक को स्थापित करने की आवश्यकता है।

किसी भी विश्लेषक को बनाने वाले मुख्य कार्यों में शामिल हैं:

1. क्रियाओं का पंजीकरण।
   उल्लंघन के लिए कोड की जांच करने के लिए एक्शन कोड परिवर्तन होते हैं जो विश्लेषक को आरंभ करना चाहिए। जब VisualStudio कोड परिवर्तन का पता लगाता है जो पंजीकृत कार्रवाई के अनुरूप है, तो यह पंजीकृत विश्लेषक विधि को कॉल करता है।
2. डायग्नोस्टिक्स बनाएं।
   जब उल्लंघन का पता चलता है, तो विश्लेषक उपयोगकर्ता के उल्लंघन को सूचित करने के लिए VisualStudio द्वारा उपयोग किए जाने वाले नैदानिक ​​ऑब्जेक्ट बनाता है।

एक विश्लेषक बनाने और परीक्षण के लिए कई चरण हैं:

1. एक समाधान बनाएँ।
2. विश्लेषक का नाम और विवरण पंजीकृत करें।
3. रिपोर्ट विश्लेषक की चेतावनी और सिफारिशें।
4. सिफारिशों को स्वीकार करने के लिए एक कोड निर्धारण करें।
5. इकाई परीक्षणों के साथ विश्लेषण में सुधार।

DiagnosticAnalyzer.Initialize (AnalysisContext) विधि के एक ओवरराइड में क्रियाएँ दर्ज की जाती हैं, जहां AnalysisContext वह विधि है जिसमें विश्लेषण की गई वस्तु की खोज तय होती है।

विश्लेषक एक या अधिक कोड सुधार प्रदान कर सकता है। एक कोड पैच उन परिवर्तनों की पहचान करता है जो रिपोर्ट की गई समस्या को संबोधित करते हैं। उपयोगकर्ता उपयोगकर्ता इंटरफ़ेस (संपादक में प्रकाश बल्ब) से परिवर्तन चुनता है, और VisualStudio कोड बदलता है। RegisterCodeFixesAsync विधि कोड को बदलने का तरीका बताती है।

उदाहरण

एक उदाहरण के लिए हम सार्वजनिक क्षेत्रों के विश्लेषक लिखेंगे। इस एप्लिकेशन को सार्वजनिक क्षेत्रों के बारे में उपयोगकर्ता को चेतावनी देनी चाहिए और एक संपत्ति के साथ क्षेत्र को एनकैप्सुलेट करने की क्षमता प्रदान करनी चाहिए।

यहाँ आपको क्या मिलना चाहिए:

आइए जानें कि इसके लिए क्या किया जाना चाहिए।

सबसे पहले आपको एक समाधान बनाने की आवश्यकता है।

समाधान बनाने के बाद, हम देखते हैं कि पहले से ही तीन परियोजनाएं हैं।

हमें दो वर्गों की आवश्यकता है:

1) क्लास एनालाइज़रपब्लिकफ़िल्डएनलएज़र, जिसमें हम सार्वजनिक क्षेत्रों को खोजने के लिए कोड का विश्लेषण करने और उपयोगकर्ता के लिए चेतावनी का विवरण निर्दिष्ट करते हैं।

हम निम्नलिखित गुणों का संकेत देते हैं:

 public const string DiagnosticId = "PublicField"; private const string Title = "Filed is public"; private const string MessageFormat = "Field '{0}' is public"; private const string Category = "Syntax"; private static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category, DiagnosticSeverity.Warning, isEnabledByDefault: true); public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics { get { return ImmutableArray.Create(Rule); } } 

उसके बाद, हम संकेत देते हैं कि सार्वजनिक क्षेत्रों का विश्लेषण किन मानदंडों पर होगा।

 private static void AnalyzeSymbol(SymbolAnalysisContext context) { var fieldSymbol = context.Symbol as IFieldSymbol; if (fieldSymbol != null && fieldSymbol.DeclaredAccessibility == Accessibility.Public && !fieldSymbol.IsConst && !fieldSymbol.IsAbstract && !fieldSymbol.IsStatic && !fieldSymbol.IsVirtual && !fieldSymbol.IsOverride && !fieldSymbol.IsReadOnly && !fieldSymbol.IsSealed && !fieldSymbol.IsExtern) { var diagnostic = Diagnostic.Create(Rule, fieldSymbol.Locations[0], fieldSymbol.Name); context.ReportDiagnostic(diagnostic); } } 

हमें IFieldSymbol प्रकार की एक वस्तु का एक क्षेत्र मिलता है, जिसमें फ़ील्ड संशोधक, उसके नाम और स्थान को परिभाषित करने के गुण होते हैं। हमें निदान के लिए क्या चाहिए।

यह ओवरराइड विधि में निर्दिष्ट करके विश्लेषक को आरंभ करने के लिए बना हुआ है

 public override void Initialize(AnalysisContext context) { context.RegisterSymbolAction(AnalyzeSymbol, SymbolKind.Field); } 

2) अब हम कोड के विश्लेषण के आधार पर उपयोगकर्ता द्वारा प्रस्तावित कोड को बदलने के लिए आगे बढ़ते हैं। यह क्लास एनालाइज़रपब्लिकफिल्डसकोडफिक्सप्रोवाइडर में होता है।

ऐसा करने के लिए, निम्नलिखित इंगित करें:

 private const string title = "Encapsulate field"; public sealed override ImmutableArray<string> FixableDiagnosticIds { get { return ImmutableArray.Create(AnalyzerPublicFieldsAnalyzer.DiagnosticId); } } public sealed override FixAllProvider GetFixAllProvider() { return WellKnownFixAllProviders.BatchFixer; } public sealed override async Task RegisterCodeFixesAsync(CodeFixContext context) { var root = await context.Document.GetSyntaxRootAsync(context.CancellationToken) .ConfigureAwait(false); var diagnostic = context.Diagnostics.First(); var diagnosticSpan = diagnostic.Location.SourceSpan; var initialToken = root.FindToken(diagnosticSpan.Start); context.RegisterCodeFix( CodeAction.Create(title, c => EncapsulateFieldAsync(context.Document, initialToken, c), AnalyzerPublicFieldsAnalyzer.DiagnosticId), diagnostic); } 

और हम EncapsulateFieldAsync विधि में एक संपत्ति के साथ क्षेत्र को एनकैप्सुलेट करने की क्षमता निर्धारित करते हैं।

 private async Task<Document> EncapsulateFieldAsync(Document document, SyntaxToken declaration, CancellationToken cancellationToken) { var field = FindAncestorOfType<FieldDeclarationSyntax>(declaration.Parent); var fieldType = field.Declaration.Type; ChangeNameFieldAndNameProperty(declaration.ValueText, out string fieldName, out string propertyName); var fieldDeclaration = CreateFieldDecaration(fieldName, fieldType); var propertyDeclaration = CreatePropertyDecaration(fieldName, propertyName, fieldType); var root = await document.GetSyntaxRootAsync(); var newRoot = root.ReplaceNode(field, new List<SyntaxNode> { fieldDeclaration, propertyDeclaration }); var newDocument = document.WithSyntaxRoot(newRoot); return newDocument; } 

ऐसा करने के लिए, एक निजी फ़ील्ड बनाएं।

 private FieldDeclarationSyntax CreateFieldDecaration(string fieldName, TypeSyntax fieldType) { var variableDeclarationField = SyntaxFactory.VariableDeclaration(fieldType) .AddVariables(SyntaxFactory.VariableDeclarator(fieldName)); return SyntaxFactory.FieldDeclaration(variableDeclarationField) .AddModifiers(SyntaxFactory.Token(SyntaxKind.PrivateKeyword)); } 

फिर एक सार्वजनिक संपत्ति बनाएं जो इस निजी क्षेत्र को लौटाता है और प्राप्त करता है।

 private PropertyDeclarationSyntax CreatePropertyDecaration(string fieldName, string propertyName, TypeSyntax propertyType) { var syntaxGet = SyntaxFactory.ParseStatement($"return {fieldName};"); var syntaxSet = SyntaxFactory.ParseStatement($"{fieldName} = value;"); return SyntaxFactory.PropertyDeclaration(propertyType, propertyName) .AddModifiers(SyntaxFactory.Token(SyntaxKind.PublicKeyword)) .AddAccessorListAccessors( SyntaxFactory.AccessorDeclaration(SyntaxKind.GetAccessorDeclaration).WithBody(SyntaxFactory.Block(syntaxGet)), SyntaxFactory.AccessorDeclaration(SyntaxKind.SetAccessorDeclaration).WithBody(SyntaxFactory.Block(syntaxSet))); } 

उसी समय, हम स्रोत फ़ील्ड के प्रकार और नाम को सहेजते हैं। फ़ील्ड का नाम "_name", और संपत्ति के नाम "नाम" के रूप में बनाया गया है।

संदर्भ

1. गिटहब स्रोत
2. .NET कंपाइलर प्लेटफार्म SDK