Google से COFOJA पुस्तकालय का उपयोग करके जावा में अनुबंध प्रोग्रामिंग

किसलिए प्रयोग किया जाता है

यह तकनीक क्लास मेथड्स, यूजर फंक्शन्स को करते समय पूर्व शर्त और पोस्टकंडिशन का सत्यापन प्रदान करती है।



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



मुखरता के विपरीत, चेक रनटाइम में किए जाते हैं, अर्थात्, सीधे प्रोग्राम निष्पादन के दौरान और रिलीज़ संस्करण में मौजूद होते हैं।



विधि का सार यह है कि प्रत्येक उपप्रोग्राम के साथ, जैसा कि यह था, एक "अनुबंध" कुछ कार्यों के प्रदर्शन के लिए संपन्न होता है, अर्थात। यह इनपुट और आउटपुट डेटा की सीमा पर प्रतिबंध (शर्तें) लगाता है। इसके अलावा, "अनुबंध" (शर्तों) के कार्यान्वयन को कसकर नियंत्रित किया जाता है।

उदाहरण

कुछ क्लास टाइम है। मान लीजिए कि यह अभिलेखीय है, और पूरे ब्रह्मांड का कामकाज उसके काम पर निर्भर करता है ...



वर्ग में विधियाँ हैं: getHours (), getMinutes (), getSeconds () और setHours (), setMinutes (), setSeconds (), क्रमशः।



हम इसका वर्णन करते हैं (भाषा निर्माण और तंत्र का एक भाग, या संक्षिप्तता के लिए सरलीकृत)

class Time<br>{<br> intHOURS;<br> intMINUTES;<br> intSECONDS;<br><br> getHours();<br> {<br> returnHOURS;<br> }<br> <br> getMinutes();<br> {<br> return MINUTES;<br> }<br><br> getSeconds()<br> {<br> return SECONDS;<br> }<br><br> setHours(newHOURS);<br> {<br> HOURS = newHOURS;<br> }<br><br> setMinutes(newMINUTES);<br> {<br> MINUTES = newMINUTES;<br> }<br><br> setSeconds(newSECONDS)<br> {<br> SECONDS = newSECONDS;<br> }<br>}<br> <br> * This source code was highlighted with Source Code Highlighter .

यह सुनिश्चित करना आवश्यक है कि यह वर्ग सही डेटा लौटाएगा, या बिल्कुल काम नहीं करेगा (सिद्धांत के आधार पर "मृत कार्यक्रम झूठ नहीं बोलते हैं")।



यह कैसे किया जा सकता है? शुद्धता के लिए डेटा की जाँच करना।

तरीका 1: सामूहिक फार्म

संक्षिप्तता के लिए, हम टाइम क्लास के कुछ विवरण और दोहराए गए निर्माणों को छोड़ देते हैं।

class Time<br>{<br> getHours();<br> {<br> if (HOURS<0 ||HOURS>23) <br> throw GREAT_Time_Exception ;<br><br> return HOURS;<br> }<br><br> setHours(newHOURS);<br> {<br> if (newHOURS<0 ||newHOURS>23) <br> throw GREAT_Time_Exception ;<br><br> HOURS = newHOURS;<br> }<br>} <br><br> * This source code was highlighted with Source Code Highlighter .

नुकसान: सत्यापन की गैर-स्पष्टता। मैन्युअल रूप से कोड का एक गुच्छा लिखने की आवश्यकता है। अभी-अभी, हमने एक अनुबंध प्रोग्रामिंग तकनीक को लागू करने का प्रयास किया। लेकिन, यह PROVAAAAAAL है! क्यों? हम आगे देखते हैं।

रास्ता 2: हम तैयार-किए गए, सुरुचिपूर्ण समाधान का उपयोग करते हैं।

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



