Code Monkey home page Code Monkey logo

springboot-interceptors's Introduction

Interceptors in SpringBoot

In a SpringBoot application you want to do something to the request before your controller handles it or to the response before it's returned back to the client.

Interceptors types

  • General purpose interceptor : runs for all requests
  • Single purpose interceptor : runs for a specific controller (and/or) specific URL

Interceptors configuration

All interceptors configurations are done within a configuration class in SpringBoot.

  • The interceptor configuration class should implement WebMvcConfigurer
  • The configuration class should override the addInterceptors method
  • Within the addInterceptors method, use interceptorRegistry to add a specific interceptor to Spring Context, using the addInterceptor method

๐Ÿ’ก multiple interceptors could be added to the configuration. Spring provides a lot of options to deal with like the order method to specify the interceptors execution order. addPathPatterns method to deal with specific URL (single purpose interceptor)

Interceptors implementation

To implement interceptors, you should :

  • Implement the HandlerInterceptor class
  • Override the preHandle, postHandle and afterCompletion methods

๐Ÿ’ก preHandle will be executed before the request reaches then handler (controller) : it returns a boolean; if false then the interceptor will be the last step of the request handling (controller will not be executed) postHandle will be executed after the handler (controller) already served the request afterCompletion will be executed after the reauest and the view rendering, in case a view engine is executed

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.