Une introduction au Spring DispatcherServlet

1. Introduction

En termes simples, dans le modèle de conception du contrôleur frontal , un seul contrôleur est chargé de diriger les requêtes HttpRequests entrantes vers tous les autres contrôleurs et gestionnaires d'une application .

Le DispatcherServlet de Spring implémente ce modèle et est donc responsable de la coordination correcte des HttpRequests vers leurs gestionnaires droits.

Dans cet article, nous examinerons le flux de travail de traitement des demandes de Spring DispatcherServlet et comment implémenter plusieurs des interfaces qui participent à ce flux de travail.

2. Traitement des requêtes DispatcherServlet

Essentiellement, un DispatcherServlet gère une HttpRequest entrante , délègue la demande et traite cette demande en fonction des interfaces HandlerAdapter configurées qui ont été implémentées dans l'application Spring avec les annotations qui l'accompagnent spécifiant les gestionnaires, les points de terminaison du contrôleur et les objets de réponse.

Voyons plus en détail comment un DispatcherServlet traite un composant:

  • le WebApplicationContext associé à un DispatcherServlet sous la clé DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE est recherché et mis à disposition de tous les éléments du processus
  • Le DispatcherServlet trouve toutes les implémentations de l' interface HandlerAdapter configurées pour votre répartiteur à l'aide de getHandler () - chaque implémentation trouvée et configurée gère la demande via handle () pendant le reste du processus
  • le LocaleResolver est facultativement lié à la demande pour permettre aux éléments du processus de résoudre les paramètres régionaux
  • le ThemeResolver est éventuellement lié à la demande de laisser des éléments, tels que des vues, déterminer le thème à utiliser
  • si un MultipartResolver est spécifié, la demande est inspectée pour MultipartFile s - tout trouvé est enveloppé dans un MultipartHttpServletRequest pour un traitement ultérieur
  • Les implémentations HandlerExceptionResolver déclarées dans WebApplicationContext récupèrent les exceptions levées lors du traitement de la requête

Vous pouvez en savoir plus sur toutes les méthodes d'enregistrement et de configuration d'un DispatcherServlet ici.

3. Interfaces HandlerAdapter

L' interface HandlerAdapter facilite l'utilisation de contrôleurs, de servlets, de requêtes HttpRequests et de chemins HTTP via plusieurs interfaces spécifiques. L' interface HandlerAdapter joue ainsi un rôle essentiel à travers les nombreuses étapes du workflow de traitement des requêtes DispatcherServlet .

Tout d'abord, chaque implémentation de HandlerAdapter est placée dans HandlerExecutionChain à partir de la méthode getHandler () de votre répartiteur . Ensuite, chacune de ces implémentations gère () l' objet HttpServletRequest au fur et à mesure que la chaîne d'exécution se poursuit.

Dans les sections suivantes, nous explorerons plus en détail quelques-uns des HandlerAdapters les plus importants et les plus couramment utilisés .

3.1. Mappages

Pour comprendre les mappages, nous devons d'abord examiner comment annoter les contrôleurs, car les contrôleurs sont si essentiels à l' interface HandlerMapping .

Le SimpleControllerHandlerAdapter permet l'implémentation d'un contrôleur explicitement sans annotation @Controller .

Les RequestMappingHandlerAdapter méthodes de supports annotés avec l' @RequestMapping annotation .

Nous allons nous concentrer sur l' annotation @Controller ici, mais une ressource utile avec plusieurs exemples utilisant SimpleControllerHandlerAdapter est également disponible.

L' annotation @RequestMapping définit le point de terminaison spécifique auquel un gestionnaire sera disponible dans le WebApplicationContext qui lui est associé.

Voyons un exemple de contrôleur qui expose et gère le point de terminaison '/ user / example' :

