🔇 👨🏼‍🏭 🈹 YARG - रिपोर्ट बनाने के लिए एक ओपन-सोर्स लाइब्रेरी 👿 🕵🏼 👆🏻

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

YARG आपको इसकी अनुमति देता है:

एक टेम्पलेट प्रारूप में एक रिपोर्ट बनाएं या परिणाम को पीडीएफ में परिवर्तित करें;
परिचित और सामान्य स्वरूपों में रिपोर्ट टेम्पलेट बनाएँ: DOC, ODT, XLS, DOCX, XLSX, HTML;
जटिल XLS और XLSX टेम्प्लेट बनाएँ: नेस्टेड डेटा क्षेत्र, ग्राफ़, सूत्र, आदि के साथ।
रिपोर्टों में छवियों और HTML मार्कअप का उपयोग करें;
XML प्रारूप में स्टोर रिपोर्ट संरचना;
रिपोर्ट तैयार करने के लिए स्टैंडअलोन एप्लिकेशन चलाएं, जो जावा पारिस्थितिकी तंत्र के बाहर पुस्तकालय का उपयोग करना संभव बनाता है (उदाहरण के लिए, PHP में रिपोर्ट बनाने के लिए);
IoC चौखटे (वसंत, गिटार) के साथ एकीकृत करें।

इस लाइब्रेरी का उपयोग CUBA प्लेटफॉर्म में रिपोर्ट इंजन के लिए आधार के रूप में किया जाता है। हम इसे 2010 से विकसित कर रहे हैं, लेकिन अभी हाल ही में इसे खोलने का फैसला किया गया है, और अपाचे 2.0 लाइसेंस के साथ इसका कोड GitHub पर पोस्ट किया गया है ।

इस लेख का उद्देश्य समुदाय का ध्यान इस ओर आकर्षित करना है।

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

रिपोर्ट में तथाकथित बैंड शामिल हैं। एक पट्टी डेटा सेट और टेम्पलेट में एक क्षेत्र है जहां यह डेटा प्रदर्शित होता है (डेटा परत और प्रस्तुति परत को जोड़ता है)।

आइए नमस्ते विश्व शैली में एक उदाहरण से शुरू करते हैं।

बहुत सरल उदाहरण है

कल्पना करें कि हमारे पास एक कंपनी है और हमें कंपनी के सभी कर्मचारियों की एक सूची प्रदर्शित करने की आवश्यकता है, जो कर्मचारी की स्थिति को दर्शाता है।

हम स्टाफ नाम की एक रिपोर्ट स्ट्रिप बनाते हैं, जिसमें हम संकेत देते हैं कि डेटा SQL क्वेरी द्वारा लोड किया गया है

select name, surname, position from staff

जावा कोड

 ReportBuilder reportBuilder = new ReportBuilder(); ReportTemplateBuilder reportTemplateBuilder = new ReportTemplateBuilder() .documentPath("/home/haulmont/templates/staff.xls") .documentName("staff.xls") .outputType(ReportOutputType.xls) .readFileFromPath(); reportBuilder.template(reportTemplateBuilder.build()); BandBuilder bandBuilder = new BandBuilder(); ReportBand staff= bandBuilder.name("Staff") .query("Staff", "select name, surname, position from staff", "sql") .build(); reportBuilder.band(staff); Report report = reportBuilder.build(); Reporting reporting = new Reporting(); reporting.setFormatterFactory(new DefaultFormatterFactory()); reporting.setLoaderFactory( new DefaultLoaderFactory().setSqlDataLoader(new SqlDataLoader(datasource))); ReportOutputDocument reportOutputDocument = reporting.runReport( new RunParams(report), new FileOutputStream("/home/haulmont/reports/staff.xls"));

अगला, हम एक xls- टेम्पलेट बनाते हैं जिसमें हम नामित क्षेत्र स्टाफ को चिह्नित करते हैं और कोशिकाओं में उपनाम की व्यवस्था करते हैं।

