PostSharp। लॉगिंग और ऑडिट कार्य

फिर से नमस्कार! पिछली बार जब एओपी पर चर्चा करते हुए, हमने कैशिंग समस्याओं को हल करने के बारे में बात की थी। आज हम समान रूप से सामान्य कार्य के बारे में बात करेंगे - लॉगिंग और ऑडिटिंग का कार्य। हमें अक्सर स्थितियों से निपटना पड़ता है, उदाहरण के लिए, किसी और के कोड का विश्लेषण। कल्पना कीजिए कि आपको तीसरे पक्ष के पुस्तकालय के साथ एकीकरण का काम दिया गया था। लगभग हर डेवलपर के मुख्य उपकरण - .net परावर्तक, ILSpy, dotPeek प्रोग्राम कोड का एक उत्कृष्ट विचार देते हैं। इसके एल्गोरिदम, संरचना, त्रुटियों के संभावित स्थानों के बारे में। और वे सॉफ्टवेयर उत्पाद के प्रश्नों का एक बड़ा प्रतिशत कवर करते हैं। हालांकि, यह तब तक होता है जब तक आप इसे सक्रिय रूप से उपयोग करना शुरू नहीं करते हैं। यहां आप एक तृतीय-पक्ष उत्पाद के अंदर प्रदर्शन की समस्याओं और समझ से बाहर "कीड़े" दोनों का सामना कर सकते हैं, जो, यदि आपके पास डिबगर फ़ंक्शन के साथ एक डिस्सेम्बलर नहीं है, तो इसे ढूंढना इतना आसान नहीं है। या, उदाहरण के लिए, आपको केवल उत्पाद को ब्रेकपॉइंट, वास्तविक-समय पर रोकने के बिना चर के मूल्यों की निगरानी करने की आवश्यकता है। ऐसे स्थानों को अक्सर तत्काल और त्वरित फिक्स की आवश्यकता होती है। लेकिन अगर आप एक कार्यक्रम नहीं लिखेंगे, तो इस कोड को कैसे ठीक किया जाएगा? हम अब ऐसी स्थितियों के बारे में बात करेंगे।


लॉगिंग और ऑडिटिंग ऐसी विशेषताएं हैं जिनमें PostSharp सर्वश्रेष्ठ में से एक है। यह क्रॉस-कटिंग के सिद्धांत को दर्शाने वाले मूलभूत उदाहरणों में से एक है। दरअसल, लॉगिंग कोड को हर उस स्थान पर इंजेक्ट करने के बजाय जहां यह किया जाना चाहिए, आप केवल एक बिंदु पर लॉगिंग दर्ज करते हैं, स्वचालित रूप से सभी आवश्यक विधियों को कोड वितरित करते हैं। और, ज़ाहिर है, आप इसे कई तरीकों, क्षेत्रों या गुणों पर चुनिंदा तरीके से कर सकते हैं। लॉग करने के लिए आप बहुत उपयोगी जानकारी लिख सकते हैं, हालांकि, ढांचे के अस्तित्व और इसके साथ काम करने के अभ्यास के दौरान, मैं निम्नलिखित लोकप्रिय श्रेणियों को उजागर करूंगा:

• निष्पादन योग्य कोड के बारे में जानकारी: फ़ंक्शन का नाम, वर्ग का नाम, पैरामीटर मान, और इसी तरह। यह उन विभिन्न परिदृश्यों को कम करने में आपकी बहुत मदद कर सकता है जो परिणाम को जन्म दे सकते हैं;
• प्रदर्शन की जानकारी: आप यह पता लगा सकते हैं कि विधियों को निष्पादित करने में कितना समय लगा;
• अपवाद: एक अपवाद को पकड़ना संभव है, इसके बारे में जानकारी को लॉग में सहेजें और इस अपवाद को पुन: उत्पन्न करें ताकि मूल एप्लिकेशन के संचालन के तर्क का उल्लंघन न हो।

