वसंत क्लाउड अनुबंध के साथ वेब अनुप्रयोग एकीकरण

यह लेख स्प्रिंग का उपयोग करके और एचटीटीपी पर काम करने के लिए लिखे गए वेब अनुप्रयोगों के एकीकरण पर ध्यान केंद्रित करेगा। मेरी राय में स्प्रिंग क्लाउड कॉन्ट्रैक्ट नाम भ्रामक है, क्योंकि इसका क्लाउड से कोई लेना-देना नहीं है।

यह एपीआई अनुबंधों के बारे में होगा।

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

इससे एकीकरण के साथ समस्याएं हो सकती हैं।

उदाहरण के लिए, डेटा की अनुपस्थिति में एक सर्वर 204 NO_CONTENT लौटा सकता है, और एक ग्राहक 200 OK और खाली json की उम्मीद कर सकता है।

इससे कोई फर्क नहीं पड़ता कि उनमें से कौन सही है। समस्या यह है कि किसी ने गलती की है और यह एकीकरण चरण से पहले नहीं मिलेगा।

इस समस्या को स्प्रिंग क्लाउड अनुबंध द्वारा हल करने के लिए डिज़ाइन किया गया है।

वसंत बादल अनुबंध क्या है

यह एक फाइल है जिसमें yaml या groovyDSL बोली बताती है कि अनुरोध और प्रतिक्रिया कैसे दिखनी चाहिए। डिफ़ॉल्ट रूप से, सभी अनुबंध /src/test/resources/contracts/* फ़ोल्डर में हैं।

उदाहरण के लिए, सरलतम GET-समापन बिंदु का परीक्षण करें

 @GetMapping("/bets/{userId}") public ResponseEntity<List<Bet>> getBets(@PathVariable("userId") String userId) { List<Bet> bets = service.getByUserId(userId); if (bets.isEmpty()) { return ResponseEntity.noContent().build(); } return ResponseEntity.ok(bets); } 

हम अनुबंध का वर्णन करेंगे

 org.springframework.cloud.contract.spec.Contract.make { request { method 'GET' urlPath '/bets/2' } response { status 200 headers { header('Content-Type', 'application/json') } body(''' { "sport":"football", "amount": 1 } ''' ) } } 

इसके अलावा, यूनिट टेस्ट और वायरसन के लिए json इस फाइल से मावेन या ग्रेडल प्लगइन का उपयोग करके उत्पन्न होते हैं ।

ऊपर दिए गए उदाहरण के लिए मॉक का JSON विवरण इस तरह दिखेगा:

 { "id" : "df8f7b73-c242-4664-add3-7214ac6356ff", "request" : { "urlPath" : "/bets/2", "method" : "GET" }, "response" : { "status" : 200, "body" : "{\"amount\":1,\"sport\":\"football\"}", "headers" : { "Content-Type" : "application/json" }, "transformers" : [ "response-template" ] }, "uuid" : "df8f7b73-c242-4664-add3-7214ac6356ff" } 

वायरमॉक को स्थानीय रूप से चलाया जा सकता है, आपको बस यहां से जार डाउनलोड करना होगा। डिफ़ॉल्ट रूप से, json mokee को mappings फ़ोल्डर डालना चाहिए।

 $java -jar wiremock-standalone-2.18.0.jar 

नीचे दिखाया गया उत्पन्न परीक्षण है। RestAssured लाइब्रेरी का उपयोग डिफ़ॉल्ट रूप से किया जाता है, लेकिन mockMVC या spockframework का उपयोग किया जा सकता है।

 public class UserControllerTest extends ContractBae { @Test public void validate_get_200() throws Exception { // given: MockMvcRequestSpecification request = given(); // when: ResponseOptions response = given().spec(request) .get("/bets/2"); // then: assertThat(response.statusCode()).isEqualTo(200); assertThat(response.header("Content-Type")).isEqualTo("application/json"); // and: DocumentContext parsedJson = JsonPath.parse(response.getBody().asString()); assertThatJson(parsedJson).field("['amount']").isEqualTo(1); assertThatJson(parsedJson).field("['sport']").isEqualTo("football"); } } 

यह ध्यान दिया जाना चाहिए कि सभी उत्पन्न कक्षाएं कुछ प्रकार के आधार वर्ग (कई आधार कक्षाएं हो सकती हैं) प्राप्त करती हैं, जिसमें परीक्षणों के लिए सभी आवश्यक पैरामीटर आरंभ किए जाते हैं। बेस क्लास का रास्ता प्लगइन सेटिंग्स में वर्णित है।

इस उदाहरण के लिए, बेस क्लास इस तरह दिख सकता है:

 @RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = SccDemoApplication.class) public abstract class ContractBae { @LocalServerPort int port; @Autowired protected WebApplicationContext webApplicationContext; @Before public void configureRestAssured() { RestAssured.port = port; MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext) .build(); RestAssuredMockMvc.mockMvc(mockMvc); } } 

नतीजतन, हमें पता चलता है कि परीक्षण और मोके दोनों एक स्रोत से प्राप्त किए गए थे। यदि यूनिट परीक्षण पास हो जाते हैं और सशर्त मोर्चे पर मोकास पर चलता है, तो एकीकरण के साथ कोई समस्या नहीं होगी।

लेकिन यह सब नहीं है
मोकी न केवल सामने के छोर का उपयोग कर सकता है, बल्कि एप्लिकेशन को दूसरे एप्लिकेशन के साथ एकीकृत करने के लिए। स्प्रिंग एक मस्क सर्वर शुरू कर सकता है, आपको बस मोकामी के साथ एक जार उत्पन्न करना होगा और इसे पथ को पास करना होगा @AutoConfigureStubRunner एनोटेशन

मान लीजिए कि हमारा कंट्रोलर किसी अन्य एप्लिकेशन के लिए HTTP करता है:

 @GetMapping("/bets/{userId}") public ResponseEntity<List<Bet>> getBets(@PathVariable("userId") String userId) { if(!isUsetExists(userId)) { return ResponseEntity.notFound().build(); } List<Bet> bets = service.getByUserId(userId); if (bets.isEmpty()) { return ResponseEntity.noContent().build(); } return ResponseEntity.ok(bets); } private boolean isUsetExists(String userId) { try { restTemplate.getForObject("/exists/" + userId, Void.class); return true; } catch (HttpStatusCodeException ignore) { return false; } } 

फिर आपको बस आधार वर्ग में मोकामी के साथ ले जार का वर्णन करने की आवश्यकता है

 @RunWith(SpringRunner.class) @SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, classes = SccDemoApplication.class) @AutoConfigureStubRunner(ids = {"me.dehasi.contracts.demo:sub-service-stubs:+:stubs:8090"}, stubsMode = StubRunnerProperties.StubsMode.LOCAL) public abstract class ContractBase { 

क्योंकि ये नियंत्रक परीक्षण हैं, फिर असिसी-डॉक स्निपेट्स समान परीक्षणों से उत्पन्न हो सकते हैं (बाकी डॉक्स पर एक पूर्ण लेख पहले से ही हब पर है )।

हमारे पास क्या है?
यह पता चला है कि हमारे पास एपीआई अनुबंध का एक स्रोत है, जिसे मानव-पठनीय भाषा में वर्णित किया गया है, और इसमें से हम यूनिट परीक्षण (सैद्धांतिक रूप से दस्तावेज भी) उत्पन्न करते हैं, और मोकी से। यह दृष्टिकोण वेब अनुप्रयोगों के बीच एकीकरण त्रुटियों के जोखिम को कम करता है।

उदाहरण के लिए आधिकारिक वेबसाइट पर उदाहरण देखे जा सकते हैं।

लेख में कोड उदाहरण यहां सरलतम परियोजना से लिए गए हैं ।