स्प्रिंग एमवीसी नियंत्रकों के मानचित्रण को अनुकूलित करें

परिचय

हाल ही में मुझे एक नियंत्रक को लागू करने के कार्य के साथ सामना करना पड़ा जो विभिन्न तरीकों से स्थितियों को संभालता है जहां अनुरोध पैरामीटर हैं और जहां कोई नहीं हैं। समस्या को इस तथ्य से जटिल किया गया था कि नियंत्रक में वास्तव में दो अलग-अलग तरीकों की आवश्यकता थी। स्प्रिंग एमवीसी की मानक विशेषताओं ने इसकी अनुमति नहीं दी। मुझे थोड़ी गहरी खुदाई करनी थी। कौन परवाह करता है - बिल्ली में आपका स्वागत है।

हम क्या चाहते हैं?

यहाँ एक छोटा परीक्षण है जो कार्य के सार का वर्णन करता है।

@SpringJUnitWebConfig(WebConfig.class) class TestControllerTest {     @Autowired     WebApplicationContext webApplicationContext;     @Test     void testHandleRequestWithoutParams() throws Exception {         MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();         mockMvc.perform(MockMvcRequestBuilders.get("/test"))                 .andExpect(status().isOk())                 .andExpect(result ->                         assertEquals(TestController.HANDLE_REQUEST_WITHOUT_PARAMS, result.getResponse().getContentAsString()));     }     @Test     void testHandleRequestWithParams() throws Exception {         MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();         mockMvc.perform(MockMvcRequestBuilders                 .get("/test")                 .param("someparam", "somevalue"))                 .andExpect(status().isOk())                 .andExpect(result ->                         assertEquals(TestController.HANDLE_REQUEST_WITH_PARAMS, result.getResponse().getContentAsString()));     } } 

हमें उम्मीद है कि सब कुछ अपने आप हल हो जाएगा

 @Controller @RequestMapping("/test") public class TestController {    public static final String HANDLE_REQUEST_WITH_PARAMS = "handleRequestWithParams";    public static final String HANDLE_REQUEST_WITHOUT_PARAMS = "handleRequestWithoutParams";    @GetMapping    @ResponseBody    public String handleRequestWithParams(SearchQuery query) {        return HANDLE_REQUEST_WITH_PARAMS;    }    @GetMapping    @ResponseBody    public String handleRequestWithoutParams() {        return HANDLE_REQUEST_WITHOUT_PARAMS;    } } 

हालाँकि, स्प्रिंग अपेक्षा के अनुरूप नहीं था, और आउटपुट था:

 java.lang.IllegalStateException: Ambiguous mapping. Cannot map 'getTestController' method public java.lang.String ru.pchurzin.spring.customannotations.TestController.handleRequestWithoutParams() to {GET /test}: There is already 'getTestController' bean method public java.lang.String ru.pchurzin.spring.customannotations.TestController.handleRequestWithParams(ru.pchurzin.spring.customannotations.SearchQuery) mapped.` 

हार मत मानो

@RequestMapping(params = "some condition") एनोटेशन के माध्यम से इन तरीकों की मैपिंग को अलग करने का प्रयास किया गया है, लेकिन दुर्भाग्य से स्प्रिंग 5.1.8 के उपयोग किए गए संस्करण में किसी भी पैरामीटर को शामिल करने के अनुरोध के लिए शर्त सेट करने का कोई तरीका नहीं है। आप या तो विशिष्ट नामों के साथ मापदंडों की उपस्थिति या विशिष्ट नामों के साथ मापदंडों की अनुपस्थिति को निर्दिष्ट कर सकते हैं। न तो एक और न ही दूसरा उपयुक्त था, क्योंकि प्रत्येक अनुरोध में पैरामीटर भिन्न हो सकते हैं। मैं कुछ ऐसा लिखना @RequestMapping(params = "*") यह दर्शाने के लिए कि अनुरोध में कुछ पैरामीटर होने चाहिए या @RequestMapping (params = "! *!") `यह दर्शाने के लिए कि अनुरोध में क्या नहीं होना चाहिए! कोई पैरामीटर नहीं है।

