🐼 🛅 👏🏼 JIRA और प्लगइन्स के साथ संगम अनुकूलन ☝️ 🌪️ 📭

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

मैं Mail.Ru Group में JIRA / Confluence डेवलपर के रूप में काम करता हूं, और मैं JIRA और Confluence plugins लिखने में अपना अनुभव साझा करना चाहता हूं: आप क्या कर सकते हैं, इसे कैसे कर सकते हैं, और आपको क्या याद रखना चाहिए।

मैं क्या बताऊंगा

यहां विभिन्न घटकों के विकास पर कई पोस्ट प्रकाशित किए जाएंगे। प्लगइन्स और सोर्स कोड यहां देखे जा सकते हैं ।

प्लगइन्स का विवरण शामिल होगा:

उपयोगकर्ता फ़ील्ड (कस्टम फ़ील्ड), ईवेंट हैंडलर (श्रोता);
सर्वलेट्स और रीस्ट, वर्कफ़्लो प्रोग्रामिंग।

इस लेख में, मैं काम करने वाले प्लगइन्स पर टिप्पणी करूंगा, जिसका स्रोत कोड यहां पाया जा सकता है । स्रोत कोड शुरू करने के लिए, बस लेख पढ़ें।

कस्टम फ़ील्ड्स

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

पहला प्लगइन (क्वेरी इश्यू कस्टम फील्ड्स) एक सूची है जिसके मान उन मुद्दों की कुंजी हैं जिन्हें कॉन्फ़िगर खोज क्वेरी (JQL) से चुना गया है। सूची का मूल्य आवश्यकताओं की संख्या (इश्यू कीज़) है।

इस प्रकार, हर बार जब आप संपादित करते हैं और फ़ील्ड देखते हैं, तो मान स्वतः ही अपडेट हो जाते हैं। तैयार प्लगइन यहाँ है ।

इसलिए, हम एक प्लगइन विकसित करना चाहते हैं जिसका उपयोग विभिन्न परियोजनाओं के लिए किया जा सकता है, इसका उपयोग करना आसान है, और यह जिरा के सभी संस्करणों पर काम करता है।

पहली आवश्यकता को लागू करने के लिए, हमें प्लग-इन के एक डेटा वेयरहाउस का आयोजन करना चाहिए, जहां हम क्वेरी (JQL) और कस्टम क्षेत्र के विकसित होने के लिए अन्य सेटिंग्स को बचा सकते हैं। खोज क्वेरी (JQL) को संग्रहीत करने के लिए, प्लगइन्स (com.atlassian.sal.api.pluginsettings.PluginSettings) के लिए डेटा कंटेनर का उपयोग करना उचित है। यह ध्यान दिया जाना चाहिए कि इस विकल्प के साथ हमें प्लगइन के पोर्टेबिलिटी के साथ JIRA के अन्य संस्करणों में कोई समस्या नहीं होगी। इसके अलावा, यदि आप किसी ऑब्जेक्ट को स्ट्रिंग के रूप में दर्शाने के लिए जावा ऑब्जेक्ट्स (उदाहरण के लिए, XStream ) की क्रमबद्धता लाइब्रेरी का उपयोग करते हैं, तो हम किसी भी संरचना के डेटा को स्टोर कर सकते हैं। रिपॉजिटरी का उपयोग करने के लिए, आपको एटलसियन- plugin.xml प्लगइन कॉन्फ़िगरेशन फ़ाइल में निम्न पंक्तियाँ जोड़ना होगा:

<!-- Plugin data manager --> <component key="queryfields-config" name="Query issues custom fields plugin configuration" class="ru.mail.jira.plugins.lf.QueryFieldsMgrImpl"/> <!-- Components which required for injection --> <component-import key="pluginSettingsFactory"> <interface>com.atlassian.sal.api.pluginsettings.PluginSettingsFactory</interface> </component-import>

और आवश्यक जोड़तोड़ करने वाले इंटरफ़ेस का भी निर्धारण करें,

इंटरफ़ेस स्रोत कोड

 public interface QueryFieldsMgr { /** * Get "add null" option. */ boolean getAddNull(long cfId, long projId); /** * Get stored data for the custom field. */ String getQueryFieldData(long cfId, long projId); /** * Set "add null" option. */ void setAddNull(long cfId, long projId, boolean data); /** * Put data for the custom field. */ void setQueryFieldData(long cfId, long projId, String data); }