@Controller @RequestMapping("/user") @ResponseBody public class UserController { @GetMapping("/example") public User fetchUserExample() { // ... } }

Les chemins spécifiés par l' annotation @RequestMapping sont gérés en interne via l' interface HandlerMapping .

La structure des URL est naturellement relative au DispatcherServlet lui-même - et déterminée par le mappage de servlet.

Ainsi, si le DispatcherServlet est mappé à '/', alors tous les mappages seront couverts par ce mappage.

Si, cependant, le mappage de servlet est ' / dispatcher ' à la place, toutes les annotations @ RequestMapping seront relatives à cette URL racine.

N'oubliez pas que «/» n'est pas la même chose que «/ *» pour les mappages de servlet! «/» est le mappage par défaut et expose toutes les URL à la zone de responsabilité du répartiteur.

‘/*' is confusing to a lot of newer Spring developers. It does not specify that all paths with the same URL context are under the dispatcher's area of responsibility. Instead, it overrides and ignores the other dispatcher mappings. So, ‘/example' will come up as a 404!

For that reason, ‘/*' shouldn't be used except in very limited circumstances (like configuring a filter).

3.2. HTTP Request Handling

The core responsibility of a DispatcherServlet is to dispatch incoming HttpRequests to the correct handlers specified with the @Controller or @RestController annotations.

As a side note, the main difference between @Controller and @RestController is how the response is generated – the @RestController also defines @ResponseBody by default.

A writeup where we go into much greater depth regarding Spring's controllers can be found here.

3.3. The ViewResolver Interface

A ViewResolver is attached to a DispatcherServlet as a configuration setting on an ApplicationContext object.

A ViewResolver determines both what kind of views are served by the dispatcher and from where they are served.

Here's an example configuration which we'll place into our AppConfig for rendering JSP pages:

@Configuration @EnableWebMvc @ComponentScan("com.baeldung.springdispatcherservlet") public class AppConfig implements WebMvcConfigurer { @Bean public UrlBasedViewResolver viewResolver() { UrlBasedViewResolver resolver = new UrlBasedViewResolver(); resolver.setPrefix("/WEB-INF/view/"); resolver.setSuffix(".jsp"); resolver.setViewClass(JstlView.class); return resolver; } }

Very straight-forward! There are three main parts to this:

  1. setting the prefix, which sets the default URL path to find the set views within
  2. the default view type which is set via the suffix
  3. setting a view class on the resolver which allows technologies like JSTL or Tiles to be associated with the rendered views

One common question involves how precisely a dispatcher's ViewResolverand the overall project directory structure are related. Let's take a look at the basics.

Here's an example path configuration for an InternalViewResolver using Spring's XML configuration:

For the sake of our example, we'll assume that our application is being hosted on:

//localhost:8080/

This is the default address and port for a locally hosted Apache Tomcat server.

Assuming that our application is called dispatcherexample-1.0.0, our JSP views will be accessible from:

//localhost:8080/dispatcherexample-1.0.0/jsp/

The path for these views within an ordinary Spring project with Maven is this:

src -| main -| java resources webapp -| jsp WEB-INF

The default location for views is within WEB-INF. The path specified for our InternalViewResolver in the snippet above determines the subdirectory of ‘src/main/webapp' in which your views will be available.

3.4. The LocaleResolver Interface

The primary way to customize session, request, or cookie information for our dispatcher is through the LocaleResolver interface.

CookieLocaleResolver is an implementation allowing the configuration of stateless application properties using cookies. Let's add it to AppConfig.

@Bean public CookieLocaleResolver cookieLocaleResolverExample() { CookieLocaleResolver localeResolver = new CookieLocaleResolver(); localeResolver.setDefaultLocale(Locale.ENGLISH); localeResolver.setCookieName("locale-cookie-resolver-example"); localeResolver.setCookieMaxAge(3600); return localeResolver; } @Bean public LocaleResolver sessionLocaleResolver() { SessionLocaleResolver localeResolver = new SessionLocaleResolver(); localeResolver.setDefaultLocale(Locale.US); localResolver.setDefaultTimeZone(TimeZone.getTimeZone("UTC")); return localeResolver; } 

SessionLocaleResolver allows for session-specific configuration in a stateful application.

The setDefaultLocale() method represents a geographical, political, or cultural region, whereas setDefaultTimeZone( ) determines the relevant TimeZone object for the application Bean in question.

Both methods are available on each of the above implementations of LocaleResolver.

3.5. The ThemeResolver Interface

Spring provides stylistic theming for our views.

Let's take a look at how to configure our dispatcher to handle themes.

First, let's set up all the configuration necessary to find and use our static theme files. We need to set a static resource location for our ThemeSource to configure the actual Themes themselves (Theme objects contain all of the configuration information stipulated in those files). Add this to AppConfig:

@Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("/resources/**") .addResourceLocations("/", "/resources/") .setCachePeriod(3600) .resourceChain(true) .addResolver(new PathResourceResolver()); } @Bean public ResourceBundleThemeSource themeSource() { ResourceBundleThemeSource themeSource = new ResourceBundleThemeSource(); themeSource.setDefaultEncoding("UTF-8"); themeSource.setBasenamePrefix("themes."); return themeSource; } 

Requests managed by the DispatcherServlet can modify the theme through a specified parameter passed into setParamName() available on the ThemeChangeInterceptor object. Add to AppConfig:

@Bean public CookieThemeResolver themeResolver() { CookieThemeResolver resolver = new CookieThemeResolver(); resolver.setDefaultThemeName("example"); resolver.setCookieName("example-theme-cookie"); return resolver; } @Bean public ThemeChangeInterceptor themeChangeInterceptor() { ThemeChangeInterceptor interceptor = new ThemeChangeInterceptor(); interceptor.setParamName("theme"); return interceptor; } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(themeChangeInterceptor()); } 

The following JSP tag is added to our view to make the correct styling appear:


     

The following URL request renders the example theme using the ‘theme' parameter passed into our configured ThemeChangeIntercepter:

//localhost:8080/dispatcherexample-1.0.0/?theme=example

3.6. The MultipartResolver Interface

A MultipartResolver implementation inspects a request for multiparts and wraps them in a MultipartHttpServletRequest for further processing by other elements in the process if at least one multipart is found. Add to AppConfig:

@Bean public CommonsMultipartResolver multipartResolver() throws IOException { CommonsMultipartResolver resolver = new CommonsMultipartResolver(); resolver.setMaxUploadSize(10000000); return resolver; } 

Now that we've configured our MultipartResolver bean, let's set up a controller to process MultipartFile requests:

@Controller public class MultipartController { @Autowired ServletContext context; @PostMapping("/upload") public ModelAndView FileuploadController( @RequestParam("file") MultipartFile file) throws IOException { ModelAndView modelAndView = new ModelAndView("index"); InputStream in = file.getInputStream(); String path = new File(".").getAbsolutePath(); FileOutputStream f = new FileOutputStream( path.substring(0, path.length()-1) + "/uploads/" + file.getOriginalFilename()); int ch; while ((ch = in.read()) != -1) { f.write(ch); } f.flush(); f.close(); in.close(); modelAndView.getModel() .put("message", "File uploaded successfully!"); return modelAndView; } }

We can use a normal form to submit a file to the specified endpoint. Uploaded files will be available in ‘CATALINA_HOME/bin/uploads'.

3.7. The HandlerExceptionResolver Interface

Spring's HandlerExceptionResolver provides uniform error handling for an entire web application, a single controller, or a set of controllers.

To provide application-wide custom exception handling, create a class annotated with @ControllerAdvice:

@ControllerAdvice public class ExampleGlobalExceptionHandler { @ExceptionHandler @ResponseBody public String handleExampleException(Exception e) { // ... } }

Any methods within that class annotated with @ExceptionHandler will be available on every controller within dispatcher's area of responsibility.

Implementations of the HandlerExceptionResolver interface in the DispatcherServlet's ApplicationContext are available to intercept a specific controller under that dispatcher's area of responsibility whenever @ExceptionHandler is used as an annotation, and the correct class is passed in as a parameter:

@Controller public class FooController{ @ExceptionHandler({ CustomException1.class, CustomException2.class }) public void handleException() { // ... } // ... }

The handleException() method will now serve as an exception handler for FooController in our example above if either exception CustomException1 or CustomException2 occurs.

Here's an article that goes more in-depth about exception handling in a Spring web application.

4. Conclusion

In this tutorial, we've reviewed Spring's DispatcherServlet and several ways to configure it.

As always, the source code used in this tutorial is available over on Github.