मुझे लगता है कि कई जावा डेवलपर्स, जो कम से कम एक बार Web- आए थे, ने XML Schema ( XSD ) द्वारा वर्णित Java DTO कक्षाओं की पीढ़ी का उपयोग किया था। xjc इसे धमाके के साथ xjc करता है, चाहे इसका उपयोग wsimport करें, कमांड लाइन, xjc या xjc से xjc या wsimport कॉल के माध्यम से।

एक XSD स्कीमा से कक्षाएं उत्पन्न करना इतना त्वरित और आसान है। लेकिन यहाँ एक समस्या है - मूल सर्किट में उपलब्ध विवरण लगभग पूरी तरह से गायब हो जाते हैं!

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

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

एक नज़र में जैक्सब फीचर्स

जैक्सब का एक लंबा इतिहास है और एक अच्छा आधिकारिक विवरण है, जिसमें उत्पन्न वर्गों के साथ व्यवहार को जोड़ना शामिल है ।

कमांड लाइन से क्लास जनरेशन को इनवॉइस करने का मुख्य टूल - xjc में भी कम से कम कीज़ नहीं हैं। हालांकि, उनमें से एक भी हमारे मामले के लिए नहीं है।

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

जैक्सब (XJC) प्लगइन्स

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

लेकिन फिर, http://stackoverflow.com/ पर उत्तर और प्रश्नों को पढ़ते हुए, मुझे इस तरह के कई प्रश्न मिले, उदाहरण के लिए:

1. स्कीमा एनोटेशन को संभालने के लिए JAXB का उपयोग करना ।
2. जनरेट की गई कक्षाओं को कैसे बनाएं XML स्कीमा प्रलेखन से जावदोक
3. मैं एक वर्ग कैसे उत्पन्न कर सकता हूं जिससे मैं नोड के XML को स्ट्रिंग के रूप में पुनः प्राप्त कर सकता हूं

और कई वर्षों में एक भी पूर्ण उत्तर नहीं!

लेकिन, अवसरों के विषय पर लौटते हुए, यह पता चला कि प्लगइन्स लिखने के लिए एक API ! निम्न-स्तर, कभी-कभी भ्रामक, लगभग बिना दस्तावेज के ... लेकिन मैं कह सकता हूं कि यह बहुत उन्नत है, यानी आप सीधे क्या प्रक्रियाओं में बहुत हस्तक्षेप कर सकते हैं। वैसे, कई गैर-मानक मामलों के लिए, इसके उत्तर अक्सर संदर्भित होते हैं। खैर, मैंने एक प्लगइन लिखने की कोशिश की।

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

• XJC प्लगइन बनाना
• कैसे अपने खुद के XJC प्लगइन को लागू करने के लिए toString (), बराबर (), और हैशकोड () के तरीके को लागू करें
• StackOverflow बहुत विस्तृत जवाब:
  
  • xjc java classes generation, जहां खेतों का नाम @XmlElement जैसा है
  • JAXB गैर-ASCII वर्णों को ASCII वर्णों में परिवर्तित करता है

मैं क्या चाहता था और क्यों

हमारी एक एकीकरण के लिए, ग्राहक ने एक्सएसडी फाइलों के साथ एक संग्रह प्रदान किया, जिसके अनुसार हमें एमडीएम यूनिडाटा में एक मॉडल तैयार करना था, जिसके साथ हम काम करते हैं, गुणवत्ता नियमों को और कॉन्फ़िगर करने के लिए।

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

मेरी योजना यह थी:

1. XJC का उपयोग करके XSD कक्षाएं बनाना
2. तब हम सभी वस्तुओं पर प्रतिबिंबों का एक सुंदर पुस्तकालय और पुनरावृत्ति करते हैं, फिर से नीचे खेतों में जा रहे हैं।

सब कुछ जल्दी से लैटिन नामों के लिए काम करता था, जिन्हें field कक्षाओं से लिया गया था। लेकिन रूसी, मानव-पठनीय विवरण कहीं नहीं था!

मैन्युअल रूप से संपादन विवरण एक विकल्प नहीं है, क्योंकि हजारों नेस्टेड फ़ील्ड हैं।

