हम एनोटेटसक्कल के लिए अपना ग्रेडल प्लगइन लिखते हैं

प्रविष्टि

हाय साथियों! लंबे समय तक मैंने हैबर पर कुछ नहीं लिखा। इसलिए, मैंने इस कष्टप्रद गलतफहमी को ठीक करने का निर्णय लिया।

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

कार्य

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

आइए पहले इस बात पर विचार करें कि लाइब्रेरी में काम करने के लिए बिना प्लगइन के हम अपनी स्क्रिप्ट में क्या बदलाव करेंगे।

विन्यास

चूंकि हम अपने प्रोसेसर को कोड से लिंक नहीं करना चाहते हैं, हम एक अलग निर्भरता कॉन्फ़िगरेशन को परिभाषित करेंगे, हम इसे asqlapt कहेंगे।

configurations { asqlapt } 

और इसे कॉन्फ़िगर करें।

 dependencies { asqlapt fileTree(dir: 'libs.apt', include: '*.jar') } 

यहाँ हम कहते हैं कि हमारे asqlapt की निर्भरताएँ हमारी परियोजना के libs.apt फ़ोल्डर में हैं।

संकलन संशोधन

अगला कदम संकलक में कील लगाना और इसे हमारे प्रोसेसर पर इंगित करना है। आइए उस कोड को देखें जो ऐसा करता है:

 android.applicationVariants.all { variant -> def aptOutput = file("$buildDir/source/apt_generated/$variant.dirName") variant.javaCompile.doFirst { aptOutput.mkdirs() variant.javaCompile.options.compilerArgs += [ '-processorpath', configurations.asqlapt.getAsPath(), '-processor', 'com.annotatedsql.processor.provider.ProviderProcessor,com.annotatedsql.processor.sql.SQLProcessor', '-s', aptOutput ] } } 

इसलिए, Android एप्लिकेशन की असेंबली के प्रत्येक संस्करण के लिए, हम निम्न चरणों का पालन करते हैं:

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

सिद्धांत रूप में, यह वह सब है जिसकी हमें आवश्यकता है। लेकिन हम इसे एक प्लगइन के रूप में डिजाइन करना चाहते हैं, है ना?

प्लगइन निर्माण

जैसा कि दस्तावेज़ में लिखा गया है, हमारा प्लगइन रूट प्रोजेक्ट में buildSrc फ़ोल्डर में स्थित होना चाहिए। निम्नलिखित सामग्री के साथ इस डैडी और बिल्ड.ग्रेड बनाएं:

 apply plugin: 'groovy' dependencies { compile gradleApi() compile localGroovy() } 

अब हमारे प्लगइन को src / main / resource / META-INF / gradle-plugins / annotatedsql.properties फ़ाइल में निम्नानुसार घोषित करें:

 implementation-class=com.evilduck.annotatedsql.AnnotatedSqlPlugin 

दिनचर्या खत्म हो गई है, अब कोड के लिए। प्लगइन कोड Groovy में लिखा गया है।

चलो हमारी कक्षा बनाएँ:

 public class AnnotatedSqlPlugin implements Plugin<Project> { private Project project public void apply(Project project) { this.project = project } } 

यह वही है जो प्लगइन रिक्त जैसा दिखता है। हम लागू विधि में कार्यों को निष्पादित करना शुरू करते हैं।

पहली चीज जो हम चाहते हैं, वह निर्भरता कॉन्फ़िगरेशन को जोड़ना है:

 def setupDefaultAptConfigs() { project.configurations.create('apt').with { visible = false transitive = true description = 'The apt libraries to be used for annotated sql.' } project.configurations.create('annotatedsql').with { extendsFrom project.configurations.compile visible = false transitive = true description = 'The compile time libraries to be used for annotated sql.' } project.dependencies { apt project.fileTree(dir: "$project.projectDir/libs-apt", include: '*.jar') annotatedsql project.files("$project.projectDir/libs/sqlannotation-annotations.jar") } } 

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

अगला कदम संकलक को कॉन्फ़िगर करना है:

 def modifyJavaCompilerArguments() { project.android.applicationVariants.all { variant -> def aptOutput = project.file("$project.buildDir/source/$extension.aptOutputDir/$variant.dirName") variant.javaCompile.doFirst { aptOutput.mkdirs() variant.javaCompile.options.compilerArgs += [ '-processorpath', project.configurations.apt.getAsPath(), '-processor', 'com.annotatedsql.processor.provider.ProviderProcessor,com.annotatedsql.processor.sql.SQLProcessor', '-s', aptOutput ] } } } 

कुछ भी नया नहीं। लेकिन रुको, विस्तार क्या है। Gradle हमें प्लगइन्स बनाते समय ऑब्जेक्ट्स - एक्सटेंशन बनाने की अनुमति देता है। ये सरल POGO ऑब्जेक्ट हैं जो प्लगइन कॉन्फ़िगरेशन को स्टोर करते हैं। हमें Android डेवलपर्स के लिए निकटतम विस्तार Android है। हां, यह केवल Android ऑब्जेक्ट है जिसमें आप अपनी असेंबली कॉन्फ़िगर करते हैं। आइए देखें कि हमने अपने विस्तार की घोषणा कैसे की:

 class AnnotatedSqlExtension { public String aptOutputDir } 

और प्लगइन के लागू विधि में:

 extension = project.extensions.create("annotatedsql", AnnotatedSqlExtension) extension.with { aptOutputDir = "aptGenerated" } 

विस्तार को इनिशियलाइज़ करें और प्रोजेक्ट में संलग्न करें।

यहाँ, वास्तव में, पूरे प्लगइन है।



अब, देखते हैं कि हम इसका उपयोग कैसे करते हैं:

 buildscript { repositories { mavenCentral() } dependencies { classpath 'com.android.tools.build:gradle:0.6.+' } } apply plugin: 'android' apply plugin: 'annotatedsql' repositories { mavenCentral() } android { //     } /* *  ,    aptOutputDir */ //annotatedsql { // aptOutputDir = "customAptOutputDir" //} /* *  ,     */ //dependencies { // apt project.fileTree(dir: "${project.projectDir}/libszzz-apt", include: '*.jar') // annotatedsql project.files("${project.projectDir}/libszzz/sqlannotation-annotations.jar") //} 

जैसा कि आप देख सकते हैं, अगर हम पुस्तकालयों को सही जगह पर रखते हैं, तो हमें स्क्रिप्ट को जोड़ने की जरूरत है

 apply plugin: 'annotatedsql' 

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

 project.dependencies { apt 'com.hamsterksu.asql:something-version' annotatedsql 'com.hamstersku.asql:something-else-version' } 

इस मामले में, हमें बस इतना करना होगा कि प्लगइन को प्रोजेक्ट में जोड़ें (प्लगइन भी एंड्रॉइड प्लगइन के समान रिपॉजिटरी में हो सकता है) और इसे लागू करें:

 apply plugin: 'annotatedsql' 

समापन

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