और इसे लागू करें:

इंटरफ़ेस का स्रोत कोड कार्यान्वयन

 import com.atlassian.sal.api.pluginsettings.PluginSettingsFactory; public class QueryFieldsMgrImpl implements QueryFieldsMgr { /** * PlugIn key. */ private static final String PLUGIN_KEY = "QUERY_LINKING_ISSUE_CFS"; /** * Property separator. */ private static final String VAL_SEPARATOR = "||"; /** * Plug-In settings factory. */ private final PluginSettingsFactory pluginSettingsFactory; /** * Constructor. */ public QueryFieldsMgrImpl( PluginSettingsFactory pluginSettingsFactory) { this.pluginSettingsFactory = pluginSettingsFactory; } /** * Create property key. */ private String createPropKey(long cfId, long projId) { return (cfId + VAL_SEPARATOR + projId); } @Override public boolean getAddNull(long cfId, long projId) { String addNull = (String)pluginSettingsFactory.createSettingsForKey(PLUGIN_KEY).get(createPropKey(cfId, projId).concat(".addnull")); return Boolean.parseBoolean(addNull); } @Override public String getQueryFieldData( long cfId, long projId) { return (String)pluginSettingsFactory.createSettingsForKey(PLUGIN_KEY).get(createPropKey(cfId, projId)); } @Override public void setAddNull(long cfId, long projId, boolean data) { pluginSettingsFactory.createSettingsForKey(PLUGIN_KEY).put(createPropKey(cfId, projId).concat(".addnull"), Boolean.toString(data)); } @Override public void setQueryFieldData( long cfId, long projId, String data) { pluginSettingsFactory.createSettingsForKey(PLUGIN_KEY).put(createPropKey(cfId, projId), data); } }

