Interface HandlerMethodInterceptor

All Known Implementing Classes:
WebEventPublisher

public interface HandlerMethodInterceptor
HandlerMethod Interceptor that allows for customized HandlerMethod execution chains. Applications can register any number of existing or custom interceptors for certain groups of handlers, to add common preprocessing behavior without needing to modify each handler implementation.

A HandlerInterceptor gets called before the appropriate HandlerAdapter triggers the execution of the handler itself.

Since:
1.0.0
Author:
Mercy
See Also:
  • HandlerMethod
  • org.springframework.web.servlet.DispatcherServlet
  • org.springframework.web.reactive.DispatcherHandler
  • org.springframework.web.servlet.HandlerMapping
  • org.springframework.web.reactive.HandlerMapping
  • org.springframework.web.servlet.HandlerAdapter
  • org.springframework.web.reactive.HandlerAdapter
  • Method Details

    • beforeExecute

      default void beforeExecute(org.springframework.web.method.HandlerMethod handlerMethod, Object[] args, org.springframework.web.context.request.NativeWebRequest request) throws Exception
      Interception point before the execution of a HandlerMethod. Called after HandlerMapping determined an appropriate handler object, but before HandlerAdapter invokes the handler.
      Parameters:
      handlerMethod - HandlerMethod
      args - the resolved arguments of HandlerMethod
      request - WebRequest
      Throws:
      Exception - if any error caused
    • afterExecute

      default void afterExecute(org.springframework.web.method.HandlerMethod handlerMethod, Object[] args, @Nullable Object returnValue, @Nullable Throwable error, org.springframework.web.context.request.NativeWebRequest request) throws Exception
      Interception point after successful execution of a HandlerMethod. Called after HandlerAdapter actually invoked the handler.
      Parameters:
      handlerMethod - HandlerMethod
      args - the resolved arguments of HandlerMethod
      returnValue - the return value of HandlerMethod
      error - the error after HandlerMethod invocation
      request - WebRequest
      Throws:
      Exception - if any error caused