जिसका उपयोग कई Google कर्मचारियों (डेविड मॉर्गन, एंड्रियास लिटनर, नट मिन्ह ले - "जावा 20% टीम के लिए अनुबंध) द्वारा किया गया था। अपने खाली समय में, उन्होंने COFOJA एनोटेशन प्रीप्रोसेसर लाइब्रेरी विकसित की, जो जावा में अनुबंधित प्रोग्रामिंग पद्धति को लागू करने की अनुमति देती है।



आइए हमारे समय वर्ग के लिए इसका उपयोग करने का प्रयास करें:

@Contracted // , – IDE <br> class Time<br>{<br> @Ensures ({“result >= 0”,“result <= 23” })<br> getHours();<br> {<br> return HOURS;<br> }<br><br> @Requires ({“newHOURS>= 0”,“newHOURS<= 23” })<br> @Ensures (“HOURS == newHOURS”)<br> // <br> // @Ensures (“getHours()== newHOURS”) <br> setHours(newHOURS);<br> {<br> HOURS = newHOURS;<br> }<br>} <br><br> * This source code was highlighted with Source Code Highlighter .

@Requires - शाब्दिक अर्थ है, "सुनिश्चित करें कि पहले से सबरूटीन निष्पादित किया गया है (" शर्त पूरी हो गई है ")" अन्यथा, एक अपवाद फेंक दें।



@Ensures - का शाब्दिक अर्थ है, "सुनिश्चित करें कि उपप्रोग्राम के बाद निष्पादित किया जाता है (" स्थिति संतुष्ट है ")"



यहाँ हम देखते हैं कि, Path1 में , हमारे तरीकों के लिए पूर्व- स्थितियाँ और पोस्ट-स्थितियाँ जाँची गई हैं। अंतर क्या है? अंतर यह है कि दूसरे मामले में यह अधिक दृश्य और सुविधाजनक है।



इन दो विकल्पों के अलावा, काफी बड़ी संख्या में पुस्तकालय और उपकरण हैं जो आपको JAVA में इस तकनीक का उपयोग करने की अनुमति देते हैं, लेकिन वे या तो पुराने हैं और समर्थित नहीं हैं / विकसित नहीं हैं, या उपयोग करने के लिए सुविधाजनक नहीं हैं।

क्या पुस्तकालय के होते हैं।

com.google.java.contract। * - COFOJA पुस्तकालय का मुख्य नामस्थान।



इसमें निम्नलिखित एनोटेशन का कार्यान्वयन शामिल है:





@Contracted - IDE के लिए एक संकेत, कहता है कि वर्ग अनुबंधों का उपयोग करता है।



@ इंवरियंट - इनवेरिएंट्स एक वर्ग के वैश्विक गुणों को परिभाषित करते हैं जो पूरे जीवन में इसके निर्माण के बाद सम्मानित होना चाहिए।



@Requires - पूर्वनिर्धारण को परिभाषित करता है - एक विधि या फ़ंक्शन में प्रवेश करने के लिए सही होना चाहिए।



@Ensures - पोस्टकंडिशन को परिभाषित करता है - एक विधि या फ़ंक्शन से बाहर निकलने के बाद क्या सही होना चाहिए।



@ThrowEnsures - आपको पोस्टकॉन्डिशन चेक करते समय एक निर्दिष्ट अपवाद को फेंकने की अनुमति देता है।

क्या देखना है

@Ensures और @Rireires प्रत्येक विधि में केवल एक हो सकता है। यदि आपको कई शर्तों की जाँच करने की आवश्यकता है, तो {} में स्थिति रिकॉर्ड का उपयोग करें:

@Ensures ( { “1”, “ … ”, “N” } )<br><br>@Requires ( { “1”, “ … ”, “N” } )<br> <br> * This source code was highlighted with Source Code Highlighter .

यदि अनुबंध नहीं देखा गया है (आवश्यक शर्तों का उल्लंघन), तो पुस्तकालय एक पूर्व- अपवाद अपवाद को फेंक देता है - एक पूर्व शर्त त्रुटि जिसे पकड़ा और संसाधित किया जा सकता है।



पोस्टकॉन्डिशन की जाँच करते समय अपने स्वयं के अपवाद उत्पन्न करना भी संभव है।

ऐसा करने के लिए, @ThrowEnsures एनोटेशन का उपयोग करें। इसका सिंटैक्स है:

@ThrowEnsures ({ "" , "" })<br><br>@ThrowEnsures ({<br> "1" , "1" ,<br> ...<br> "N" , "N" ,<br> }) <br><br> * This source code was highlighted with Source Code Highlighter .

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

स्वचालित अनुबंध प्रबंधन के लिए IDE कॉन्फ़िगर करना।

ग्रहण *

तैयारी:

1. किसी भी उपलब्ध तरीके से डाउनलोड करें / निकालें (स्रोत कोड से संकलन तक) cofoja.jar पैकेज।
2. ग्रहण आईडीई चलाएं, एक नया प्रोजेक्ट बनाएं।
3. Cofoja.jar फ़ाइल को प्रोजेक्ट रूट फ़ोल्डर में कॉपी करें।

अब प्रोजेक्ट को कॉन्फ़िगर करना शुरू करते हैं:

1. प्रोजेक्ट -> गुण- > जावा बिल्ड पाथ , लाइब्रेरी टैब -> JARs जोड़ें , जो विंडो दिखाई देती है, उसमें हमारी cofoja.jar फ़ाइल चुनें
2. इस बिंदु पर, ग्रहण आईडीई अनुबंध एनोटेशन को पहचानना शुरू कर देगा। लेकिन यह सब नहीं है। हमें ग्रहण आईडीई को इंगित करने की आवश्यकता है कि हमारी परियोजना को संकलित करते समय, हमें बाहरी एनोटेशन प्रीप्रोसेसर का उपयोग करना होगा।
   
   
   
   ऐसा करने के लिए: प्रोजेक्ट मेनू पर जाएं प्रोजेक्ट -> गुण-> जावा कंपाइलर-> एनोटेशन प्रोसेसिंग , सभी चेकमार्क डालें, दो कीज़ (प्रोसेसर ऑप्शंस) जोड़ें (कुंजी)
   
   
   
   com.google.java.contract.classpath - उपयोगकर्ता एनोटेशन प्रोसेसर के साथ फ़ाइल का पूर्ण पथ - cofoja.jar ।
   
   com.google.java.contract.classoutput - फ़ोल्डर का वह पूर्ण पथ जिसमें सभी प्रोजेक्ट कक्षाएं संकलित की जाती हैं ( बिन फ़ोल्डर)।
   
   
   
   एक उदाहरण :
   
   
   
   com.google.java.contract.classpath = C: \ java \ eclipseWorkspace \ JavaContractsTest \ ccofoja.jar
   
   com.google.java.contract.classoutput = C: \ java \ eclipseWorkspace \ JavaContractsTest \ bin
   
   
   
   फ़ैक्टरी पथ उपश्रेणी में, प्रोजेक्ट विशिष्ट सेटिंग सक्षम करें चेकबॉक्स की जाँच करें , फिर - जार जोड़ें -> हमारे cofoja.jar एनोटेशन प्रोसेसर का चयन करें।
3. उसके बाद, परियोजना को संकलित करते समय, बाहरी एनोटेशन प्रोसेसर जिसे हम अभी कॉन्फ़िगर करते हैं, का उपयोग किया जाना चाहिए। लेकिन यह सब नहीं है।
4. यह हमारे कोड को अनुबंधों के सत्यापन के साथ चलाने के लिए वर्चुअल मशीन के एक पैरामीटर को जोड़ने के लिए बना हुआ है। ऐसा करने के लिए, रन कॉन्फ़िगरेशन में -> तर्क, VM तर्क फ़ील्ड में, निर्दिष्ट करें: -javaagent: cofoja.jar
5. प्रारूप:
6. ( -जवागेंट: <अनुबंध_कार्य_फाइल_नाम> .जर )
7. हो गया। आप कोड लिखना शुरू कर सकते हैं। उसके बाद, परियोजना को संकलित करते समय, अनुबंध के एनोटेशन में त्रुटियों को सीधे आईडीई में जारी किया जाएगा।

नेटबीन्स * **

1. किसी भी उपलब्ध तरीके से डाउनलोड करें / निकालें (स्रोत कोड से संकलन तक) cofoja.jar पैकेज।



2. नेटबीन्स आईडीई चलाएं, एक नया प्रोजेक्ट बनाएं।



3. cofoja.jar फ़ाइल को प्रोजेक्ट रूट फ़ोल्डर में कॉपी करें।



4. अब हम प्रोजेक्ट को कॉन्फ़िगर करना शुरू करते हैं।



एक। परियोजना -> गुण-> पुस्तकालय



कंपाइलर , प्रोसेसर में, रन टैब हमारी cofoja.jar फ़ाइल जोड़ें ( JARs बटन जोड़ें )



ख। निर्माण पर जाएं -> संकलन



एनोटेशन प्रोसेसिंग सक्षम करें, एनोटेशन प्रोसेसिंग सक्षम करने के लिए बक्से की जाँच करें, फिर एड बटन पर क्लिक करें और निम्नलिखित लाइन जोड़ें: com.google.java.contract.classpath



सी। रन टैब पर जाएं

VM विकल्पों में, जोड़ें: -Javaagent: cofoja.jar (हमारे अनुबंध हैंडलर फ़ाइल का नाम)

प्रारूप:

( -जवागेंट: <अनुबंध_कार्य_फाइल_नाम> .जर )



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

जावैक - एनोटेशन के साथ मैन्युअल रूप से संकलन

1. किसी भी उपलब्ध तरीके से डाउनलोड करें / निकालें (स्रोत कोड से संकलन तक) cofoja.jar पैकेज।



2. हमने cofoja.jar फ़ाइल को उन फोल्डर के साथ एक फोल्डर में रखा है, जिन्हें हम कंपाइल करने जा रहे हैं, या, इसके लिए पूर्ण पथ को इंगित करते हैं।



3. कमांड प्रॉम्प्ट पर, टाइप करें: javac -cp cofoja.jar MyClass.java



हम संकलन करते हैं। हम त्रुटि संदेशों का विश्लेषण करते हैं, यदि कोई हो, सही, फिर से संकलित करें।



-Cp संकलक स्विच आपको एनोटेशन प्रीप्रोसेसर को निर्दिष्ट करने की अनुमति देता है। आपके प्रोग्राम कक्षाओं की फ़ाइल नाम निम्नलिखित हैं।



वाक्य विन्यास यह है:

javac -cp <file_name एनोटेशन_प्रोसेसर के साथ> <Class1.java> <ClassN.java>





* नोट: यदि, ऐसा करने के बाद, आप यह कहते हुए एक त्रुटि संदेश भरते हैं कि एक कंपाइलर ( JavaBuilder ) को ढूंढना असंभव है, निर्देशिका को JATAC कंपाइलर (JDK \ bin) के साथ PATH सर्वर चर में जोड़ें। परिवर्तन को प्रभावी करने के लिए, इस चर को संशोधित करने के बाद, रिबूट करना आवश्यक है ( विंडोज 2k / XP के लिए, विंडोज 7 को इसकी आवश्यकता नहीं है। लिनक्स में , आपको फिर से लॉगिन करना पड़ सकता है - उपयोग किए गए शेल के आधार पर)।



** नोट: यदि आपके NetBeans में ऐसे मेनू आइटम नहीं हैं, तो आप पुराने संस्करण का उपयोग कर सकते हैं। NetBeans 6.9 निश्चित रूप से एनोटेशन का समर्थन करता है - डाउनलोड करें और इसका उपयोग करें।

संदर्भ

• [०] डिपॉज़िटाइल्स.com/files/eoh5i634s cofoja.jar एनोटेशन प्रोसेसर फ़ाइल है जिसका मैंने उपयोग किया था।
• [१] कोड.google.com/p/cofoja Google कोड पर आधिकारिक COFOJA प्रोजेक्ट पेज है।
• [२] http://www.huoc.org/~minh/cofoja/ - यहाँ आप संकलित COFOJA पैकेज ले सकते हैं
• [३] en.wikipedia.org/wiki/Contract_Programming - विकिपीडिया पृष्ठ
• [४] fsteeg.com/2011/02/07/setting-up-contracts-for-java-in-eclipse - अनुबंध के साथ काम करने के लिए ग्रहण आईडीई स्थापित करने पर अंग्रेजी में फेबियन स्टिग आलेख। विवरण काम कर रहा है। लेकिन! याद रखें कि आपको अपने JDK के बिन फ़ोल्डर में पथ को वैरिएबल में जोड़ना होगा।