लॉगिंग / ट्रेसिंग के अलावा, जो वास्तव में अधिक तकनीकी समस्याएं हैं, आप एप्लिकेशन का ऑडिट भी कर सकते हैं, जो लॉगिंग / ट्रेसिंग के समान है, सिवाय इसके कि ऑडिटिंग उन सूचनाओं को ट्रैक कर रही है जो अधिक "व्यवसाय" गतिविधि को वहन करती है। उदाहरण के लिए, आप त्रुटियों की खोज करते समय एक पैरामीटर के मानों का लॉगिंग ले सकते हैं, या आप या आपके प्रबंधक यह पता लगाना चाहते हैं कि जमा के साथ संचालन कितनी बार और कब तक किया जाता है। आप एक रिपोर्ट फ़ाइल या अपने डेटाबेस की तालिकाओं में सभी जानकारी दर्ज कर सकते हैं और इसे सुंदर रेखांकन के रूप में कॉर्पोरेट वेबसाइट पर प्रदर्शित कर सकते हैं।
आइए कुछ बैंक टेलर प्रोग्राम का उपयोग करें। और मान लें कि यह एप्लिकेशन बिल काउंटर का उपयोग कर सकता है, और WinForms का उपयोग करके भी लिखा गया है। इसके अलावा (हमारे बहुत भोले और सरलीकृत मॉडल में), बैंक को केवल एक ग्राहक (उदाहरण के लिए, राष्ट्रपति) दें, और हमें केवल एक स्थिर वर्ग दें जो सभी व्यावसायिक तर्क प्रदान करता है।

public class BankAccount
{
static BankAccount()
{
Balance = 0;
}
public static decimal Balance { get ; private set ; }

public static void Deposit( decimal amount)
{
Balance += amount;
}

public static void Withdrawl( decimal amount)
{
Balance -= amount;
}

public static void Credit( decimal amount)
{
Balance += amount;
}

public static void Fee( decimal amount)
{
Balance -= amount;
}
}

* This source code was highlighted with Source Code Highlighter .

बेशक, एक वास्तविक अनुप्रयोग में, आप केवल एक स्थिर वर्ग के बजाय सेवाओं की एक विशेष परत, निर्भरता इंजेक्शन और अन्य वास्तु समाधानों का उपयोग करेंगे। और शायद आप भी निर्भरता के "आलसी लोडिंग" का उपयोग करना चाहते हैं, हालांकि, चलो सभी अनावश्यक को छोड़ दें और मुख्य चीज़ पर ध्यान केंद्रित करें - लॉगिंग और ऑडिटिंग।
आवेदन हर समय महान काम करता है, जब तक कि कंपनी के पास ईमानदार कर्मचारी और ग्राहक हैं। हालांकि, इस बैंक के वित्तीय निदेशक के रूप में बर्खास्तगी के स्तर पर है लाखों डॉलर अचानक गायब हो गए, और कोई भी क्यों समझ सकता है। वह आपकी सहायता के लिए क्या कर रहा है, इसका पता लगाने के लिए, एक विनम्र पद विशेषज्ञ विशेषज्ञ को काम पर रखता है। वह चाहती है कि आप इस तरह से कार्यक्रम को बदल सकते हैं और सभी कार्यों और लेनदेन का ध्यान रखें (हां, लेखांकन है, लेकिन वह वास्तविक संख्या जानने के लिए कार्यक्रम के तरीकों के स्तर पर ऐसा करना चाहता है, न कि रिपोर्ट में जो दिखता है)। ऐसी स्थिति में, आप रोगी हो सकते हैं और प्रत्येक विधि में व्यावसायिक तर्क कार्यक्रम पेश कर सकते हैं (हमारे उदाहरण में, ये केवल 4 विधियां होंगी, लेकिन एक वास्तविक अनुप्रयोग में कई हजार हो सकते हैं)। या, आप सिर्फ एक विधि लिख सकते हैं, और इसे नीरस बंदर काम के बिना, वर्गों के कुछ समूहों या विधियों के सभी तरीकों पर लागू कर सकते हैं। इसके अलावा, पूरे प्रोग्राम में कोड रखते हुए, आप अपने लिए जाल सेट करते हैं, क्योंकि आपको इसे बाद में हटाने की आवश्यकता होगी (या अतिरिक्त कदम उठाएं ताकि यह रिलीज बिल्ड में न हो)। और इस दृष्टिकोण की असुविधा का दूसरा कारण यह है कि आप इसे लिखते समय गलतियां कर सकते हैं। आइए उस कोड को देखें जिसे हम PostSharp का उपयोग करके लिखेंगे:

[ Serializable ]
public class TransactionAuditAttribute : OnMethodBoundaryAspect
{
private string _methodName;
private Type _className;
private int _amountParameterIndex = -1;

public override bool CompileTimeValidate(MethodBase method)
{
if (_amountParameterIndex == -1)
{
Message.Write(SeverityType.Warning, "999" ,
"TransactionAudit was unable to find an audit 'amount' in {0}.{1}" ,
_className, _methodName);
return false ;
}
return true ;
}

public override void CompileTimeInitialize(MethodBase method, AspectInfo aspectInfo)
{
_methodName = method.Name;
_className = method.DeclaringType;

var parameters = method.GetParameters();
for ( int i=0;i<parameters.Length;i++)
{
if (parameters[i].Name == "amount" )
{
_amountParameterIndex = i;
}
}
}

public override void OnEntry(MethodExecutionArgs args)
{
if (_amountParameterIndex != -1)
{
Logger.Write(_className + "." + _methodName + ", amount: "
+ args.Arguments[_amountParameterIndex]);
}
}
}

* This source code was highlighted with Source Code Highlighter .

मैं आपको याद दिलाता हूं कि CompileTimeInitialize का उपयोग कंपाइल समय पर विधियों और मापदंडों के नाम प्राप्त करने के लिए किया जाता है, एप्लिकेशन ऑपरेशन के दौरान उपयोग किए जाने वाले प्रतिबिंब की मात्रा को कम करने के लिए (वैसे, बिल्ड-टाइम कोड का उपयोग करके प्रतिबिंब का उपयोग शून्य तक कम किया जा सकता है) और यह सुनिश्चित करने के लिए कि राशि पैरामीटर मौजूद है, के लिए जिसका हम अनुसरण करेंगे। यदि हमें यह नहीं मिलता है, तो हम डेवलपर को चेतावनी का उपयोग करते हुए इस बारे में सूचित करते हैं।
इस पहलू और संग्रहित डेटा को स्टोर करने के लिए कुछ प्रकार के भंडारण का उपयोग करके, आप अपने सीएफओ के लिए कुछ विश्लेषणात्मक जानकारी बना सकते हैं।

हालाँकि, जब जांच चल रही है, तो आप यह समझना शुरू करते हैं कि सिस्टम के साथ अन्य समस्याएं हो सकती हैं: उदाहरण के लिए, आपको पता चलेगा कि उपयोगकर्ता इंटरफ़ेस स्थिर नहीं है और एप्लिकेशन लगातार "क्रैश" हो रहा है। क्रैश की जगह का पता लगाने के लिए, आप यह समझने के लिए कि कौन सी विशिष्ट जगह विफल हो रही है, कार्यक्रम के विभिन्न स्थानों (जो कि एक बड़ी संख्या हो सकती है) में कोशिश / पकड़ कर सकते हैं। या आप एक वर्ग लिख सकते हैं, जिसके बाद अपवाद इंटरफ़ेस सभी इंटरफ़ेस विधियों पर स्वचालित रूप से सक्षम हो जाएगा (हाँ, आप आसानी से इस वर्ग के दायरे को सीमित कर सकते हैं)। निराधार न होने के लिए, आइए एक सरल उदाहरण देखें:

[ Serializable ]
public class ExceptionLoggerAttribute : OnExceptionAspect
{
private string _methodName;
private Type _className;

public override void CompileTimeInitialize(MethodBase method, AspectInfo aspectInfo)
{
_methodName = method.Name;
_className = method.DeclaringType;
}

public override bool CompileTimeValidate(MethodBase method)
{
if (! typeof (Form).IsAssignableFrom(method.DeclaringType))
{
Message.Write(SeverityType.Error, "003" ,
"ExceptionLogger can only be used on Form methods in {0}.{1}" ,
method.DeclaringType.BaseType, method.Name);
return false ;
}
return true ;
}

public override void OnException(MethodExecutionArgs args)
{
Logger.Write(_className + "." + _methodName + " - " + args.Exception);
MessageBox.Show( "There was an error!" );
args.FlowBehavior = FlowBehavior.Return;
}
}

