स्प्रिंग बूट जोड़ना एचटीपी अनुरोध रिसेप्टर्स

Question

स्प्रिंग बूट एप्लिकेशन में HttpRequest इंटरसेप्टर्स को जोड़ने का सही तरीका क्या है? मैं क्या करना चाहता हूं हर HTTP अनुरोध के लिए लॉग अनुरोध और प्रतिक्रियाएं हैं।

स्प्रिंग बूट प्रलेखन इस विषय को बिल्कुल भी कवर नहीं करता है। ( http://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/ )

मुझे वसंत के पुराने संस्करणों के साथ भी ऐसा ही करने के लिए कुछ वेब नमूने मिले, लेकिन वे एप्लीकेशनकॉनटेक्स्ट.एक्सएमएल के साथ काम करते हैं। कृपया मदद कीजिए।

Comments

हाय @ riship89 ... मैंने HandlerInterceptorसफलतापूर्वक लागू किया है। यह ठीक काम कर रहा है। केवल समस्या internal HandlerInterceptorयह है कि कुछ इसके अपवाद से पहले ही इसे संभाल लेता है custom HandlerInterceptor। afterCompletion()के बाद त्रुटि HandlerInterceptor की आंतरिक कार्यान्वयन से फेंक दिया जाता है विधि है जो है ओवरराइड कहा जाता है। क्या आपके पास इसका समाधान है?

— चेतन ओसवाल

Answer 1

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

यहाँ एक विन्यास वर्ग का उदाहरण दिया गया है:

@Configuration
public class WebMvcConfig extends WebMvcConfigurerAdapter {

  @Autowired 
  HandlerInterceptor yourInjectedInterceptor;

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(...)
    ...
    registry.addInterceptor(getYourInterceptor()); 
    registry.addInterceptor(yourInjectedInterceptor);
    // next two should be avoid -- tightly coupled and not very testable
    registry.addInterceptor(new YourInterceptor());
    registry.addInterceptor(new HandlerInterceptor() {
        ...
    });
  }
}

नोट @EnableWebMvc के साथ इसे एनोटेट न करें, यदि आप पीवीसी के लिए स्प्रिंग बूट्स ऑटो कॉन्फ़िगरेशन रखना चाहते हैं ।

Comments

अच्छा! अछा लगता है! रजिस्ट्री के अंदर क्या जाता है इसका कोई भी उदाहरण। Indceptor (...)? "..." का एक नमूना जानने के लिए उत्सुक हैं

— riship89

@ इंक्वायरी इंसेप्टर पर @Component एनोटेशन का उपयोग करें

— पाओलो बायवती

@ riship89 एक उदाहरण के लिए इसे चेकआउट करें: mkyong.com/spring-mvc/spring-mvc-handler-interceptors-example

— व्लाद मैनुअल मुरेन

मुझे त्रुटि मिलती है The type WebMvcConfigurerAdapter is deprecated। मैं स्प्रिंग वेब एमवीसी 5.0.6 का उपयोग कर रहा हूं

— जॉन हेनकेल

स्प्रिंग 5 में, WebMvcConfigurerAdapter को विस्तारित करने के बजाय केवल WebMvcConfigurer लागू करें। चूंकि जावा 8 इंटरफेस डिफ़ॉल्ट कार्यान्वयन की अनुमति देता है, इसलिए इसे एडेप्टर का उपयोग करने की आवश्यकता नहीं है (यही वजह है कि यह पदावनत है)।

— एड्रैगैफ

Answer 2

WebMvcConfigurerAdapterवसंत 5 के साथ पदावनत किया जाएगा। इसके जावदोक से :

5.0 के रूप में @deprecated {@link WebMvcConfigurer} में डिफ़ॉल्ट विधियां हैं (जावा 8 बेसलाइन द्वारा संभव है) और इस एडेप्टर की आवश्यकता के बिना सीधे लागू किया जा सकता है

जैसा कि ऊपर कहा गया है, आपको क्या करना चाहिए लागू करने WebMvcConfigurerऔर addInterceptorsविधि को ओवरराइड करने की विधि।

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyCustomInterceptor());
    }
}

Comments

आपका उत्तर अधूरा है क्योंकि यह MyCustomInterceptor

— पेटेरुला

Answer 3

स्प्रिंग बूट एप्लिकेशन में इंटरसेप्टर जोड़ने के लिए, निम्नलिखित करें

1. इंटरसेप्टर क्लास बनाएं

   public class MyCustomInterceptor implements HandlerInterceptor{
   
       //unimplemented methods comes here. Define the following method so that it     
       //will handle the request before it is passed to the controller.
   
       @Override
       public boolean preHandle(HttpServletRequest request,HttpServletResponse  response){
       //your custom logic here.
           return true;
       }
   }

2. कॉन्फ़िगरेशन क्लास को परिभाषित करें

   @Configuration
   public class MyConfig extends WebMvcConfigurerAdapter{
       @Override
       public void addInterceptors(InterceptorRegistry registry){
           registry.addInterceptor(new MyCustomInterceptor()).addPathPatterns("/**");
       }
   }