उसके बाद, एक विशिष्ट डेटा प्रबंधक का उपयोग किसी भी सर्वलेट और मानक जीरा घटकों के एक्सटेंशन में किया जा सकता है, उदाहरण के लिए:

 public class LinkerField extends TextCFType implements SortableCustomField<String> { /** * PlugIn data manager. */ private final QueryFieldsMgr qfMgr; /** * Constructor. */ public LinkerField( CustomFieldValuePersister customFieldValuePersister, GenericConfigManager genericConfigManager, QueryFieldsMgr qfMgr) { super(customFieldValuePersister, genericConfigManager); this.qfMgr = qfMgr; } ...

प्लगइन कॉन्फ़िगरेशन व्यवस्थापक पृष्ठ को लागू करने के लिए भी अच्छा अभ्यास है। पृष्ठ पर यह सभी प्रोजेक्ट प्रबंधन फ़ील्ड की सूची प्रिंट करने और फ़ील्ड सेट करने के लिए नियंत्रण के साथ पृष्ठ प्रदान करने के लिए समझ में आता है। प्रशासनिक पृष्ठ को लागू करने वाले वर्ग को कॉम से उत्तराधिकारी बनाना बेहतर है। atlassian.jira.web.action.JiraWebActionSupport । एक उदाहरण वर्ग है ru.mail.jira.plugins.lf.QueryFieldsConfig । प्लगइन से कनेक्ट करने के लिए, बस निम्नलिखित लाइनों को एटलसियन- plugin.xml में जोड़ें :

 <web-item key="queryfields-configuration" name="Query issues custom fields configuration link" section="admin_plugins_menu/mailru-admin-section" weight="95"> <label key="queryfields.admin.title"/> <condition class="com.atlassian.jira.plugin.webfragment.conditions.JiraGlobalPermissionCondition"> <param name="permission">admin</param> </condition> <link linkId="queryfields-configuration">/secure/QueryConfigCfsConfig.jspa</link> </web-item> <webwork1 key="queryfields_conf" name="Query issues custom fields configuration" class="java.lang.Object"> <actions> <action name="ru.mail.jira.plugins.lf.QueryFieldsConfig" alias="QueryConfigCfsConfig"> <view name="input">/templates/queryfieldsconf.vm</view> <view name="success">/templates/queryfieldsconf.vm</view> </action> </actions> </webwork1>

JIRA URL क्रियाओं को कार्यान्वित करने के तरीके के बारे में अधिक जानकारी के लिए, यहाँ देखें।
इसके अलावा, याद रखें कि प्रशासनिक पृष्ठ को XSRF हमलों से संरक्षित किया जाना चाहिए। इसके बारे में यहाँ और पढ़ें।

अगर हम यह तय नहीं कर सकते हैं कि हम अपने क्षेत्र को कैसे प्रदर्शित करेंगे, तो हम आधार के रूप में एक साधारण पाठ क्षेत्र ( ru.mail.jira.plugins.lf.LinkerField ) ले सकते हैं और इसका विस्तार कर सकते हैं। टेक्स्ट फ़ील्ड से चार्ट बनाना और आंकड़े एकत्र करना असंभव है, लेकिन यह कार्यक्षमता स्वयं द्वारा कार्यान्वित की जा सकती है: ru.mail.jira.plugins.lf.LirkerFieldSearcher , ru.mail.jira.plugins.lf.ieldLieldFieldCieldFieldFieldValueProvider , ru.mail.jira.plugins.lfugins। .LirkerFieldSearchInputTransformer और ru.mail.jira.plugins.lf.irkerFieldCustomFieldRielder ।

उसके बाद, हमें केवल संपादन और प्रस्तुति के लिए उपस्थिति को प्रोग्राम करना होगा: edit-linkerfield.vm और view-linkerfield.vm ।

मैं यह नोट करना चाहता हूं कि यदि आप नहीं जानते कि दृश्य को कैसे प्रोग्राम किया जाए, तो मैं आपको यह देखने की सलाह देता हूं कि मानक फ़ील्ड कैसे लागू किए जाते हैं: वेबैप / वेब-इन / क्लास / टेम्प्लेट / प्लगइन्स / फ़ील्ड।

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

इवेंट हैंडलर

दूसरा प्लगइन जिस पर मैं टिप्पणी करना चाहता हूं वह है JIRA MRIM श्रोता। यह प्लगइन JIRA ईवेंट नोटिफिकेशन Mail.Ru Agent को भेजता है। इस तरह के एक प्लगइन बनाने के लिए, यह केवल एक ईवेंट हैंडलर को लागू करने के लिए पर्याप्त है। यहाँ वर्ग टेम्पलेट है:

स्रोत कोड

 public class MyListener implements InitializingBean, DisposableBean { /* * Logger. */ private static Log log = LogFactory.getLog(MyListener.class); /** * Event publisher. */ private EventPublisher eventPublisher; /** * Constructor. */ public MyListener ( EventPublisher eventPublisher) { this.eventPublisher = eventPublisher; } @Override public void afterPropertiesSet() throws Exception { //--> register ourselves with the EventPublisher eventPublisher.register(this); } @Override public void destroy() throws Exception { //--> unregister ourselves with the EventPublisher eventPublisher.unregister(this); } @EventListener public void onIssueEvent(IssueEvent issueEvent) { // your code here } }

स्रोत कोड यहाँ है यह ध्यान देने योग्य है कि यहां घटनाओं को फ़िल्टर करने के लिए आप प्लगइन डेटा स्टोर का उपयोग कर सकते हैं, जो पिछले उदाहरण में वर्णित है। ईवेंट हैंडलर का उपयोग करके, आप संबंधित आवश्यकताएं बना सकते हैं, फ़ाइल अटैचमेंट साइन कर सकते हैं, HTTP अनुरोध भेज सकते हैं, और बहुत कुछ।

एक निष्कर्ष के बजाय

जो लोग विकास में रुचि रखते हैं, लेकिन इससे पहले कभी ऐसा नहीं किया है, मैं पुस्तक की सिफारिश करना चाहता हूं - JIRA डेवलपमेंट कुकबुक और https://marketplace.atlassian.com/vendors/37127 पर मुफ्त प्लगइन्स का पालन करें ।

यह, वास्तव में, वह सब है जिसके बारे में मैं आपको बताना चाहता था। यदि आपके कोई प्रश्न हैं या आप JIRA और Confluence के बारे में अपने विचार साझा करना चाहते हैं, तो मुझे आपके साथ टिप्पणियों में बात करने में खुशी होगी। इसके अलावा, यदि आपके पास मुफ्त प्लग-इन के लिए विचार हैं, तो कार्यान्वयन के साथ लिखें, बनाएं या मदद करें।

JIRA और प्लगइन्स के साथ संगम अनुकूलन

मैं क्या बताऊंगा

कस्टम फ़ील्ड्स

इवेंट हैंडलर

एक निष्कर्ष के बजाय

More articles: