सुपर सिंपल जावास्क्रिप्ट लॉगिंग - दो डेकोरेटर, और किया

क्या आप अभी भी logger.info('ServiceName.methodName.') लिखते हुए थक गए हैं और logger.info('ServiceName.methodName -> done.') प्रत्येक छींक के लिए? शायद आप, मेरे जैसे, इस व्यवसाय को स्वचालित करने के बारे में बार-बार सोचते हैं? इस लेख में, हम क्लास-लॉगर के बारे में बात करेंगे कि समस्या के समाधान के रूप में सिर्फ दो सज्जाकार हैं।

यह क्यों आवश्यक है?

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

कोडिंग की कई हजार पंक्तियां केवल लॉगिंग के लिए लिखी गई हैं, आमतौर पर हम संदेश लिखने के लिए अपने स्वयं के कुछ पैटर्न और मानकों के निर्माण के लिए आते हैं। दुर्भाग्य से, हमें अभी भी इन पैटर्नों को मैन्युअल रूप से लागू करना है। वर्ग-लकड़हारा का मुख्य "क्यों" एक वर्ग बनाने और उसके तरीकों को कॉल करते समय आसानी से टेम्पलेट संदेशों को लॉग करने के लिए एक घोषणात्मक, विन्यास योग्य तरीका प्रदान करना है।

चेकर्स नंगे!

इधर-उधर भटकने के बिना, सीधे कोड पर जाएं।

 import { LogClass, Log } from 'class-logger' @LogClass() class ServiceCats { @Log() eat(food: string) { return 'purr' } } 

यह सेवा तीन लॉग एंट्री बनाएगी:

• निर्माणकर्ता को पारित तर्कों की सूची के साथ इसे बनाने से पहले।
• कॉल करने से पहले तर्कों की एक सूची के साथ eat ।
• eat बाद तर्कों की एक सूची और निष्पादन के परिणाम के साथ।

कोड के शब्दों में:

 //    ServiceCats // `ServiceCats.construct. Args: [].` const serviceCats = new ServiceCats() //    `eat` // `ServiceCats.eat. Args: [milk].` serviceCats.eat('milk') //    `eat` // `ServiceCats.eat -> done. Args: [milk]. Res: purr.` 

इसे लाइव प्रहार करें ।

उन घटनाओं की पूरी सूची जो गिरवी रखी जा सकती हैं:

• कक्षा बनाने से पहले।
• तुल्यकालिक और अतुल्यकालिक विधियों और कार्यात्मक गुणों को कॉल करने से पहले, दोनों स्थिर और गैर-स्थिर।
• सिंक्रोनस और एसिंक्रोनस विधियों और कार्यात्मक गुणों को कॉल करने के बाद, दोनों स्थिर और गैर-स्थिर।
• तुल्यकालिक और अतुल्यकालिक तरीकों और कार्यात्मक गुणों को कॉल करने में त्रुटियां, दोनों स्थिर और गैर-स्थिर।

एक कार्यात्मक संपत्ति एक एरो फंक्शन है जो एक प्रॉपर्टी ( class ServiceCats { private meow = () => null } ) को सौंपा गया है। ज्यादातर अक्सर निष्पादन संदर्भ ( this ) बनाए रखने के लिए उपयोग किया जाता है।

हमें लॉगिंग के "कॉन्फ़िगर करने योग्य" तरीके का वादा किया गया था

श्रेणी-लकड़हारा विन्यास पदानुक्रम के तीन स्तर:

• वैश्विक
• वर्ग
• विधि

प्रत्येक विधि को कॉल करते समय, सभी तीन स्तर एक साथ विलय होते हैं। पुस्तकालय एक उचित वैश्विक डिफ़ॉल्ट कॉन्फ़िगरेशन प्रदान करता है, इसलिए इसे बिना किसी पूर्व कॉन्फ़िगरेशन के उपयोग किया जा सकता है।

वैश्विक विन्यास

यह संपूर्ण एप्लिकेशन के लिए बनाया गया है। इसे setConfig साथ ओवरराइड किया जा सकता है।

 import { setConfig } from 'class-logger' setConfig({ log: console.info, }) 

वर्ग विन्यास

यह प्रत्येक वर्ग के लिए अद्वितीय है और इस वर्ग के सभी तरीकों पर लागू होता है। वैश्विक कॉन्फ़िगरेशन को ओवरराइड कर सकते हैं।

 import { LogClass } from 'class-logger' setConfig({ log: console.info, }) @LogClass({ //       log: console.debug, }) class ServiceCats {} 

विधि विन्यास

केवल विधि के लिए ही काम करता है। यह क्लास कॉन्फिगर और ग्लोबल कॉन्फिगरेशन पर पूर्वता लेता है।

 import { LogClass } from 'class-logger' setConfig({ log: console.info, }) @LogClass({ //       log: console.debug, }) class ServiceCats { private energy = 100 @Log({ //        log: console.warn, }) eat(food: string) { return 'purr' } //    `console.debug`    sleep() { this.energy += 100 } } 

पोक लाइव

क्या कॉन्फ़िगर किया जा सकता है?

हमने जांच की कि विन्यास कैसे बदलना है, लेकिन अभी भी यह पता नहीं चला है कि वास्तव में इसमें क्या बदलाव किया जा सकता है।

यहां आप विभिन्न मामलों के लिए कॉन्फ़िगरेशन ऑब्जेक्ट के कई उदाहरण पा सकते हैं ।

यदि आप टाइपस्क्रिप्ट को बेहतर समझते हैं तो इंटरफ़ेस से लिंक करें। रूसी की तुलना में :)

कॉन्फ़िगरेशन ऑब्जेक्ट में निम्न गुण हैं:

लॉग

यह एक फ़ंक्शन है जो वास्तव में लॉगिंग से संबंधित है। वह इनपुट पर एक स्ट्रिंग के रूप में एक स्वरूपित संदेश प्राप्त करता है। निम्न घटनाओं को लॉग करने के लिए उपयोग किया जाता है:

• कक्षा बनाने से पहले।
• तुल्यकालिक और अतुल्यकालिक विधियों और कार्यात्मक गुणों को कॉल करने से पहले, दोनों स्थिर और गैर-स्थिर।
• सिंक्रोनस और एसिंक्रोनस विधियों और कार्यात्मक गुणों को कॉल करने के बाद, दोनों स्थिर और गैर-स्थिर।

डिफ़ॉल्ट रूप से, console.log ।

logError

यह एक फ़ंक्शन है जो लॉगिंग से भी संबंधित है, लेकिन केवल त्रुटि संदेश। उसे एक स्ट्रिंग के रूप में एक स्वरूपित संदेश भी मिलता है। निम्न घटनाओं को लॉग करने के लिए उपयोग किया जाता है:

• तुल्यकालिक और अतुल्यकालिक तरीकों और कार्यात्मक गुणों को कॉल करने में त्रुटियां, दोनों स्थिर और गैर-स्थिर।

डिफ़ॉल्ट console.error ।

फ़ॉर्मेटर

यह दो तरीकों के साथ एक वस्तु है: start और end । ये विधियाँ समान स्वरूपित संदेश बनाती हैं।

start निम्न घटनाओं के लिए संदेश बनाता है:

• कक्षा बनाने से पहले।
• तुल्यकालिक और अतुल्यकालिक विधियों और कार्यात्मक गुणों को कॉल करने से पहले, दोनों स्थिर और गैर-स्थिर।

end निम्न घटनाओं के लिए संदेश उत्पन्न करता है:

• सिंक्रोनस और एसिंक्रोनस विधियों और कार्यात्मक गुणों को कॉल करने के बाद, दोनों स्थिर और गैर-स्थिर।
• तुल्यकालिक और अतुल्यकालिक तरीकों और कार्यात्मक गुणों को कॉल करने में त्रुटियां, दोनों स्थिर और गैर-स्थिर।

डिफ़ॉल्ट रूप से, new ClassLoggerFormatterService() ।

शामिल

अंतिम संदेश में क्या शामिल होना चाहिए, इसका विन्यास।

आर्ग

यह या तो एक बूलियन मूल्य या एक वस्तु हो सकता है।

यदि यह boolean , तो यह सेट करता है कि क्या तर्कों की सूची शामिल है (याद रखें Args: [milk] ?) सभी संदेशों में ( start और end )।

यदि यह एक वस्तु है, तो इसके दो बूलियन गुण होने चाहिए: start और end । start निर्दिष्ट करता है कि क्या start संदेशों के लिए एक तर्क सूची शामिल start , end संदेशों के लिए end ।

डिफ़ॉल्ट true ।

निर्माण

यह एक boolean जो नियंत्रित करता है कि कक्षा निर्माण को लॉग करना है या नहीं।

डिफ़ॉल्ट true ।

परिणाम

यह एक boolean जो विधि से रिटर्न वैल्यू के लॉगिंग को नियंत्रित करता है। यह ध्यान देने योग्य है कि वापसी मूल्य न केवल वह है जो विधि सफल निष्पादन पर वापस आती है, बल्कि यह भी है कि असफल निष्पादन के मामले में यह त्रुटि है। याद रखें Res: purr ? यदि यह ध्वज false , तो कोई Res: purr नहीं होगा Res: purr

डिफ़ॉल्ट true ।

classInstance

यह या तो एक बूलियन मूल्य या एक वस्तु हो सकता है। अवधारणा ही include.args ।

अपनी श्रेणी के क्रमबद्ध उदाहरण को पोस्ट में जोड़ता है। दूसरे शब्दों में, यदि आपकी कक्षा में कोई गुण हैं, तो उन्हें JSON में क्रमबद्ध किया जाएगा और लॉग में जोड़ा जाएगा।

सभी गुण क्रमबद्ध नहीं हैं। क्लास-लॉगर निम्न तर्क का उपयोग करता है:

• हम अपने सभी (जो कि प्रोटोटाइप में नहीं हैं) इंटेन्सा के गुणों को लेते हैं।
  
  • क्यों? बहुत कम ही, एक प्रोटोटाइप गतिशील रूप से बदलता है, इसलिए इसकी सामग्री को लॉग करने के लिए बहुत कम समझ में आता है।
• हम उन सभी प्रकार के function से बाहर फेंक देते हैं।
  
  • क्यों? अधिक बार नहीं, प्रकार function गुण केवल तीर फ़ंक्शन हैं जो संदर्भ ( this ) बनाए रखने के लिए पारंपरिक तरीकों से नहीं किए जाते हैं। उनके पास शायद ही कभी एक गतिशील प्रकृति है, इसलिए उन्हें लॉग करने का कोई मतलब नहीं है।
• हम उन सभी वस्तुओं से बाहर फेंक देते हैं जो साधारण वस्तु नहीं हैं।
  
  • ये साधारण वस्तुएं क्या हैं? यदि इसका प्रोटोटाइप Object.prototype है तो ClassLoggerFormatterService किसी ऑब्जेक्ट को सरल Object.prototype ।
  • क्यों? अक्सर अन्य सेवा वर्गों के उदाहरण गुणों के रूप में कार्य करते हैं। यदि हम क्रमबद्ध करना शुरू करते हैं तो हमारे लॉग सबसे बदसूरत तरीके से प्रफुल्लित होंगे।
• JSON स्ट्रिंग में जो कुछ भी रहता है, उसमें सीरियल करें।

 class ServiceA {} @LogClass({ include: { classInstance: true, }, }) class Test { private serviceA = new ServiceA() private prop1 = 42 private prop2 = { test: 42 } private method1 = () => null @Log() public method2() { return 42 } } //    `Test` // 'Test.construct. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}.' const test = new Test() //    `method2` // 'Test.method2. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}.' test.method2() //    `method2` // 'Test.method2 -> done. Args: []. Class instance: {"prop1":42,"prop2":{"test":42}}. Res: 42.' 

डिफ़ॉल्ट false ।

संदेश स्वरूपण पर पूर्ण नियंत्रण रखें

क्या होगा अगर आप विचार पसंद करते हैं, लेकिन आपका विचार एक अलग संदेश लाइन प्रारूप पर जोर देता है? आप अपने स्वयं के फ़ॉर्मेटर को पास करके संदेश फ़ॉर्मेटिंग पर पूर्ण नियंत्रण ले सकते हैं।

आप स्क्रैच से अपना फॉर्मेटर लिख सकते हैं। बेशक। लेकिन यह विकल्प इस ढांचे के भीतर कवर नहीं किया जाएगा (यदि आप इस विशेष विकल्प में रुचि रखते हैं, तो README में "स्वरूपण" अनुभाग पर एक नज़र डालें)।

फ़ॉर्मेटिंग को ओवरराइड करने का सबसे तेज और आसान तरीका है कि आप अपने फॉर्मेट को डिफ़ॉल्ट ClassLoggerFormatterService - ClassLoggerFormatterService ।

ClassLoggerFormatterService में निम्नलिखित protected तरीके हैं जो अंतिम संदेशों के छोटे ब्लॉक बनाते हैं:

• base
  
  • वर्ग का नाम और विधि का नाम देता है। उदाहरण: ServiceCats.eat ।
• operation
  
  • रिटर्न -> done या -> error आधार पर कि क्या विधि सफलतापूर्वक पूरी हुई।
• args
  
  • एक क्रमबद्ध तर्क सूची देता है। उदाहरण . Args: [milk] . Args: [milk] । यह हुड के तहत वस्तुओं को अनुक्रमित करने के लिए तेज-सुरक्षित-कठोर का उपयोग करता है।
• classInstance
  
  • वर्ग के क्रमबद्ध उदाहरण देता है। उदाहरण . Class instance: {"prop1":42,"prop2":{"test":42}} . Class instance: {"prop1":42,"prop2":{"test":42}} । यदि आपने शामिल किया है। config में include.classInstance , लेकिन किसी कारण से उदाहरण खुद लॉगिंग के समय उपलब्ध नहीं है (उदाहरण के लिए, स्थिर विधियों के लिए या कक्षा बनाने से पहले), N/A देता है N/A
• result
  
  • एक अनुक्रमित निष्पादन परिणाम या क्रमबद्ध त्रुटि देता है। हुड के तहत वस्तुओं के लिए तेज-सुरक्षित-स्ट्रिंग का उपयोग करता है। क्रमबद्ध त्रुटि में निम्नलिखित गुण शामिल हैं:
  • वर्ग (फ़ंक्शन) का नाम जिसका उपयोग त्रुटि ( error.constructor.name ) बनाने के लिए किया गया था।
  • कोड ( error.code )।
  • संदेश ( error.message )।
  • नाम ( error.name )।
  • स्टैक ट्रेस ( error.stack )।
• final
  
  • लौटता है . । सरल है . ।

start संदेश में निम्न शामिल हैं:

• base
• args
• classInstance
• final

end संदेश में निम्न शामिल हैं:

• base
• operation
• args
• classInstance
• result
• final

आप केवल उन बुनियादी तरीकों को ओवरराइड कर सकते हैं जिनकी आपको ज़रूरत है।

आइए देखें कि आप सभी पोस्ट में टाइमस्टैम्प को कैसे जोड़ सकते हैं।

मैं यह नहीं कह रहा हूं कि वास्तविक परियोजनाओं में ऐसा किया जाना चाहिए। पिनो , विंस्टन, और अधिकांश अन्य लोग अपने दम पर ऐसा कर सकते हैं। यह उदाहरण केवल शैक्षिक उद्देश्यों के लिए है।

 import { ClassLoggerFormatterService, IClassLoggerFormatterStartData, setConfig, } from 'class-logger' class ClassLoggerTimestampFormatterService extends ClassLoggerFormatterService { protected base(data: IClassLoggerFormatterStartData) { const baseSuper = super.base(data) const timestamp = Date.now() const baseWithTimestamp = `${timestamp}:${baseSuper}` return baseWithTimestamp } } setConfig({ formatter: new ClassLoggerTimestampFormatterService(), }) 

पोक लाइव

निष्कर्ष

स्थापना निर्देशों का पालन करना याद रखें और अपनी परियोजना पर इस पुस्तकालय का उपयोग करने से पहले खुद को परिचित करें।

मुझे आशा है कि आपने समय बर्बाद नहीं किया, और लेख आपके लिए कम से कम उपयोगी था। कृपया लात मारें और आलोचना करें। हम एक साथ बेहतर कोड करना सीखेंगे।