लोम्बोक परियोजना, या बॉयलरप्लेट पर युद्ध की घोषणा

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

लोम्बोक कनेक्ट करें

लंबोक जावा 6 से एनोटेशन प्रोसेसिंग इंजन का उपयोग करता है, जिसमें से इसकी न्यूनतम पर्यावरणीय आवश्यकताओं का पालन किया जाता है। लोम्बोक को परियोजना से जोड़ने के लिए, बस इसे निर्भर करता है। मावेन का उपयोग करने के मामले में, इस प्रकार किया जाता है:

<dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>0.11.0</version> <scope>provided</scope> </dependency> 

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

हम एक्सेसर्स को अलविदा कहते हैं

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

  public class GetterSetterExample { @Getter @Setter private int age = 10; @Setter(AccessLevel.PROTECTED) private String name; @Getter(lazy=true) private final Map<String, String> map = initMap(); } 

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

डिजाइनरों का विनाश

POJO वर्गों के निर्माता या तो जटिलता या विविधता में भिन्न नहीं होते हैं - सबसे अधिक बार हमें इस सूची में से कुछ की आवश्यकता होती है: मापदंडों के बिना एक निर्माता, सभी मापदंडों के साथ एक निर्माता, केवल कुछ आवश्यक मापदंडों के साथ एक निर्माणकर्ता, एक स्थिर कारखाना विधि। लोम्बोक इस कार्य को एनोटेशन @NoArgsConstructor, @AllArgsConstructor, @RequiredArgsConstructor और staticName पैरामीटर के साथ आसानी से संभालता है।

 @RequiredArgsConstructor(staticName = "of") @AllArgsConstructor(access = AccessLevel.PROTECTED) public class ConstructorExample<T> { private String name; @NonNull private T description; } 

परिणाम के रूप में हमें यहाँ मिलता है:

 public class ConstructorExample<T> { private String name; @NonNull private T description; private ConstructorExample(T description) { if (description == null) throw new NullPointerException("description"); this.description = description; } public static <T> ConstructorExample<T> of(T description) { return new ConstructorExample<T>(description); } @java.beans.ConstructorProperties({"name", "description"}) protected ConstructorExample(String name, T description) { if (description == null) throw new NullPointerException("description"); this.name = name; this.description = description; } 

हम मानक विधियाँ उत्पन्न करते हैं: स्ट्रिंग, हैशकोड, बराबर

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

 @ToString(exclude="id") @EqualsAndHashCode(exclude="id") public class Person { private Long id; private String name; ... } 

अदृश्य लकड़हारा

यदि आप लोकप्रिय लॉगिंग पुस्तकालयों में से एक का उपयोग करते हैं, तो प्रत्येक कक्षा में आपके पास स्थैतिक लकड़हारा घोषणा होने की सबसे अधिक संभावना है:

 public class Controller { private static final Logger log = LoggerFactory.getLogger(Controller.class); public void someMethod() { log.debug("someMethod started"); 

इसके बजाय, लोम्बोक आपकी पसंदीदा लॉगिंग सुविधा के आधार पर, एनोटेशन लॉग , @CommonsLog, @ Log4j या @ Slf4j का उपयोग करने का सुझाव देता है:

 @Slf4j public class Controller { public void someMethod() { log.debug("someMethod started"); 

स्थानीय चर को अंतिम रूप दें

अंतिम स्थानीय चर का उपयोग एक अच्छी प्रोग्रामिंग शैली है, हालांकि, स्थैतिक टाइपिंग और जावा में टाइप इंट्रेंस की अनुपस्थिति को देखते हुए, कुछ विशेष रूप से परिष्कृत मानचित्र की घोषणा करना स्क्रीन से बाहर रेंगना हो सकता है। यदि आप अभी तक जावा से स्काला या ग्रूवी पर स्विच नहीं करना चाहते हैं, तो आप निम्नलिखित लोमबोक हैक का उपयोग कर सकते हैं:

 public class ValExample { public String example() { val map = new HashMap<String, Map<String, String>>(); for (val entry: map.entrySet()) { ... 

इस मामले में मानचित्र चर को अंतिम घोषित किया जाएगा, जबकि इसके प्रकार का विवरण असाइनमेंट अभिव्यक्ति के दाईं ओर से लिया जाएगा।

अपवित्रता के साथ अपवाद फेंको

सभी डेवलपर्स, दुर्भाग्य से, "प्रभावी जावा" ब्लॉक या स्टुटिंग रोबस्ट जावा को पहले से ही यहां पढ़ा नहीं गया है। या शायद वे पढ़ते हैं, लेकिन बहुत सावधानी से नहीं। या, शायद, उनके पास वास्तव में इस विशेष अपवाद को घोषित करने के लिए किसी प्रकार की अच्छी तरह से स्थापित प्रेरणा थी - लेकिन यह आपके लिए आसान नहीं है, क्योंकि आप जानते हैं कि यह कभी भी उत्पन्न नहीं होगा! क्या करना है, उदाहरण के लिए, UnsupportedEncodingException के साथ, यदि आप पूरी तरह से सुनिश्चित हैं कि UTF-8 के लिए सिस्टम समर्थन के बिना आपका एप्लिकेशन अभी भी काम नहीं करेगा? आपको कोड को ट्राइ-कैच में लपेटना होगा और एक लॉग में अर्थहीन आउटपुट लिखना होगा जो कभी भी प्रतीक्षा नहीं करेगा, एक रनवे रैपर में एक अपवाद को चालू करें जो पैदा होने के लिए नियत नहीं है, या यहां तक ​​कि इसे एक खाली अवरोधन ब्लॉक के साथ अनदेखा करें (जो मुझे नहीं पता कि कैसे आप, और मैं व्यक्तिगत रूप से हमेशा रिवॉल्वर हड़पने की इच्छा जगाते हैं)। लोम्बोक भी यहाँ एक विकल्प प्रदान करता है।

  public class SneakyThrowsExample implements Runnable { @SneakyThrows // "  !" public void run() { throw new Throwable(); // "   !" } } 

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

सही सिंक

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

 @Synchronized public static void hello() { System.out.println("World"); } @Synchronized public int answerToLife() { return 42; } 

यहाँ हमें क्या मिलता है:

 private static final Object $LOCK = new Object[0]; private final Object $lock = new Object[0]; public static void hello() { synchronized($LOCK) { System.out.println("world"); } } public int answerToLife() { synchronized($lock) { return 42; } } 

और IDE क्या कहता है?

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



ग्रहण और नेटबीन्स के लिए, स्थापना थोड़ी असामान्य है। आपको lombok.jar फ़ाइल को चलाने की आवश्यकता है, और यह मौजूदा ग्रहण प्रतिष्ठानों पर लोम्बोक को रोल करने के लिए एक अच्छा इंस्टॉलर की पेशकश करेगा:



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



मैंने लोम्बोक की मुख्य विशेषताओं को सूचीबद्ध किया है, लेकिन यह सब नहीं है। अधिक विवरण में, सभी विशेषताओं के साथ और "पहले" और "बाद" कोड की तुलना के साथ सभी संभावित एनोटेशन प्रलेखन में वर्णित हैं।