स्प्रिंग बूट में जसन क्रमांकन इकाई परीक्षण

परिचय

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

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

समस्या का बयान

ग्राहक खर्चों के बारे में जानकारी देने के लिए हमारी वेब सेवा जिम्मेदार है, और हमें विन्यास योग्य सटीकता के साथ डेटा प्रदान करने की आवश्यकता है। गोल तर्क को लागू करने की दृश्यता को बनाए रखते हुए, एक तार्किक समाधान सेवा की परिधि के लिए सभी मॉडल परिवर्तन करना होगा।

एक संभावित समाधान पर विचार करें

हमारे आवेदन के नियंत्रक की कल्पना करें, जो वांछित मॉडल वापस कर देगा।

@RestController public class AccountController { //        , //       . @Autowired private AccountService accountService; @RequestMapping(value = "/account/{clientId}", method = RequestMethod.GET, produces = "application/json") public Account getAccount(@PathVariable long clientId) throws Exception { Account result = accountService.getAccount(clientId); //  ,    - //      ,    json, //    . return result; } } 

अब हमारे मॉडल को देखें।

 public class Account { private Long clientId; //    Spring Boot   FasterXML/jackson, //    API  ,   . // ,       //     MoneySerializer @JsonSerialize(using = MoneySerializer.class) private BigDecimal value; //    getter'  setter'    } 

अनुकूलन के लिए आपको पहले ही अन्य एनोटेशन से निपटना पड़ सकता है। इस एनोटेशन की एक विशेषता एनोटेट मॉडल क्षेत्र को क्रमबद्ध करने के लिए आपकी सेवा को निर्धारित करने की क्षमता है।

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

यह जटिलता हमारी महत्वपूर्ण बात है जिस पर हम विचार करना चाहते हैं। जैसा कि हम मॉडल के कार्यान्वयन से देख सकते हैं, हमारे ढांचे का एपीआई तर्क में क्रमबद्धता वर्ग लेता है, जिसका अर्थ है कि धारावाहिक का जीवन चक्र क्रमिक ढांचे के नियंत्रण में चला जाता है। यह सवाल है, अगर हम धारावाहिक में अपने आवेदन के संदर्भ से निर्भरता को इंजेक्ट करना चाहते हैं तो क्या करना है? ऐसा करने के लिए, ऊपर दिए गए धारावाहिक के कार्यान्वयन पर विचार करें।

 //     , //  Jackson   Spring, // API    //    Spring DI @JsonComponent public class MoneySerializer extends JsonSerializer<BigDecimal> { //  ,   , //    Spring Boot    Bean'. private RoundingHolder roundingHolder; @Autowired public MoneySerializer(RoundingHolder roundingHolder) { this.roundingHolder = roundingHolder; } //       , // ,   ,      - //      . @Override public void serialize(BigDecimal value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException { jsonGenerator.writeNumber(value.setScale(roundingHolder.getPrecision(), roundingHolder.getRoundingMode())); } } 

हमारी सेवा तैयार है, लेकिन जिम्मेदार डेवलपर्स के रूप में, हम यह सुनिश्चित करना चाहते हैं कि जिस रसोई में हमने काम किया है।

चलिए परीक्षण के लिए आगे बढ़ते हैं।

आइए देखें कि परीक्षण रूपरेखा एपीआई हमें क्या प्रदान करता है।

 //     ,   //    Spring,       . //     JsonTest,      //      , //    JSON-. @JsonTest @ContextConfiguration(classes = {AccountSerializationTest.Config.class}) @RunWith(SpringRunner.class) public class AccountSerializationTest { //  ,      //     ObjectMapper,    . //       . //    , //      . @Autowired private ObjectMapper objectMapper; @Test public void testAccountMoneyRounding() throws Exception { Account account = new Account(); account.setClientId(1L); account.setValue(BigDecimal.valueOf(1.123456789)); String expectedResult = "{\"clientId\":1,\"value\":\1.123\}"; // ,          JSON, //     -. assertEquals(expectedResult, objectMapper.writeValueAsString(account)); } //   MoneySerializer   API  //    ,       //    Jackson.   ,   , //   Spring , ,  //      . @TestConfiguration public static class Config { @Bean public static RoundingHolder roundingHolder() { RoundingHolder roundingHolder = Mockito.mock(RoundingHolder.class); //   ,         Mockito.when(roundingHolder.getMathContext()).thenReturn(new MathContext(3, RoundingMode.HALF_EVEN)); return roundingHolder; } } } 

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

यदि आप अपना स्वयं का कस्टम ObjectMapper बनाना चाहते हैं, तो आप निम्नलिखित विशिष्ट उदाहरण पर आ सकते हैं: ObjectMapper mapper = new ObjectMapper । हालाँकि, यह देखें कि कैसे स्प्रिंग बूट डिफ़ॉल्ट रूप से इस वर्ग का एक उदाहरण बनाता है। ऐसा करने के लिए, हम मूल जैक्सनऑटोऑनफिगरेशन ऑटोकैनफिगरेशन कोड की ओर मुड़ते हैं, जो ऑब्जेक्ट बनाने के लिए ज़िम्मेदार है:

 @Bean public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) { return builder.createXmlMapper(false).build(); } 

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

एक विषयांतर के साथ, मैं जैक्सनसेस्टर का एक संदर्भ जोड़ना चाहूंगा । मॉकिटो के संदर्भ में BDD क्रमांकन परीक्षण के लिए शेल के प्रतिनिधि के रूप में।

संक्षेप में देना

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

निष्कर्ष

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