अधिक जटिल उदाहरण नीचे चर्चा कर रहे हैं।

थोड़ा इतिहास

कुछ साल पहले, हमें अपनी एक परियोजना में सामूहिक रिपोर्टिंग की आवश्यकता थी। एक्सएलएस और डीओसी प्रारूप में रिपोर्ट तैयार करना आवश्यक था, साथ ही परिणाम को डीओसी और एक्सएलएस से पीडीएफ में बदलना। हमें पुस्तकालय की आवश्यकता थी:

सामान्य उपयोगकर्ताओं के लिए रिपोर्ट (कम से कम रिपोर्ट टेम्पलेट) बनाने की अनुमति दी गई;
विभिन्न स्रोतों से समर्थित डाउनलोडिंग डेटा;
समर्थित विभिन्न टेम्पलेट प्रारूप (XLS, DOC, HTML);
पीडीएफ को रिपोर्ट करने में समर्थित;
यह एक्स्टेंसिबल था (इसने डेटा लोड करने और नए टेम्प्लेट प्रारूप के लिए नए तरीकों के त्वरित जोड़ की अनुमति दी);
आसानी से विभिन्न IoC कंटेनरों में एकीकृत।

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

इसलिए, हमने एक ऐसा तंत्र बनाने का फैसला किया, जो रिपोर्ट के एक समान विवरण के लिए अनुमति देता है, भले ही डेटा के टेम्प्लेट और विधि के प्रकार की परवाह किए बिना।

पहला कदम

XLS के साथ काम करने के लिए, पहले से ही कई अलग-अलग पुस्तकालय (POI-HSSF, JXLS, आदि) थे, और यह उस समय सबसे लोकप्रिय के रूप में Apache POI का उपयोग करने का निर्णय लिया गया था। लेकिन ऐसी विविधता के DOC फ़ाइलों के साथ काम करने के लिए मनाया नहीं गया था। बहुत कम विकल्प थे: ओपन ऑफिस सर्वर के साथ एकीकृत करने या COM ऑब्जेक्ट्स के माध्यम से DOC फ़ाइलों के साथ काम करने के लिए UNO रनटाइम - API का उपयोग करें। POI-HWPF परियोजना तब अपनी प्रारंभिक अवस्था में थी (यह अब तक नहीं चली है और अब)। हमने ओपन ऑफिस के साथ एकीकरण का उपयोग करने का निर्णय लिया, क्योंकि हमने उन लोगों से कई सकारात्मक समीक्षाएं देखीं, जिन्होंने ओपन ऑफिस को पूरी तरह से अलग-अलग भाषाओं (पायथन, रूबी, सी #) के साथ सफलतापूर्वक एकीकृत किया।

यदि POI-HSSF के साथ सब कुछ कम या ज्यादा सरल था (चार्ट के साथ काम करने की क्षमता की पूरी कमी को छोड़कर), तो UNO रनटाइम के साथ हमें कई समस्याओं का सामना करना पड़ा।

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

Docx4j

लंबे समय तक हमने केवल XLS और DOC टेम्प्लेट का उपयोग किया, लेकिन फिर XLSX और DOCX को भी समर्थन देने का निर्णय लिया गया। यह विकल्प DOCX4J लाइब्रेरी पर गिरा, जिसने उस समय तक लोकप्रियता हासिल कर ली थी।

हमारे लिए इस पुस्तकालय का एक महत्वपूर्ण लाभ यह है कि यह दस्तावेज़ की संरचना (वास्तव में एक्सएमएल के साथ काम कर रहा है) को निम्न-स्तरीय पहुंच प्रदान करता है। एक ओर, यह कुछ हद तक कोड और तर्क को जटिल करता है, और दूसरी तरफ, इसने दस्तावेज़ के प्रबंधन के लिए लगभग असीमित संभावनाएं खोल दीं, क्योंकि अब इस पर कोई भी संचालन संभव नहीं था।

एक और भी अधिक गंभीर लाभ ओपन ऑफिस की शुरूआत को छोड़ने के लिए DOCX रिपोर्ट तैयार करने की क्षमता थी।

अधिक जटिल उदाहरण

मान लीजिए हमारे पास एक किताबों की दुकान है। आइए एक रिपोर्ट बनाने के लिए अपने पुस्तकालय का उपयोग करने का प्रयास करें जो एक्सएलआर में स्टोर की सूची और प्रत्येक स्टोर में बेची गई पुस्तकों की सूची प्रदर्शित करता है।

कल्पना कीजिए कि हम (स्टोर के मालिक) जावा प्रोग्रामिंग भाषा को बिल्कुल नहीं जानते हैं, लेकिन सौभाग्य से, हमारा सिस्टम प्रशासक SQL से परिचित है, और हमारे पास एक डेटाबेस भी है जिसमें सभी बिक्री के बारे में जानकारी है।

सबसे पहले, आइए xls प्रारूप में एक रिपोर्ट टेम्पलेट बनाएं। नामित क्षेत्रों का उपयोग करके रिपोर्ट पट्टियों पर तुरंत ध्यान दें।

फिर हम SQL का उपयोग करके डेटा लोडिंग का वर्णन करते हैं।

 select shop.id as "id", shop.name as "name", shop.address as "address" from store shop select book.author as "author", book.name as "name", book.price as "price", count(*) as "count" from book book where book.store_id = ${Shop.id} group by book.author, book.name, book.price

अब हमें XML का उपयोग करके रिपोर्ट का वर्णन करना चाहिए।

 <?xml version="1.0" encoding="UTF-8"?> <report name="report"> <templates> <template code="DEFAULT" documentName="bookstore.xls" documentPath="./test/sample/bookstore/bookstore.xls" outputType="xls" outputNamePattern="bookstore.xls"/> </templates> <rootBand name="Root" orientation="H"> <bands> <band name="Header" orientation="H"/> <band name="Shop" orientation="H"> <bands> <band name="Book" orientation="H"> <queries> <query name="Book" type="sql"> <script> select book.author as "author", book.name as "name", book.price as "price", count(*) as "count" from book where book.store_id = ${Shop.id} group by book.author, book.name, book.price </script> </query> </queries> </band> </bands> <queries> <query name="Shop" type="sql"> <script> select shop.id as "id", shop.name as "name", shop.address as "address" from store shop </script> </query> </queries> </band> </bands> <queries/> </rootBand> </report>

कमांड लाइन से रिपोर्ट चलाने पर, हमें निम्नलिखित दस्तावेज मिलते हैं

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

एक और उदाहरण

अब कल्पना करें कि हमारे स्टोर को एक बड़ा ऑर्डर मिला है और हमें ग्राहक को चालान करना होगा। आइए एक रिपोर्ट बनाने की कोशिश करें जिसमें DOCX दस्तावेज़ को टेम्पलेट के रूप में उपयोग किया जाता है, और परिणाम पीडीएफ में परिवर्तित हो जाता है। हम ग्रूवी स्क्रिप्ट के साथ बदलाव के लिए डेटा लोड करने का वर्णन करेंगे।

 <?xml version="1.0" encoding="UTF-8"?> <report name="report"> <templates> <template code="DEFAULT" documentName="invoice.docx" documentPath="./test/sample/invoice/invoice.docx" outputType="pdf" outputNamePattern="invoice.pdf"/> </templates> <formats> <format name="Main.date" format="dd/MM/yyyy"/> <format name="Main.signature" format="${html}"/> </formats> <rootBand name="Root" orientation="H"> <bands> <band name="Main" orientation="H"> <queries> <query name="Main" type="groovy"> <script> return [ [ 'invoiceNumber':99987, 'client' : 'Google Inc.', 'date' : new Date(), 'addLine1': '1600 Amphitheatre Pkwy', 'addLine2': 'Mountain View, USA', 'addLine3':'CA 94043', 'signature':<![CDATA['<html><body><b><font color="red">Mr. Yarg</font></b></body></html>']]> ]] </script> </query> </queries> </band> <band name="Items" orientation="H"> <queries> <query name="Main" type="groovy"> <script> return [ ['name':'Java Concurrency in practice', 'price' : 15000], ['name':'Clear code', 'price' : 13000], ['name':'Scala in action', 'price' : 12000] ] </script> </query> </queries> </band> </bands> <queries/> </rootBand> </report>

आप देख सकते हैं कि ग्रूवी स्क्रिप्ट एक परिणाम के रूप में साहचर्य सरणियों की सूची लौटाती है (अधिक सटीक, सूची <मानचित्र <स्ट्रिंग, ऑब्जेक्ट> )। इस प्रकार, सूची का प्रत्येक तत्व नामित डेटा के साथ एक स्ट्रिंग है (कुंजी पैरामीटर का नाम है, मान पैरामीटर है)।

अब एक चालान टेम्पलेट बनाएं। ऊपर दी गई तालिका में हमने क्लाइंट का नाम और पता, साथ ही चालान की तारीख डाल दी।

अगला, उन उत्पादों की सूची के साथ एक तालिका बनाएं जिनके लिए आपको बिल दिया गया है। तालिका 2 के लिए माल की सूची से बंधे होने के लिए, हम पहले सेल में एक विशेष मार्कर (## बैंड = आइटम) सम्मिलित करेंगे।

रिपोर्ट चलाते हुए, हम निम्नलिखित देखेंगे।

एकीकरण और कार्यक्षमता का विस्तार

पुस्तकालय मूल रूप से विभिन्न अनुप्रयोगों में विस्तार और एकीकरण के लिए डिज़ाइन किया गया था। इस तरह के एकीकरण का एक उदाहरण CUBA मंच में YARG का उपयोग है। हम स्प्रिंग का उपयोग IoC ढांचे के रूप में करते हैं। आइए देखें कि वसंत में YARG को कैसे एम्बेड किया जा सकता है।

 <bean id="reporting_lib_Scripting" class="com.haulmont.reports.libintegration.ReportingScriptingImpl"/> <bean id="reporting_lib_GroovyDataLoader" class="com.haulmont.yarg.loaders.impl.GroovyDataLoader"> <constructor-arg ref="reporting_lib_Scripting"/> </bean> <bean id="reporting_lib_SqlDataLoader" class="com.haulmont.yarg.loaders.impl.SqlDataLoader"> <constructor-arg ref="dataSource"/> </bean> <bean id="reporting_lib_JpqlDataLoader" class="com.haulmont.reports.libintegration.JpqlDataDataLoader"/> <bean id="reporting_lib_OfficeIntegration" class="com.haulmont.reports.libintegration.CubaOfficeIntegration"> <constructor-arg value="${cuba.reporting.openoffice.path?:/}"/> <constructor-arg> <list> <value>8100</value> <value>8101</value> <value>8102</value> <value>8103</value> </list> </constructor-arg> <property name="displayDeviceAvailable"> <value>${cuba.reporting.displayDeviceAvailable?:false}</value> </property> <property name="timeoutInSeconds"> <value>${cuba.reporting.openoffice.docFormatterTimeout?:20}</value> </property> </bean> <bean id="reporting_lib_FormatterFactory" class="com.haulmont.yarg.formatters.factory.DefaultFormatterFactory"> <property name="officeIntegration" ref="reporting_lib_OfficeIntegration"/> </bean> <bean id="reporting_lib_LoaderFactory" class="com.haulmont.yarg.loaders.factory.DefaultLoaderFactory"> <property name="dataLoaders"> <map> <entry key="sql" value-ref="reporting_lib_SqlDataLoader"/> <entry key="groovy" value-ref="reporting_lib_GroovyDataLoader"/> <entry key="jpql" value-ref="reporting_lib_JpqlDataLoader"/> </map> </property> </bean> <bean id="reporting_lib_Reporting" class="com.haulmont.yarg.reporting.Reporting"> <property name="formatterFactory" ref="reporting_lib_FormatterFactory"/> <property name="loaderFactory" ref="reporting_lib_LoaderFactory"/> </bean>

इस विवरण में मुख्य बीन रिपोर्टिंग_लिब_रपोर्टिंग है। यह लाइब्रेरी की मुख्य कार्यक्षमता तक पहुँच प्रदान करता है - रिपोर्टिंग। सामान्य कामकाज के लिए, फॉर्मेटर्स की एक फैक्ट्री (विभिन्न प्रकार के दस्तावेजों के साथ काम करना - DOCX, XLSX, DOC, आदि) और लोडर (लोडिंग डेटा) की एक फैक्ट्री को परिभाषित करना आवश्यक है। इसके अलावा, यदि आप DOC रिपोर्ट का उपयोग करने का इरादा रखते हैं, तो आपको रिपोर्टिंग_lib_OfficeIntegration सेम सेट करना होगा, जो ओपन ऑफ़िस के साथ एकीकरण के लिए ज़िम्मेदार है (जिसके माध्यम से DOC और ODT रिपोर्ट संसाधित होती हैं)।

यह ध्यान दिया जाना चाहिए कि उदाहरण के लिए, एक नया लोडर, आपको किसी लाइब्रेरी लाइब्रेरी को फिर से परिभाषित करने की आवश्यकता नहीं है, बस इसे रिपोर्टिंग_lib_LoaderFactory सेम में डेटालेयर्स संपत्ति के विवरण में जोड़ें। जो हमने मूल रूप से एक jpql डेटा लोडर ( <प्रविष्टि कुंजी = "jpql" value-ref = "रिपोर्टिंग_lib_JpqlDataLoader" /> ) को जोड़कर किया था।

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

स्टैंडअलोन मोड

YARG लाइब्रेरी की एक और विशेषता यह है कि इसका उपयोग रिपोर्ट जनरेट करने के लिए एक स्टैंडअलोन एप्लिकेशन के रूप में किया जा सकता है। इस प्रकार, JRE आपके कंप्यूटर पर स्थापित होने के बाद, आप कमांड लाइन से रिपोर्ट उत्पन्न कर सकते हैं। उदाहरण के लिए, आपके पास PHP में एक सर्वर अनुप्रयोग है और आप XLS रिपोर्ट जनरेट करना चाहते हैं। आपको बस एक XLS टेम्पलेट बनाने की जरूरत है, रिपोर्ट का XML विवरण, और उसके बाद आप एक साधारण कंसोल कमांड का उपयोग करके रिपोर्ट उत्पन्न कर सकते हैं।

कमांड उदाहरण:

 yarg -rp ~/report.xml -op ~/result.xls “-Pparam1=20/04/2014”

निष्कर्ष

निष्कर्ष के रूप में, मैं यूआई के कुछ स्क्रीनशॉट दूंगा जो कि CUBA प्लेटफॉर्म YARG इंजन पर रिपोर्ट बनाने के लिए प्रदान करता है:

रिपोर्ट संपादक के टुकड़े

रिपोर्ट विज़ार्ड

और रेखांकन के साथ एक रिपोर्ट का एक उदाहरण:

चार्ट रिपोर्ट

ग्राफ और चार्ट के साथ रिपोर्ट टेम्पलेट:

ग्राफ और चार्ट के साथ तैयार रिपोर्ट

YARG - रिपोर्ट बनाने के लिए एक ओपन-सोर्स लाइब्रेरी