एक्सटेंशन बनाने के लिए SPI इंजन का उपयोग करना

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

उस अंतिम एप्लिकेशन में, जिसके साथ मैंने काम किया था, उस समय मेरे लिए एक एसपीआई बाइक तंत्र लागू किया गया था, जो META-INF / सेवाओं / <योग्य इंटरफ़ेस नाम> के लिए पाठ फ़ाइलों में दिखता था और आवश्यक वर्ग का नाम लेता था जो इस इंटरफ़ेस को वहां से लागू करता है, फिर इस वर्ग का उपयोग विस्तार के रूप में किया जाता था। इंटरनेट पर खोज करने के बाद, मुझे पता चला कि सर्विस प्रोवाइडर इंटरफेस (SPI) प्लग-इन कंपोनेंट्स को सपोर्ट करने के लिए एक सॉफ्टवेयर मैकेनिज्म है और जावा रनटाइम एनवायरनमेंट (JRE) में इस मैकेनिज्म का उपयोग काफी समय से किया जा रहा है, उदाहरण के लिए, जावा डाटाबेस डाटाबेस (JDBC) में :

ps = Service.providers(java.sql.Driver.class); try { while (ps.hasNext()) { ps.next(); } } catch (Throwable t) { // Do nothing } 

इस कोड के लिए धन्यवाद, अनुप्रयोगों को अब Class.forName (<ड्राइवर वर्ग>) के निर्माण की आवश्यकता नहीं है (हालांकि वे इसके साथ काम करेंगे), JDBC ड्राइवर पहली बार स्वचालित रूप से लोड किए जाएंगे जब वे DriverManager वर्ग के तरीकों का उपयोग करते हैं।

SPI तंत्र का उपयोग जावा क्रिप्टोग्राफी एक्सटेंशन (JCE) , जावा नामकरण और निर्देशिका सेवा (JNDI) , XML प्रसंस्करण के लिए जावा एपीआई (JAXP) , जावा व्यापार एकीकरण (JBI) , जावा ध्वनि, जावा छवि I / O में भी किया जाता है।

यह कैसे काम करता है?

पूरे बिंदु सेवा (सेवा) और प्रदाताओं (सेवा प्रदाताओं) में तर्क का अलगाव है। प्रदाताओं के लिंक एक पाठ फ़ाइल (UTF-8) META-INF / सेवाओं / <योग्य सेवा वर्ग> में विस्तार जार में संग्रहीत किए जाते हैं, प्रत्येक पंक्ति में प्रदाता वर्ग का पूरा नाम है। रिक्त लाइनों और टिप्पणियों (# चरित्र के साथ शुरू) को अनदेखा किया जाता है। प्रदाताओं पर प्रतिबंध: उन्हें सेवा वर्ग से इंटरफ़ेस या विरासत को लागू करना चाहिए और एक डिफ़ॉल्ट निर्माता (शून्य-तर्क सार्वजनिक निर्माणकर्ता) होना चाहिए।

प्रदाताओं की सूची प्राप्त करने के लिए मुख्य एप्लिकेशन java.util.ServiceLoader उपयोगिता का उपयोग कर सकते हैं, जो जावा एसई 6 एपीआई का हिस्सा है, जो निम्नलिखित सिद्धांत के अनुसार काम करता है:


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

जावा एसई के पहले के संस्करणों में एक समान उपयोगिता है, sun.misc.Service , जो एक ही सिद्धांत पर काम करता है, लेकिन सन ओरेकल के मालिकाना सॉफ्टवेयर का हिस्सा है और भविष्य के जावा एसई रिलीज में हटाया जा सकता है।

उदाहरण का उपयोग करें

उदाहरण के लिए, हमारे पास एक प्रोग्राम है जो कंप्यूटर पर संगीत की खोज करता है और स्क्रीन पर नाम द्वारा छाँटे गए परिणाम को प्रदर्शित करता है।

 public class MusicFinder { public static List<String> getMusic() { //some code } } public class ReportRenderer { public void generateReport() { final List<String> music = findMusic(); for (String composition : music) { System.out.println(composition); } } public List<String> findMusic() { final List<String> music = MusicFinder.getMusic(); Collections.sort(music); return music; } public static ReportRenderer getInstance() { return new ReportRenderer(); } public static void main(final String[] args) { final ReportRenderer renderer = ReportRenderer.getInstance(); renderer.generateReport(); } } 

किसी समय में, हमने समाज के लिए इस कार्यक्रम के पूर्ण महत्व को महसूस किया और इसे अपने दोस्तों के साथ साझा करने का निर्णय लिया। दोस्तों ने सेवा का उपयोग किया और तय किया कि कुछ गायब था। एक अलग फ़ाइल के लिए उत्पादन कर सकते हैं? लेकिन फिर आपको इस सभी शांत कोड को फिर से लिखना होगा। कोई ज़रूरत नहीं है, आप एसपीआई तंत्र का उपयोग कर सकते हैं।

उदाहरण के लिए, हमारे सुपर प्रोग्राम के लिए एक प्लगइन बनाएं:

 public class FileReportRenderer extends ReportRenderer { @Override public void generateReport() { final List<String> music = findMusic(); try { final FileWriter writer = new FileWriter("music.txt"); for (String composition : music) { writer.append(composition); writer.append("\n"); } writer.flush(); } catch (IOException e) { e.printStackTrace(); } } } 

मेटा- इन / सेवाओं / com.example.ReportRenderer में निम्नलिखित डालें :

 com.example.FileReportRenderer

स्रोत प्रोग्राम को एक्स्टेंसिबल बनाते हैं:

 public class ReportRenderer { //... public static ReportRenderer getInstance() { final Iterator<ReportRenderer> providers = ServiceLoader.load(ReportRenderer.class).iterator(); if (providers.hasNext()) { return providers.next(); } return new ReportRenderer(); } //... } 

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

अब MusicFinder के साथ खेलने का समय है। चलिए इसे भी एक्स्टेंसिबल बनाते हैं। ऐसा करने के लिए, क्लास को इंटरफ़ेस में बदलें:

 public interface MusicFinder { List<String> getMusic(); } 

मुख्य मॉड्यूल में कार्यान्वयन जोड़ें:

 public class DummyMusicFinder implements MusicFinder { public List<String> getMusic() { return Collections.singletonList("From DummyMusicFinder..."); } } 

ReportRenderer में एक्सटेंशन का समर्थन:

 public class ReportRenderer { //... public List<String> findMusic() { final List<String> music = new ArrayList<String>(); for (final MusicFinder finder : ServiceLoader.load(MusicFinder.class)) { music.addAll(finder.getMusic()); } Collections.sort(music); return music; } //... } 

ReportRenderer के मामले में , टेक्स्ट फ़ाइल META-INF / सेवाएं / com.example.MusicFinder जोड़ें , जिसमें शामिल हैं:

 com.example.DummyMusicFinder

फिर से, पहले कार्यक्रम का परिणाम नहीं बदला है। अब विस्तार। यहां हम MusicFinder के दो कार्यान्वयन करेंगे :

 public class ExtendedMusicFinder implements MusicFinder { public List<String> getMusic() { return Collections.singletonList("From ExtendedMusicFinder..."); } } public class MyMusicFinder implements MusicFinder { public List<String> getMusic() { return Collections.singletonList("From MyMusicFinder..."); } } 

मेटा- INF / सेवा / com.example.MusicFinder :

 com.example.MyMusicFinder
 com.example.ExtendedMusicFinder

खैर, यह सब, एक्सटेंशन का समर्थन करने वाला कार्यक्रम तैयार है, अब क्लासपाथ में एक्सटेंशन के साथ, यह सूची देगा:

 DummyMusicFinder से ...
 ExtendedMusicFinder से ...
 MyMusicFinder से ...

नमूना स्रोत यहां देखे जा सकते हैं ।

निष्कर्ष

उपरोक्त उदाहरण एकदम सही है, और मैं दुनिया के सबसे अच्छे संगीत खोज इंजन के लेखक होने का दिखावा नहीं करता। मैं इस तंत्र के कट्टरपंथी उपयोग के लिए भी फोन नहीं करता हूं, क्योंकि यह हर जगह लागू नहीं है, और मैं एक IoC कंटेनर के उपयोग को अधिक सुंदर समाधान मानता हूं, लेकिन फिर भी यह दृष्टिकोण कुछ स्थानों पर उपयोगी हो सकता है। लेख पढ़ने के लिए समय निकालने के लिए धन्यवाद।

साहित्य

प्लगइन
सेवा प्रदाता इंटरफ़ेस
सेवा प्रदाता
सेवा प्रदाता इंटरफ़ेस: एक्स्टेंसिबल जावा एप्लिकेशन बनाना
सेवा भार करनेवाला