3. बस। अब आपके सभी अनुरोध MyCustomInterceptor के PreHandle () विधि के तहत परिभाषित तर्क से गुजरेंगे।

Comments

मैंने कुछ सामान्य मान्यताओं को करने के लिए मेरे आवेदन में आने वाले साइनअप अनुरोधों को रोकने के लिए इस तरीके का अनुसरण किया है। लेकिन समस्या यह है कि मुझे getReader() has already been called for this requestत्रुटि है। क्या वास्तविक अनुरोध की एक प्रति का उपयोग किए बिना इसे प्राप्त करने का कोई सरल तरीका है?

— विग्रह स्टेज

जब प्री-हैंडलर को कॉल किया जाता है, तो अनुरोध बॉडी उपलब्ध नहीं होती है, लेकिन केवल पैरामीटर होते हैं, रिक्वेस्ट बॉडी पर सत्यापन करने के लिए, पसंदीदा तरीका Aspect J का उपयोग करना और बनाना होगाAdvice

— Hima

Answer 4

चूंकि अब वेबमेस इनइंटरफेस (जैसा कि पहले से ही @sebdooe द्वारा नोट किया गया है) के बजाय अब लंबे समय से पदावनत किए गए अमूर्त WebMvcConfigurer एडॉप्टर के उपयोग के लिए सभी प्रतिक्रियाओं के बाद से, यहां एक इंटरसेप्टर के साथ स्प्रिंगबूट (2.1.4) एप्लिकेशन के लिए एक कार्यशील न्यूनतम उदाहरण है:

Minimal.java:

@SpringBootApplication
public class Minimal
{
    public static void main(String[] args)
    {
        SpringApplication.run(Minimal.class, args);
    }
}

MinimalController.java:

@RestController
@RequestMapping("/")
public class Controller
{
    @GetMapping("/")
    @ResponseBody
    public ResponseEntity<String> getMinimal()
    {
        System.out.println("MINIMAL: GETMINIMAL()");

        return new ResponseEntity<String>("returnstring", HttpStatus.OK);
    }
}

Config.java:

@Configuration
public class Config implements WebMvcConfigurer
{
    //@Autowired
    //MinimalInterceptor minimalInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry)
    {
        registry.addInterceptor(new MinimalInterceptor());
    }
}

MinimalInterceptor.java:

public class MinimalInterceptor extends HandlerInterceptorAdapter
{
    @Override
    public boolean preHandle(HttpServletRequest requestServlet, HttpServletResponse responseServlet, Object handler) throws Exception
    {
        System.out.println("MINIMAL: INTERCEPTOR PREHANDLE CALLED");

        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception
    {
        System.out.println("MINIMAL: INTERCEPTOR POSTHANDLE CALLED");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception) throws Exception
    {
        System.out.println("MINIMAL: INTERCEPTOR AFTERCOMPLETION CALLED");
    }
}

विज्ञापित के रूप में काम करता है

आउटपुट आपको कुछ इस तरह देगा:

> Task :Minimal.main()

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.4.RELEASE)

2019-04-29 11:53:47.560  INFO 4593 --- [           main] io.minimal.Minimal                       : Starting Minimal on y with PID 4593 (/x/y/z/spring-minimal/build/classes/java/main started by x in /x/y/z/spring-minimal)
2019-04-29 11:53:47.563  INFO 4593 --- [           main] io.minimal.Minimal                       : No active profile set, falling back to default profiles: default
2019-04-29 11:53:48.745  INFO 4593 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2019-04-29 11:53:48.780  INFO 4593 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2019-04-29 11:53:48.781  INFO 4593 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.17]
2019-04-29 11:53:48.892  INFO 4593 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2019-04-29 11:53:48.893  INFO 4593 --- [           main] o.s.web.context.ContextLoader            : Root WebApplicationContext: initialization completed in 1269 ms
2019-04-29 11:53:49.130  INFO 4593 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2019-04-29 11:53:49.375  INFO 4593 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2019-04-29 11:53:49.380  INFO 4593 --- [           main] io.minimal.Minimal                       : Started Minimal in 2.525 seconds (JVM running for 2.9)
2019-04-29 11:54:01.267  INFO 4593 --- [nio-8080-exec-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring DispatcherServlet 'dispatcherServlet'
2019-04-29 11:54:01.267  INFO 4593 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Initializing Servlet 'dispatcherServlet'
2019-04-29 11:54:01.286  INFO 4593 --- [nio-8080-exec-1] o.s.web.servlet.DispatcherServlet        : Completed initialization in 19 ms
MINIMAL: INTERCEPTOR PREHANDLE CALLED
MINIMAL: GETMINIMAL()
MINIMAL: INTERCEPTOR POSTHANDLE CALLED
MINIMAL: INTERCEPTOR AFTERCOMPLETION CALLED

Comments

लेकिन इसके लिए आपको WebMvcConfigurer से सभी तरीकों को लागू करना होगा, है ना?

— स्टीवन

नहीं, इसका (जावा 8) खाली डिफ़ॉल्ट कार्यान्वयन के साथ इंटरफ़ेस

— टॉम

Answer 5

मेरे पास WebMvcConfigurerAdapter का एक ही मुद्दा पदावनत किया जा रहा था। जब मैंने उदाहरण खोजे तो मुझे शायद ही कोई लागू कोड मिला हो। यहाँ एक कोड काम कर रहा है।

हैंडलरइंटरसेप्टर एडॉप्टर का विस्तार करने वाला एक वर्ग बनाएं

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import me.rajnarayanan.datatest.DataTestApplication;
@Component
public class EmployeeInterceptor extends HandlerInterceptorAdapter {
    private static final Logger logger = LoggerFactory.getLogger(DataTestApplication.class);
    @Override
    public boolean preHandle(HttpServletRequest request, 
            HttpServletResponse response, Object handler) throws Exception {

            String x = request.getMethod();
            logger.info(x + "intercepted");
        return true;
    }

}

इसके बाद WebMvcConfigurer इंटरफ़ेस लागू करें

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import me.rajnarayanan.datatest.interceptor.EmployeeInterceptor;
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    EmployeeInterceptor employeeInterceptor ;

    @Override
    public void addInterceptors(InterceptorRegistry registry){
        registry.addInterceptor(employeeInterceptor).addPathPatterns("/employee");
    }
}

Comments

यू केवल संकलन के मुद्दों के बिना इंटरफ़ेस पर एक विधि को कैसे ओवरराइड कर सकता है?

— xetra11

@ xetra11 मैं यह भी देखने की कोशिश कर रहा हूं कि क्या हम इस मामले में इस्तेमाल नहीं किए गए अन्य सभी तरीकों के बजाय केवल एक विधि को लागू कर सकते हैं। क्या यह संभव है? क्या आपको लगा कि बाहर?

— user09

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

— बॉब

Answer 6

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

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

http://springsandwich.com/

Comments

यह कमाल लग रहा है! मैंने एक मुद्दा बनाया है, जो स्प्रिंगसैंडविच के लिए मावेन सेंट्रल में उपलब्ध होने के लिए कह रहा है, यह उन परियोजनाओं के लिए उपयोग करना आसान है जो सीआई के तहत निर्माण कर रहे हैं या जो हरकोको के माध्यम से तैनात कर रहे हैं।

— ब्रेंडन दुगन

महान। क्या यह मावेन केंद्रीय भंडार में उपलब्ध है? अपनी वेबसाइट पर अपने git रिपॉजिटरी और संदर्भ के संदर्भ में मेरी वेबसाइट पर springsandwich.com ब्लॉगिंग करें

— Arpan Das

स्प्रिंगसैंडविच अब मावेन सेंट्रल में है

— मैग्नस

Answer 7

नीचे एक कार्यान्वयन है जिसका उपयोग मैं प्रत्येक HTTP अनुरोध को बाहर निकालने से पहले करता हूं और प्रतिक्रिया जो वापस आती है। इस कार्यान्वयन के साथ, मेरे पास एक एकल बिंदु भी है जहां मैं अनुरोध के साथ किसी भी हेडर मूल्य को पारित कर सकता हूं।

public class HttpInterceptor implements ClientHttpRequestInterceptor {
private Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public ClientHttpResponse intercept(
        HttpRequest request, byte[] body,
        ClientHttpRequestExecution execution
) throws IOException {
    HttpHeaders headers = request.getHeaders();
    headers.add("Accept", MediaType.APPLICATION_JSON_UTF8_VALUE);
    headers.add("Content-Type", MediaType.APPLICATION_JSON_VALUE);
    traceRequest(request, body);
    ClientHttpResponse response = execution.execute(request, body);
    traceResponse(response);
    return response;
}

private void traceRequest(HttpRequest request, byte[] body) throws IOException {
    logger.info("===========================Request begin======================================");
    logger.info("URI         : {}", request.getURI());
    logger.info("Method      : {}", request.getMethod());
    logger.info("Headers     : {}", request.getHeaders() );
    logger.info("Request body: {}", new String(body, StandardCharsets.UTF_8));
    logger.info("==========================Request end=========================================");
}

private void traceResponse(ClientHttpResponse response) throws IOException {
    logger.info("============================Response begin====================================");
    logger.info("Status code  : {}", response.getStatusCode());
    logger.info("Status text  : {}", response.getStatusText());
    logger.info("Headers      : {}", response.getHeaders());
    logger.info("=======================Response end===========================================");
}}

नीचे रेस्ट टेम्प्लेट बीन है

@Bean
public RestTemplate restTemplate(HttpClient httpClient)
{
    HttpComponentsClientHttpRequestFactory requestFactory =
            new HttpComponentsClientHttpRequestFactory();
    requestFactory.setHttpClient(httpClient);
    RestTemplate restTemplate=  new RestTemplate(requestFactory);
    List<ClientHttpRequestInterceptor> interceptors = restTemplate.getInterceptors();
    if (CollectionUtils.isEmpty(interceptors))
    {
        interceptors = new ArrayList<>();
    }
    interceptors.add(new HttpInterceptor());
    restTemplate.setInterceptors(interceptors);

    return restTemplate;
}