और प्रलेखन में क्या है?

प्रलेखन धूम्रपान करने के बाद, अनुभाग CustomAnnotations पाया गया था, जिसमें हम देखते हैं:

 Spring MVC also supports custom request-mapping attributes with custom request-matching logic. 

यह मेरा एनोटेशन बनाने का निर्णय लिया गया, जिसने मुझे क्वेरी पैरामीटर की उपलब्धता के लिए आवश्यक शर्तों को निर्दिष्ट करने की अनुमति दी।

लक्ष्य

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

 @Target(ElementType.METHOD) @Retention(RetentionPolicy.RUNTIME) public @interface NoRequestParams { } 

हमारे एनोटेशन के साथ नियंत्रक:

 @Controller @RequestMapping("/test") public class TestController {    public static final String HANDLE_REQUEST_WITH_PARAMS = "handleRequestWithParams";    public static final String HANDLE_REQUEST_WITHOUT_PARAMS = "handleRequestWithoutParams";    @GetMapping    @ResponseBody    public String handleRequestWithParams(SearchQuery query) {        return HANDLE_REQUEST_WITH_PARAMS;    }    @GetMapping    @ResponseBody @NoRequestParams //     public String handleRequestWithoutParams() {        return HANDLE_REQUEST_WITHOUT_PARAMS;    } } 

चलिए शुरू करते हैं

@EnableWebMvc एनोटेशन द्वारा सक्रिय मानक स्प्रिंग-MVC कॉन्फ़िगरेशन, WebMvcConfigurationSupport वर्ग में वर्णित है। यह RequestMappingHandlerMapping वर्ग की एक सेम को तुरंत तैयार करता है, जो RequestMappingInfo वर्ग की वस्तुओं का उपयोग करके मैपिंग को लागू करता है, जो बदले में विधि अनुरोधों की मैपिंग के बारे में जानकारी को एन्क्रिप्ट करता है। यह जानकारी शर्तों के रूप में प्रस्तुत की जाती है - क्लास ऑब्जेक्ट्स जो RequestCondition इंटरफ़ेस को लागू करते हैं । वसंत में 6 तैयार किए गए कार्यान्वयन हैं:

• PatternsRequestCondition
• RequestMethodsRequestCondition
• ParamsRequestCondition
• HeadersRequestCondition
• ConsumesRequestCondition
• ProducesRequestCondition

इन कार्यान्वयनों के अलावा, हम अपने स्वयं को परिभाषित कर सकते हैं। ऐसा करने के लिए, हमें RequestCondition इंटरफ़ेस को लागू करने की आवश्यकता है, और हमारी आवश्यकताओं के लिए इस कार्यान्वयन का उपयोग करें। आप इंटरफ़ेस को सीधे लागू कर सकते हैं या एक सार वर्ग का उपयोग कर सकते हैं
AbstractRequestCondition ।

 public class NoRequestParamsCondition extends AbstractRequestCondition<NoRequestParamsCondition> {    public final static NoRequestParamsCondition NO_PARAMS_CONDITION = new NoRequestParamsCondition();    @Override    protected Collection<?> getContent() {        return Collections.singleton("no params");    }    @Override    protected String getToStringInfix() {        return "";    }    @Override    public NoRequestParamsCondition combine(NoRequestParamsCondition other) {        return this;    }    @Override    public NoRequestParamsCondition getMatchingCondition(HttpServletRequest request) {        if (request.getParameterMap().isEmpty()) {            return this;        }        return null;    }    @Override    public int compareTo(NoRequestParamsCondition other, HttpServletRequest request) {        return 0;    } } 

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

टी कंबाइन (टी अन्य) विधि के लिए शर्तों को संयोजित करना आवश्यक है, उदाहरण के लिए, यदि विधि और वर्ग पर एनोटेशन है। इस मामले में, संयोजन के लिए संयोजन विधि का उपयोग किया जाता है। हमारा एनोटेशन एक संयोजन का अर्थ नहीं करता है - इसलिए, हम बस शर्त के हमारे वर्तमान उदाहरण को वापस करते हैं।

Int तुलना (T अन्य, HttpServletRequest अनुरोध) विधि का उपयोग किसी निश्चित अनुरोध के संदर्भ में स्थितियों की तुलना करने के लिए किया जाता है। यानी यदि अनुरोध के लिए एक ही प्रकार की कई शर्तें हैं, तो यह पता चलता है कि कौन सा सबसे विशिष्ट है। लेकिन फिर से, हमारी स्थिति केवल एक ही संभव है, इसलिए हम बस 0 पर लौटते हैं, अर्थात्। हमारी सभी शर्तें समान हैं।

कार्य का मूल तर्क टी पद्धति getMatchingCondition (HttpServletRequest अनुरोध) में निहित है। इस पद्धति में, हमें यह तय करना होगा कि हमारी स्थिति इस पर लागू होती है या नहीं। यदि ऐसा है, तो स्थिति ऑब्जेक्ट वापस करें। यदि नहीं, तो null लौटें। हमारे मामले में, हम एक शर्त वस्तु वापस करते हैं यदि अनुरोध में कोई पैरामीटर नहीं है।

अब हमें मानचित्रण प्रक्रिया में अपनी स्थिति को शामिल करने की आवश्यकता है। ऐसा करने के लिए, हम RequestMappingHandlerMapping के मानक कार्यान्वयन से विरासत में लेंगे
और getCustomMethodCondition(Method method) फिर से परिभाषित करें, जो कि आपकी अपनी कस्टम शर्तों को जोड़ने के लिए बनाई गई है। इसके अलावा, इस विधि का उपयोग नियंत्रक विधियों की शर्तों को निर्धारित करने के लिए किया जाता है । एक getCustomTypeCondition(Class<?> handlerType) , जिसका उपयोग नियंत्रक वर्ग के बारे में जानकारी के आधार पर स्थितियों को निर्धारित करने के लिए किया जा सकता है। हमारे मामले में, हमें इसकी आवश्यकता नहीं है।

परिणामस्वरूप, हमारे पास निम्नलिखित कार्यान्वयन हैं:

 public class CustomRequestMappingHandlerMapping extends RequestMappingHandlerMapping {    @Override    protected RequestCondition<?> getCustomMethodCondition(Method method) {        return method.isAnnotationPresent(NoRequestParams.class) ? NO_PARAMS_CONDITION : null;    } } 

तर्क जटिल नहीं है - हम अपने एनोटेशन के अस्तित्व की जांच करते हैं और यदि यह मौजूद है, तो हम अपनी स्थिति का उद्देश्य वापस करते हैं।

हमारे मानचित्रण कार्यान्वयन को सक्षम करने के लिए, हम मानक स्प्रिंग MVC कॉन्फ़िगरेशन का विस्तार करेंगे:

 @Configuration public class WebConfig extends WebMvcConfigurationSupport {       @Override    protected RequestMappingHandlerMapping createRequestMappingHandlerMapping() {        return new CustomRequestMappingHandlerMapping();    }    @Bean    public TestController getTestController() {        return new TestController();    } } 

नियंत्रक में हमारा एनोटेशन जोड़ें:

 @Controller @RequestMapping("/test") public class TestController {    public static final String HANDLE_REQUEST_WITH_PARAMS = "handleRequestWithParams";    public static final String HANDLE_REQUEST_WITHOUT_PARAMS = "handleRequestWithoutParams";    @GetMapping    @ResponseBody    public String handleRequestWithParams(SearchQuery query) {        return HANDLE_REQUEST_WITH_PARAMS;    }    @GetMapping    @ResponseBody    @NoRequestParams    public String handleRequestWithoutParams() {        return HANDLE_REQUEST_WITHOUT_PARAMS;    } } 

और परिणाम की जाँच करें:

 Tests run: 2, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 1.851 s - in ru.pchurzin.spring.customannotations.TestControllerTest Results: Tests run: 2, Failures: 0, Errors: 0, Skipped: 0 

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

आपका ध्यान के लिए धन्यवाद।

Github उदाहरण कोड