मैक्रोग्रोवी - ग्रूवी के साथ एएसटी कभी भी आसान नहीं रहा है

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

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

def someVariable = new ConstantExpression("someValue"); def returnStatement = new ReturnStatement( new ConstructorCallExpression( ClassHelper.make(SomeCoolClass), new ArgumentListExpression(someVariable) ) ); 

दर्दनाक परिचित डिजाइन, है ना? क्या यह ऐसा होना चाहते हैं?

 def someVariable = macro { "someValue" } def returnStatement = macro { return new SomeCoolClass($v{ someVariable }) } 

या ऐसा भी?

 def constructorCall = macro { new SomeCoolClass($v{ macro { "someValue" } }) } 

यह लेख इस समस्या के मेरे समाधान पर चर्चा करेगा, जितना संभव हो सके ग्रूवी के मूल समाधान के करीब - github.com/bsideup/MacroGroovy

AstBuilder

Groovy 1.7 AstBuilder जैसी एक आश्चर्यजनक रूप से अद्भुत चीज लाया, जो हमें AST बनाने के 3 तरीके प्रदान करता है:

AstBuilder.buildFromString

हम कोड के साथ लाइन पास करते हैं, आउटपुट में हमारे पास एएसएनोडे की सूची है:

 List<ASTNode> nodes = new AstBuilder().buildFromString("\"Hello\"") 

लाभ

• इनपुट - स्ट्रिंग, कहीं से भी लिया जा सकता है;
• यह समझने की आवश्यकता नहीं है कि ASTNode-s की व्यवस्था कैसे की जाती है;
• आपको CompilePhase निर्दिष्ट करने की अनुमति देता है;
• लगभग 100% वैध कोड उत्पन्न करता है;
• विश्वसनीय - यदि Groovy में ASTNode-s की संरचना बदल गई है तो आपको अपने कोड में बदलाव की आवश्यकता नहीं है।

कमियों

• आईडीई आपको सिंटैक्स चेकिंग में मदद नहीं करेगा;
• आईडीई में रिफैक्टरिंग भी काम नहीं करेगा;
• कुछ संस्थाएँ नहीं बनाई जा सकतीं - उदाहरण के लिए, एक वर्ग क्षेत्र घोषित करना।

इन कमियों का हिस्सा निम्नलिखित विधि को सही करने का इरादा है।

AstBuilder.buildFromCode

हम कोड के साथ एक क्लोजर (उर्फ क्लोजर) पास करते हैं, आउटपुट पर हमारे पास नोड्स की एक सूची है:

 List<ASTNode> nodes = new AstBuilder().buildFromCode { "Hello" } 

लाभ (पिछली पद्धति के लाभों के अलावा)

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

नुकसान:

• यह विधि कई संस्थाओं को उत्पन्न करने में असमर्थता की समस्या को हल नहीं करती है;
• कोड संकलित करता है, जिसके कारण हमेशा मुश्किल निर्माण, या गैर-मौजूदा वर्ग का उपयोग करना संभव नहीं होता है;
• मेरे लिए मुख्य दोष: buildFromCode को कॉल करने के लिए आवश्यक है कि विधि को AstBuilder बनाकर बुलाया जाए:

   new AstBuilder().buildFromCode { ... } 

  
  उसी समय, आप AstBuilder को एक अलग क्षेत्र या स्थानीय चर में भी नहीं डाल सकते हैं (इसलिए, Groovy लेखकों को भी इस AstTransformation के लिए AstTransformation का सहारा लेना पड़ा था ताकि बहुत सारे कोड न लिखें)

उन लोगों के लिए जिनके पास दोनों तरीकों की कमी है, एक तीसरा तरीका है:

AstBuilder.buildFromSpec

यह विधि बंद हो जाती है (वैसे, आप मेरे अनुरोध के लिए वोट कर सकते हैं या पुल अनुरोध पर टिप्पणी कर सकते हैं ताकि इस पद्धति पर एक अच्छा DelegatesTo एनोटेशन दिखाई दे), जो एएसटी के निर्माण के लिए एक डीएसएल है:

 List<ASTNode> nodes = new AstBuilder().buildFromSpec { block { returnStatement { constant "Hello" } } } 

लाभ