* This source code was highlighted with Source Code Highlighter .

और, फिर से, मैं कॉल करने के लिए केवल कम करने के लिए CompileTimeInitialize का उपयोग करता हूं। इस पहलू को लागू करने के लिए (कुछ कार्यों के लिए), संबंधित विधियों / वर्गों / विधानसभाओं / नामस्थानों को चिह्नित करना आवश्यक है (इस मामले में, विधानसभा को चिह्नित किया गया है, एक अतिरिक्त फ़िल्टर विधानसभा सदस्य के पूर्ण नाम से दर्शाया गया है) विशेषता के साथ:



एक वर्ग को चिह्नित करने के लिए, आप या तो कक्षा को चिह्नित कर सकते हैं, या कक्षा के नाम को निर्दिष्ट करके विधानसभा को चिह्नित कर सकते हैं:

// in AssemblyInfo.cs
[assembly: ExceptionLogger(AttributeTargetTypes = "LoggingAuditing.BankAccountManager" )]

* This source code was highlighted with Source Code Highlighter .

जब आप लॉगिंग चालू करते हैं और एप्लिकेशन का ऑडिट करते हैं, तो भयानक चीजें सामने आती हैं:

• ग्राहक अपने खातों से नकारात्मक राशि निकाल सकते हैं, और कम ईमानदार ग्राहक अक्सर इसका उपयोग करते हैं!
• इंटरफ़ेस रूपों में जानकारी दर्ज करते समय, लोग लगातार इनपुट की जांच किए बिना टाइपोस बनाते हैं। उदाहरण के लिए, यदि कैशियर "$ 5.19" में प्रवेश करता है, तो यह एक अखंड अपवाद का कारण होगा और संपूर्ण एप्लिकेशन क्रैश हो जाएगा!

दो बहुत ही सरल पहलुओं के साथ, आप एप्लिकेशन की इन शानदार कमियों को जल्दी से पर्याप्त हल कर सकते हैं, जिससे व्यापार उपयोगकर्ताओं को लेनदेन प्रवाह का ऑडिट मिल सकता है, और डेवलपर्स को आपकी टीम में प्रवेश करने और शिपमेंट और उपयोगकर्ता अनुभव के दौरान असाधारण स्थितियों की निगरानी करने की सुविधा मिलती है। आपको यह पता होना चाहिए कि इंस्टॉलेशन स्टेज पर अंतिम उपयोगकर्ता के लिए हार्ड-टूटा हुआ एप्लिकेशन, उपयोगकर्ता के कार्य चरण में, बड़ी संख्या में समस्याएं पैदा कर सकता है। खासकर विकास टीम के साथ। हालांकि, यदि आप पहलुओं का उपयोग करते हैं, तो आप उन्हें बहुत जल्दी निदान और सही कर सकते हैं।
अब, हुड के नीचे देखें और देखें कि कोड वास्तव में क्या उत्पन्न होता है। अगर आप अभी भी नहीं समझें तो घबराएं नहीं। PostSharp का उपयोग करना बहुत आसान है और इसके परिणाम आसानी से किसी भी डिस्सेम्बलर में खोले जा सकते हैं। लेकिन चलो परिणाम कोड को वैसे भी देखते हैं। हम इसका पता लगाना चाहते हैं।
यहाँ PostSharp का उपयोग किए बिना "क्रेडिट" विधि है। जैसा कि आप देख सकते हैं, यह काफी सरल है:

public static void Credit( decimal amount)
{
Balance += amount;
}

* This source code was highlighted with Source Code Highlighter .

अगला, TransactionAudit पहलू को लागू करने के बाद उसी पद्धति को देखें। याद रखें कि यह कोड केवल परिणामी असेंबली (dll और exe फ़ाइलें) में होगा और आपके स्रोतों में नहीं होगा:

public static void Credit( decimal amount)
{
Arguments CS$0$0__args = new Arguments();
CS$0$0__args.Arg0 = amount;
MethodExecutionArgs CS$0$1__aspectArgs = new MethodExecutionArgs( null , CS$0$0__args);
CS$0$1__aspectArgs.Method = <>z__Aspects.m11;
<>z__Aspects.a14.OnEntry(CS$0$1__aspectArgs);
if (CS$0$1__aspectArgs.FlowBehavior != FlowBehavior.Return)
{
try
{
Balance += amount;
<>z__Aspects.a14.OnSuccess(CS$0$1__aspectArgs);
}
catch (Exception CS$0$3__exception)
{
CS$0$1__aspectArgs.Exception = CS$0$3__exception;
<>z__Aspects.a14.OnException(CS$0$1__aspectArgs);
CS$0$1__aspectArgs.Exception = null ;
switch (CS$0$1__aspectArgs.FlowBehavior)
{
case FlowBehavior.Continue:
case FlowBehavior.Return:
return ;
}
throw ;
}
finally
{
<>z__Aspects.a14.OnExit(CS$0$1__aspectArgs);
}
}
}

* This source code was highlighted with Source Code Highlighter .

और फिर से: घबराओ मत! :) यह कोड स्वचालित रूप से उत्पन्न चर नामों के उपयोग के कारण गड़बड़ लग सकता है, लेकिन वास्तव में यह बहुत सरल है। कोशिश / पकड़ से एक आवरण को मूल कोड में जोड़ा जाता है और एक निश्चित पहलू का कोड कहा जाता है। जैसा कि आप देख सकते हैं, केवल ओवरराइंट ऑनेंट्री विधि का उपयोग वास्तव में यहां किया जाता है, जिसमें आप अपने कार्यों को करेंगे। हालाँकि, आप अन्य विधियों (onExit, onSuccess, onException) को ओवरराइड कर सकते हैं, यदि आप किसी भी समस्या को हल करेंगे जहां उन्हें ओवरराइड करना आवश्यक होगा।
यह कोड, जो ऊपर दिया गया था, पोस्टर्सप का एक निःशुल्क संस्करण उत्पन्न करता है। कार्यक्रम का एक पूरी तरह कार्यात्मक संस्करण परिणामी कोड को अनुकूलित करके काम करता है, जैसा कि नीचे दिखाया गया है। हमारे मामले में, प्रोग्राम समझ जाएगा कि आप केवल ऑनएंट्री पद्धति का उपयोग करते हैं और इस मामले में बड़ी मात्रा में कोड उत्पन्न करने की आवश्यकता नहीं है। और इस मामले में, आपको इतना छोटा कोड मिलेगा:

public static void Credit( decimal amount)
{
Arguments CS$0$0__args = new Arguments();
CS$0$0__args.Arg0 = amount;
MethodExecutionArgs CS$0$1__aspectArgs = new MethodExecutionArgs( null , CS$0$0__args);
<>z__Aspects.a14.OnEntry(CS$0$1__aspectArgs);
Balance += amount;
}

* This source code was highlighted with Source Code Highlighter .

पूरी तरह कार्यात्मक संस्करण बुद्धिमानी से केवल उस कोड को उत्पन्न करता है जिसकी आपको आवश्यकता है। यदि आप एक एप्लिकेशन लिख रहे हैं जो कि पोस्टशार्प पहलुओं का पूरा फायदा उठाता है, तो एक पूर्ण-विशेषताओं वाले संस्करण का उपयोग करना एप्लिकेशन के प्रदर्शन को बेहतर बनाने के लिए एक अच्छा समाधान होगा।
हालाँकि, स्वचालित रूप से उत्पन्न वर्ग के सदस्यों और स्थानीय चर के मज़ेदार नामों के बावजूद, मुझे उम्मीद है कि आपको PostSharp का एक अच्छा विचार मिलेगा।

संदर्भ:

• आधिकारिक वेबसाइट
• हम कैशिंग समस्या का समाधान करते हैं
• इंटेल ब्लॉग्स: पोस्टशार्प। भाग 1
• इंटेल ब्लॉग्स: पोस्टशार्प। विकल्प
• पहलू उन्मुख प्रोग्रामिंग बनाम निर्भरता इंजेक्शन