वसंत में सशर्त का उपयोग करना

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

वसंत संदर्भ विभिन्न फलियों का एक विशाल कंटेनर है, दोनों वसंत और कस्टम वाले। आप हमेशा इस बिन चिड़ियाघर के लिए लचीले प्रबंधन उपकरण रखना चाहते हैं। इसके लिए @Conditional एनोटेशन बनाया गया है।

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

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

इस एनोटेशन पर अधिक विस्तार से विचार करें। स्रोत कोड में प्रत्येक बिन के ऊपर, हम @ कंडीशनल जोड़ सकते हैं और स्प्रिंग स्वचालित रूप से इस एनोटेशन में निर्दिष्ट शर्तों की जांच करेगा जब इसे बनाया जाता है।

आधिकारिक दस्तावेज में, इसे इस तरह घोषित किया जाता है:

@Target(value={TYPE,METHOD}) @Retention(value=RUNTIME) @Documented public @interface Conditional 

इस स्थिति में, आपको इसमें शर्तों का एक सेट स्थानांतरित करने की आवश्यकता है:

 Class<? extends Condition>[] 

जहां सशर्त एक कार्यात्मक इंटरफ़ेस है जिसमें विधि शामिल है

 boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) 

आइए देखें कि यह कैसे काम करता है, उदाहरण के तौर पर। हमारे आवेदन में साबुन / बाकी - सेवाओं के रूप में और जेएमएस के रूप में दोनों का इंटरफेस है। लेकिन प्रशासकों के पास समय में उपयुक्त बुनियादी ढाँचा तैयार करने का समय नहीं था - हम JMS का उपयोग नहीं कर सकते।
हमारी परियोजना में जेएमएस के लिए कुछ जावा विन्यास है:

 @Configuration public class JmsConfig { ... } 

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

 @ConditionalOnProperty( value="project.mq.enabled", matchIfMissing = false) @Configuration public class JmsConfig { ... } 

यहां हम बिल्डर के संदर्भ में सूचित करते हैं कि हम यह कॉन्फ़िगरेशन तभी बनाएंगे, जब सेटिंग्स फ़ाइल में project.mq.enabled स्थिरांक का सकारात्मक मान हो।
अब हम आश्रित फलियों पर चलते हैं और उन्हें कोंडिटिओनलऑनबिन एनोटेशन के साथ चिह्नित करते हैं, जो वसंत को उन फलियों को बनाने से रोक देगा जो हमारे विन्यास पर निर्भर हैं।

 @ConditionalOnBean(JmsConfig.class) @Component public class JmsConsumer { ... } 

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

साथ में ढांचे के साथ डेवलपर की जरूरतों के 99% को कवर करने के लिए तैयार किए गए एनोटेशन की एक बड़ी संख्या है (जो बाद में लेख में वर्णित किया जाएगा)। लेकिन क्या होगा अगर आपको कुछ विशिष्ट स्थिति को संभालने की आवश्यकता है। ऐसा करने के लिए, आप अपने स्वयं के कस्टम तर्क को वसंत में जोड़ सकते हैं।

मान लीजिए हमारे पास कुछ बीन है - SuperDBLogger , जिसे हम केवल तभी बनाना चाहते हैं जब हमारे किसी भी डिब्बे में @Loggable एनोटेशन हो। यह कोड में कैसा दिखेगा:

 @Component @ConditionalOnLoggableAnnotation public class SuperDBLogger … 

विचार करें कि @ConditionalOnLoggableAnnotation एनोटेशन कैसे काम करता है :

 @Target({ ElementType.TYPE, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Conditional(OnLoggableAnnotation.class) public @interface ConditionalOnLoggableAnnotation { } 

हमें किसी और पैरामीटर की आवश्यकता नहीं है, अब आइए तर्क पर चलते हैं - OnLoggableAnnotation class की सामग्री। इसमें, हम मिलान विधि को फिर से परिभाषित करते हैं, जिसमें हम अपने पैकेज में चिह्नित बीन्स की खोज को लागू करते हैं।

 public class OnLoggableAnnotation implements Condition { @Override public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) { ClassPathScanner scanner = new ClassPathScanner(); scanner.addIncludeFilter(new AnnotationTypeFilter(Loggable.class)); Set<BeanDefinition> bd = scanner.findInPackage("ru.habr.mybeans"); if (!bd.isEmpty()) return true; return false; } } 

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

 public abstract ConditionOutcome getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata); 

यही है, जवाब के अलावा, हमें एक बिन की जरूरत है या नहीं, आप एक संदेश जोड़ सकते हैं, जिसे तब वसंत लॉग में देखा जा सकता है, यह एहसास करते हुए कि बिन किस कारण से बनाया गया था या नहीं।

अधिक जटिल परिस्थितियों को बनाने के लिए विभिन्न स्थितियों को जोड़ा जा सकता है; ये तंत्र कक्षाएं AnyNestedCondition, AllNestedConditions, और noneNestedConditions प्रदान करते हैं। मान लीजिए कि हम दो स्थितियाँ बनाना चाहते हैं ताकि जब उनमें से एक का निष्पादन हो जाए, तो हमारी सेम बन जाए। ऐसा करने के लिए, अपनी खुद की कक्षा बनाएं और इसे AnyNestedCondition से विरासत में मिला ।

 public class AnnotationAndPropertyCondition extends AnyNestedCondition { public AnnotationAndPropertyCondition() { super(REGISTER_BEAN); } @ConditionalOnProperty(value = "db.superLogger") static class Condition1 {} @ConditionalOnLoggableAnnotation static class Condition2 {} } 

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

इसी तरह, कक्षाओं के लिए AllNestedConditions और noneNestedConditions - पहली सभी शर्तों की पूर्ति पर नज़र रखता है, दूसरा - कोई शर्त पूरी नहीं होती है।

इसके अलावा, कई शर्तों की जाँच करने के लिए, आप कई कक्षाओं को शर्तों के साथ पास कर सकते हैं। उदाहरण के लिए, @ कंडीशनल ({OnLoggableAnnotation.class, AnnotationAndPropertyCondition.class}) । दोनों को सही लौटना चाहिए ताकि स्थिति संतुष्ट हो और बीन बनाई जाए।

जैसा कि मैंने ऊपर उल्लेख किया है, वसंत के साथ पहले से ही कई तैयार किए गए समाधान हैं, जो नीचे दी गई तालिका में प्रस्तुत किए गए हैं।

उन सभी को एक सेम की एक परिभाषा पर एक साथ लागू किया जा सकता है।

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