Java / क्विक स्टार्ट में लॉग इन करना

डेटाआर्ट में अपने काम के दौरान, मैं, अन्य बातों के अलावा, सलाह देने में संलग्न हूं। विशेष रूप से, इसमें प्रशिक्षुओं द्वारा किए गए प्रशिक्षण कार्य की जाँच शामिल है। हाल ही में, कार्यों में लॉगर के "अजीब" उपयोग के कार्यों में एक प्रवृत्ति हुई है। मेरे सहयोगियों और मैंने असाइनमेंट के पाठ में जावा लॉगिंग सर्वोत्तम प्रथाओं का वर्णन करने वाले एक लेख के लिंक को शामिल करने का निर्णय लिया, लेकिन यह पता चला कि ऐसा लेख जो केवल और अतिरिक्त विवरण के बिना अभ्यास में समझाएगा कि जावा लॉग को कैसे लिखें? स्थित है।

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


कुछ स्पष्टीकरण।

• सभी नमूना कोड java.util.log फ्रेमवर्क का उपयोग करता है। सवाल "लॉगिंग फ्रेमवर्क में से कौन सा सबसे अधिक कोषेर है" मैं पर्दे के पीछे छोड़ दूंगा। मैं सिर्फ इतना ही कहूंगा कि java.util.log तक पहुंचने का सबसे आसान तरीका है क्योंकि यह पहले से ही जेआरई के साथ आता है और वास्तव में इस लेख में बताया गया है कि कम से कम कॉस्मेटिक परिवर्तन लॉगिंग सिस्टम के विशाल बहुमत के लिए सच है।
• सामान्य तौर पर, इस लेख में दिए गए व्यंजन केवल सच नहीं हैं, ऐसे क्षण भी हैं जिन्हें तर्क दिया जा सकता है, लेकिन सामान्य तौर पर, इन व्यंजनों का उपयोग कई वर्षों से, कई डेवलपर्स द्वारा, कई परियोजनाओं में किया गया है और यदि वे आपके पास नहीं हैं तो उनका पालन करना काफी अच्छा है। गंभीर आपत्तियाँ।
• लेख इस तरह के "उन्नत" विषयों पर चर्चा नहीं करता है:
  
  • व्यक्तिगत लॉगर के लिए स्तर विन्यास
  • स्वरूपण लॉग
  • अतुल्यकालिक लॉगिंग
  • Log4J में कस्टम लॉगिंग स्तर बनाना
  • प्रासंगिक लॉगिंग
  • और भी बहुत कुछ
• मैं मुख्य रूप से बाद में एक ही अक्षर "जी" के साथ लॉगिंग के रूप में रूसी में लॉगिंग शब्द लिखता हूं, कि इस प्रकार का अनुवाद अधिक आम है
• टिप्स, जो मुझे लॉग करने के किस स्तर के साथ शायद पर्दे के पीछे छोड़ देंगे। यह सब आवेदन, परिचालन की स्थिति, ग्राहक के साथ संबंध आदि पर निर्भर करता है। सूक्ष्म बातें।

उदाहरण संख्या १

अच्छी तरह से

public class SomeClass { private static Logger log = Logger.getLogger(SomeClass.class.getName()); public void someMethod() { log.info("Some message"); } ... 

1. लकड़हारा एक स्थिर वर्ग क्षेत्र है, जब कक्षा को लोड किया जाता है, तो इसका एक सरल, संक्षिप्त नाम होता है, यह महत्वपूर्ण है कि आपकी सभी कक्षाओं में लकड़हारा चर को समान कहा जाता है (यह सामान्य नियम द्वारा निर्धारित होता है, कार्यक्रम में समान चीजों को उसी तरह किया जाना चाहिए)।
2. मैं लकड़हारे के नाम के रूप में वर्ग के नाम का उपयोग करता हूं, वास्तव में यह एकमात्र तरीका नहीं है, आप कुछ प्रकार के लॉगिंग पदानुक्रम को व्यवस्थित करने की कोशिश कर सकते हैं (उदाहरण के लिए, डेटा विनिमय से निपटने वाले उपप्रणालियों के लिए परिवहन परत / ऐप परत), लेकिन अभ्यास से पता चलता है, बाद में मुख्य चीज़ का आविष्कार करना इस तरह के पदानुक्रम का सख्ती से पालन करना बेहद मुश्किल है, और लकड़हारा नामों के साथ वर्ग नामों के साथ मेल खाने वाला विकल्प बहुत अच्छा है और 99% परियोजनाओं में उपयोग किया जाता है
3. यहां मैं लॉग को लिखने के लिए शॉर्ट .info विधि का उपयोग करता हूं, और अधिक सामान्य .log विधि नहीं, इतना अधिक संक्षिप्त
4. लकड़हारे का नाम SomeClass.class.getName () के रूप में लिया जाता है, और "com.dataart.demo.java.log.SomeClass" के रूप में नहीं, दोनों विधियां मूल रूप से समान हैं, लेकिन वर्ग नाम / पैकेज को निष्क्रिय करते समय पहला आपको आश्चर्य से बचाता है।

बीमार

 public class SomeClass { public void someMethod() { Logger.getLogger("com.dataart.demo.java.logging.SomeClass").log(Level.INFO,"Some message"); } ... 

अनिवार्य रूप से एक ही बात है, लेकिन अधिक अक्षर हैं और इसे पढ़ना इतना आसान नहीं है।

उदाहरणों के बीच ध्यान दें

आपने शायद देखा कि उदाहरणों में सभी संदेश अंग्रेजी में हैं। यह कोई संयोग नहीं है। तथ्य यह है कि यहां तक ​​कि अगर हर कोई जो काम करता है और आपके कोड के साथ काम करेगा, रूसी बोलता है, तो क्या यह संभव है कि आपको दूरस्थ कंप्यूटर पर संदेश लॉग को देखना होगा, उदाहरण के लिए ssh के माध्यम से, और बड़ी संख्या में मामलों में आपको ऐसा कुछ दिखाई देगा "? ???, ???? ????? !!!! " (मुझे निश्चित रूप से पता है कि आप ssh के माध्यम से रूसी पत्र खींच सकते हैं, लेकिन किसी कारण से, किसी भी तरह से सब कुछ हमेशा ठीक से सेट नहीं होता है)।
या यहां तक ​​कि cmd में स्थानीय मशीन पर आप देख सकते हैं कि यह क्या है:
INFO: ╨╨░╨║╨╛╨╡-╤╨╛ ╤╨╛╨╛╨▒╤╨╡╨╜╨╕╨╡ ╨▓ ╨╗╨╛╨│

बेशक, यह भी लड़ा जा सकता है। लेकिन हैंडसेट के दूसरे छोर पर ग्राहक को समझाना हमेशा आसान नहीं होता है कि कैसे दरार के बजाय रूसी पत्र दिखाई दें।
युक्ति: संदेश को अंग्रेजी में लिखें, या, चरम मामलों में, लैटिन अक्षरों में।

उदाहरण संख्या 2

अच्छी तरह से

 try { throw new Exception("Some exception"); } catch (Exception ex) { log.log(Level.SEVERE, "Exception: ", ex); } //         log.fine("some minor, debug message"); /*         (  -    ..).               */ if (log.isLoggable(Level.FINE)) { log.fine("Some CPU consuming message: " + prepareCPUConsumingLogMessage()); } 

1. यदि आपको एक अपवाद आरक्षित करने की आवश्यकता है, तो इसके लिए .log (स्तर, संदेश, अपवाद) विधि का उपयोग करें
2. यदि आपने लॉग सिस्टम को विशेष रूप से कॉन्फ़िगर नहीं किया है, तो सूचना के स्तर से कम स्तर वाले संदेश, उदाहरण के लिए, ठीक प्रदर्शित नहीं किए जाएंगे। लेकिन सिस्टम के महत्वपूर्ण हिस्सों के लिए उन्हें लिखना कम से कम इसके लायक है। जब कुछ गलत होता है, तो आप लॉगिंग के अधिक विस्तृत स्तर को कॉन्फ़िगर करेंगे और बहुत सारी दिलचस्प चीजें देखेंगे।
3. बहुत से लॉग संदेश, भले ही वे लॉग फ़ाइल में बहुत कम स्तर के कारण भौतिक रूप से लिखे नहीं गए हों, प्रोग्राम को काफी धीमा कर सकते हैं। खासकर यदि आपको संदेश तैयार करने के लिए बहुत सारे संसाधन खर्च करने की आवश्यकता है। इसके लिए एक .isLoggable (स्तर) विधि है - यह आपको यह पता लगाने की अनुमति देता है कि लकड़हारा का वर्तमान कॉन्फ़िगरेशन इस संदेश को छोड़ देगा या नहीं

बीमार

 try { throw new Exception("Some exception"); } catch (Exception ex) { log.severe("Exception: " + ex.toString() ); } log.fine("Some CPU consuming message: " + itTakes500MillisecondsToPrepageThisMessage()); 

यदि आप केवल ex.toString () लॉग इन करते हैं, तो बाद में आप यह पता लगाने में सक्षम नहीं होंगे कि मूल रूप से काम किया गया अपवाद किस पंक्ति में है।

उदाहरण संख्या 3

लकड़हारा को कॉन्फ़िगर करने की आवश्यकता है। एक डिफ़ॉल्ट कॉन्फ़िगरेशन है; यह INFO स्तर के साथ सभी संदेशों को प्रदर्शित करता है और कंसोल को उच्चतर करता है। यह IDE से विकास के लिए पर्याप्त है, लेकिन एक वास्तविक एप्लिकेशन के लिए इसे ठीक करना अच्छा होगा।

क्या विकल्प हैं

डिफ़ॉल्ट: INFO स्तर, कंसोल आउटपुट के लिए Logging.properties फ़ाइल

#Console handler
handlers= java.util.logging.ConsoleHandler
.level=INFO


हम लॉगिंग को अधिक विस्तृत बनाते हैं; हम FINE स्तर के संदेश भी प्रदर्शित करते हैं

#Console handler
handlers= java.util.logging.ConsoleHandler
.level=FINE
java.util.logging.ConsoleHandler.level = FINE


हमने यहां क्या किया है

• हमने रूट लकड़हारे के लिए FINE स्तर निर्धारित किया है, ताकि संदेश सिस्टम लॉग में क्रॉल हो जाए।
• और उन्होंने कहा कि लॉग सिस्टम के माध्यम से क्रॉल करने वाली हर चीज को FINE स्तर से और ऊपर कंसोल पर प्रदर्शित किया जाना चाहिए।

संदेश लॉग को कहीं और प्रदर्शित करें

कंसोल के लिए बुरा निष्कर्ष क्या है? कंसोल अनिवार्य रूप से अच्छा पुराना स्टैडर है । इसका क्या मतलब है:

• यदि एप्लिकेशन को जावॉ का उपयोग करके लॉन्च किया जाता है, तो आपको कुछ भी दिखाई नहीं देगा।
• यदि आउटपुट कंसोल पर जाता है और जिस संदेश की आपको 4 घंटे पहले फ्लैश करने की आवश्यकता होती है, कंसोल पहले से ही इसे खा जाता है, तो सूचना खो गई थी।
• यदि कंसोल आउटपुट को जावा फ़ाइल com.yourcompanyname.EntryClass 2 >> Application_log.txt पर निर्देशित किया जाता है और एप्लिकेशन कई हफ्तों तक बिना रुके काम करता है, तो फ़ाइल बहुत, बहुत बड़ी हो जाएगी, संपूर्ण डिस्क को उठाकर।

इन समस्याओं को हल करने के लिए, java.util.log.FileHandler का आविष्कार किया गया था - एक हैंडलर जो एक फ़ाइल में एक संदेश लॉग को आउटपुट करता है। उसी समय, वह फ़ाइलों को घुमा सकता है, अर्थात। अधिकतम आकार तक पहुंचने के बाद, यह वर्तमान लॉग संदेश को फ़ाइल में जोड़ता है और एक वृद्धिशील उपसर्ग के साथ एक नई फ़ाइल खोलता है। और इसलिए एक सर्कल में। उदाहरण के लिए

 handlers= java.util.logging.FileHandler java.util.logging.FileHandler.pattern = application_log.txt java.util.logging.FileHandler.limit = 50 java.util.logging.FileHandler.count = 7 java.util.logging.FileHandler.formatter = java.util.logging.SimpleFormatter 

ऐसी फाइलें बनाएंगे (अंतिम कॉलम - आकार बाइट्स में)

 application_log.txt.0 │ 0
 application_log.txt.1 .1 79
 application_log.txt.2 │ 79
 application_log.txt.3 76 676
 application_log.txt.4 │ 87
 application_log.txt.5 log 114

हमने अधिकतम 50 बाइट्स का आकार निर्दिष्ट किया है, वास्तविक जीवन में आपको कम से कम एक मेगाबाइट का संकेत देना चाहिए, उदाहरण के लिए इस तरह से (मुझे पता है कि 1,000,000 मेगाबाइट से थोड़ा कम है, लेकिन जो स्मृति से 1048576 लिखना चाहता है, अगर वह मामले का सार बदल जाए)

 java.util.log.FileHandler.limit = 1000000

उदाहरण में, जैसा कि हम देख सकते हैं, फाइलें 50 से अधिक बाइट्स के रूप में निकलीं क्योंकि आकार अनिवार्य रूप से अंतिम संपूर्ण संदेश लॉग तक गोल है। यानी यदि आप 1 बाइट का आकार निर्दिष्ट करते हैं और आकार में 1000 बाइट्स का लॉग संदेश लिखते हैं, तो फ़ाइल का आकार 1000 बाइट्स हो जाएगा और उसके बाद संदेश लॉग फ़ाइल बंद हो जाएगी और अगला खुल जाएगा।

वास्तविक जीवन के लिए कॉपी और पेस्ट विन्यास, यह अधिकांश सेवा, कंसोल और डेस्कटॉप अनुप्रयोगों के लिए पर्याप्त है।

 हैंडलर = java.util.log.FileHandler

 java.util.log.FileHandler.pattern = application_log.txt
 java.util.log.FileHandler.limit = 1000000
 java.util.log.FileHandler.count = 5
 java.util.log.FileHandler.formatter = java.util.log.SimpleFormatter

जादू का आखिरी टुकड़ा

खैर, आखिरी बात यह बताना बाकी है कि गुण फाइल से वास्तव में लकड़हारा को कैसे कॉन्फ़िगर किया जाए। इसके दो तरीके हैं:

1. एप्लिकेशन को चलाने के लिए कमांड लाइन से
2. आपके एप्लिकेशन कोड की पहली पंक्तियों में

पहला वाला थोड़ा अधिक सही है क्योंकि यह घोषणात्मक है और आपके आवेदन के कोड के काम करने से तुरंत पहले काम करता है।

इस तरह

java Djava.util.logging.config.file=logging.properties com.dataart.application.ClassName

लेकिन दुर्भाग्य से, लॉन्च लाइन को बदलना हमेशा संभव नहीं होता है या हमेशा सुविधाजनक नहीं होता है। दूसरी विधि भी अच्छी तरह से काम करती है।

 public static void main(String[] args) { try { LogManager.getLogManager().readConfiguration( MainApplicationEntryClass.class.getResourceAsStream("/logging.properties")); } catch (IOException e) { System.err.println("Could not setup logger configuration: " + e.toString()); } ..... 

• यहाँ MainApplicationEntryClass एक वर्ग है - आपके आवेदन के लिए प्रवेश बिंदु, जाहिर है वर्ग का नाम आपके पास अलग होगा
• Logging.properties फ़ाइल ही, एक नियम के रूप में, ऐसे मामलों में वर्ग पदानुक्रम की जड़ में रखा गया है और यह इस तरह दिखता है

पर्दे के पीछे क्या रहता है

वास्तविक जीवन में, सभी जावा अनुप्रयोगों में से कम से कम आधे वेब अनुप्रयोग हैं। उनमें प्रवेश करने की बहुत ही तकनीक उपरोक्त से बिल्कुल अलग नहीं है। ठीक है, शायद इस अपवाद के साथ कि विभिन्न एप्लिकेशन सर्वर विभिन्न लॉगिंग लाइब्रेरी का उपयोग कर सकते हैं जैसे:

• Log4J
• JULI लकड़हारा (सख्ती से बोलते हुए, यह पूरी तरह से स्वतंत्र ढांचा नहीं है, लेकिन java.utr.log के लिए एक तरह का ऐड-ऑन है)
• SLF4J
• कॉमन्स लॉगिंग

तदनुसार, कॉन्फ़िगरेशन और विधि के नाम थोड़ा अलग हैं। लेकिन सिद्धांत ही थोड़ा बदलता है। विशिष्ट विशेषताएं आमतौर पर उदाहरण के लिए, एप्लिकेशन सर्वर के लिए प्रलेखन में अच्छी तरह से वर्णित हैं

• बिल्ला
• JBoss
• राल