पहला प्रयास Groovy पर एक समान पार्सर लिखने का था, जो एक्सएसडी से विवरण फाड़ रहा था। और सामान्य तौर पर, इसे लागू किया गया था। लेकिन यह जल्दी से स्पष्ट हो गया कि ऐसे कई मामले हैं जहां अतिरिक्त प्रसंस्करण की आवश्यकता होती है - पुनरावर्ती कॉल, restriction / extension के रूप में XSD 1.1 एक्सटेंशन का समर्थन (उत्तराधिकार और ओवरराइडिंग के लिए समर्थन के साथ), विभिन्न प्रकार जिनमें से क्लास फ़ील्ड उत्पन्न होता है <element> और <attribute> , <sequence> , <choose> और कई अन्य छोटी चीजें। कार्यान्वयन परिवर्धन के साथ समाप्त हो गया था, लेकिन उसने सद्भाव नहीं बढ़ाया।

नतीजतन, मैं xjc-प्रलेखन-एनोटेशन-प्लगइन प्लगइन लिखने के विचार पर लौट आया, जो मैं आपके सामने प्रस्तुत करता हूं, इस उम्मीद में कि यह मेरे अलावा किसी के लिए उपयोगी होगा!

xjc-प्रलेखन-एनोटेशन-प्लगइन

सब कुछ गितुब पर रखा गया है: https://github.com/Hubbitus/xjc-documentation-annotation-plugin
उपयोग के लिए उदाहरण के साथ निर्देशन, परीक्षण और एक अलग - gradle ।

मुझे लगता है कि इसका विवरण यहाँ से कॉपी करने का कोई मतलब नहीं है, बस संक्षेप में बताएं कि यह क्या करता है।

मान लीजिए कि इस तरह का XSD टुकड़ा है:

  <xs:complexType name="Customer"> <xs:annotation> <xs:documentation></xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="name" type="xs:string"> <xs:annotation> <xs:documentation>  </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> 

डिफ़ॉल्ट रूप से, XJC इससे एक XJC क्लास उत्पन्न XJC (रीडर्स के लिए गेटर्स, सेटरर्स और कुछ अप्रासंगिक विवरण छोड़ दिए जाते हैं):

 /** *  * * <p>Java class for Customer complex type. * * <p>The following schema fragment specifies the expected content contained within this class. * * <pre> * &lt;complexType name="Customer"&gt; * &lt;complexContent&gt; * &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt; * &lt;sequence&gt; * &lt;element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/&gt; * &lt;element name="age" type="{http://www.w3.org/2001/XMLSchema}positiveInteger"/&gt; * &lt;/sequence&gt; * &lt;/restriction&gt; * &lt;/complexContent&gt; * &lt;/complexType&gt; * </pre> * * */ @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Customer", propOrder = { "name", "age" }) public class Customer { @XmlElement(required = true) protected String name; @XmlElement(required = true) @XmlSchemaType(name = "positiveInteger") protected BigInteger age; } 

प्लगइन के साथ, आपको मिलता है ( Javadoc वही रहता है, जो सादगी के लिए छोड़ा गया है):

 @XmlAccessorType(XmlAccessType.FIELD) @XmlType(name = "Customer", propOrder = { "name", "age" }) @XsdInfo(name = "", xsdElementPart = "<complexType name=\"Customer\">\n <complexContent>\n <restriction base=\"{http://www.w3.org/2001/XMLSchema}anyType\">\n <sequence>\n <element name=\"name\" type=\"{http://www.w3.org/2001/XMLSchema}string\"/>\n <element name=\"age\" type=\"{http://www.w3.org/2001/XMLSchema}positiveInteger\"/>\n </sequence>\n </restriction>\n </complexContent>\n</complexType>") public class Customer { @XmlElement(required = true) @XsdInfo(name = "  ") protected String name; @XmlElement(required = true) @XmlSchemaType(name = "positiveInteger") @XsdInfo(name = "") protected BigInteger age; } 

जोड़ा गया @XmlType एनोटेशन देखें।

इसका उपयोग तब किसी भी अन्य एनोटेशन के रूप में सरल है:

  XsdInfo xsdAnnotation = CadastralBlock.class.getDeclaredAnnotation(XsdInfo.class); System.out.println("XSD description: " + xsdAnnotation.name()); 

एक कामकाजी उदाहरण परीक्षणों में है: 1 , 2 ।