• आपको नोड्स बनाने के लिए ग्रूवी तर्क का उपयोग करने की अनुमति देता है;
• लगभग किसी भी मौजूदा ASTNode के निर्माण की क्षमता प्रदान करता है;
• एक महत्वपूर्ण प्लस, के रूप में ग्रूवी की एएसटी पीढ़ी विषय अच्छी तरह से प्रलेखित नहीं है: पूरी तरह से प्रलेखित है और टेस्टकेस में व्यापक उपयोग के मामले हैं ।

कमियों

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

विधियों का संयोजन

यह भी उल्लेखनीय है कि आप इन विधियों को जोड़ सकते हैं:

 List<ASTNode> result = new AstBuilder().buildFromSpec { method('myMethod', Opcodes.ACC_PUBLIC, String) { parameters { parameter 'parameter': String.class } exceptions {} block { owner.expression.addAll new AstBuilder().buildFromCode { println 'Hello from a synthesized method!' println "Parameter value: $parameter" } } annotations {} } } 

MacroGroovy

तो, संभावनाओं की इतनी व्यापक समीक्षा के बाद, आप पूछ सकते हैं: तो ... * अहम * ... अंजीर MacroGroovy की आवश्यकता है?

पोस्ट हेडर से उदाहरण पर विचार करें:

 def someVariable = new ConstantExpression("someValue"); def returnStatement = new ReturnStatement( new ConstructorCallExpression( ClassHelper.make(SomeCoolClass), new ArgumentListExpression(someVariable) ) ); 

देखें तर्क सूची निर्माता को दिए गए कुछ वैरिएबल देखें? मेरा विश्वास करो, यह स्थिति बहुत, बहुत आम है। और वह तुरंत buildFromCode और buildFromString स्वीप करती है। तो केवल buildFromSpec बनी हुई है, लेकिन क्या आपको इसकी कमियों की सूची याद है? यह वह जगह है जहाँ मैक्रोग्रोवी बचाव के लिए आता है:

 def someVariable = macro { "someValue" }; def returnStatement = macro { return new SomeCoolClass($v{ someVariable }) } 

लाभ

• पहली और दूसरी विधि के सभी फायदे;
• इसके लिए किसी ऑब्जेक्ट के निर्माण की आवश्यकता नहीं होती है जिसके विरुद्ध मैक्रो विधि कहा जाता है - यह एक्सटेंशन विधि के रूप में सभी वर्गों में उपलब्ध है
• आंतरिक रूप से AstBuilder से पुन: उपयोग कोड, इसलिए विधि विश्वसनीय और परीक्षण की जाती है;
• आपको कोड के अंदर ग्रूवी तर्क का उपयोग करने की अनुमति देता है, जैसा कि $ v एक बंद को स्वीकार करता है, जिसे अपनी कॉल के स्थान पर वापस आने की आवश्यकता होती है;
• बहुत, बहुत कॉम्पैक्ट :) तुलना करें:

   macro { return mySuperVariable } 

  और

   (new AstBuilder()).buildFromCode { return mySuperVariable }.first().expressions.first() 

कमियों

• दुर्भाग्य से, आपने मैक्रो {} का उपयोग करके एक वर्ग फ़ील्ड नहीं बनाया;
• CompilePhase की कोई संभावना नहीं है;

वैसे, आप अभी भी buildFromSpec और मैक्रो को जोड़ सकते हैं:

 List<ASTNode> result = new AstBuilder().buildFromSpec { method('myMethod', Opcodes.ACC_PUBLIC, String) { parameters { parameter 'parameter': String.class } exceptions {} block { owner.expression.addAll macro { println 'Hello from a synthesized method!' println "Parameter value: $parameter" } } annotations {} } } 

मैं परीक्षण के लिए एक लिंक छोड़ दूंगा, जिसमें दिखाया गया है कि मैक्रोग्रोवी कैसे कई बार कोड की मात्रा कम करता है:
github.com/bsideup/MacroGroovy/blob/master/example/basicExample/src/test/groovy/ru/trylogic/groovy/macro/examples/basic/BasicTest.groovy

निष्कर्ष

विधियों में से प्रत्येक के पास इसके पेशेवरों और विपक्ष हैं, और मैंने अभी अन्य तरीकों के नुकसानों को दूर करने की कोशिश की है। आपके पुल अनुरोधों के परीक्षण में मदद के लिए मैं आभारी रहूंगा।

लाइब्रेरी मावेन सेंट्रल में उपलब्ध है, मैं एक लिंक छोड़ दूंगा जहां आप हमेशा नवीनतम संस्करण पा सकते हैं:
search.maven.org/#search%7Cga%7C1%7Cmacro-groovy

आपका धन्यवाद