Contextes Web du printemps

1. Introduction

Lorsque vous utilisez Spring dans une application Web, nous avons plusieurs options pour organiser les contextes d'application qui relient tout cela.

Dans cet article, nous allons analyser et expliquer les options les plus courantes proposées par Spring.

2. Le contexte de l'application Web racine

Chaque application Web Spring a un contexte d'application associé qui est lié à son cycle de vie: le contexte d'application Web racine.

Il s'agit d'une ancienne fonctionnalité antérieure à Spring Web MVC, elle n'est donc liée spécifiquement à aucune technologie de framework Web.

Le contexte est démarré au démarrage de l'application, et il est détruit à son arrêt, grâce à un écouteur de contexte de servlet. Les types de contextes les plus courants peuvent également être actualisés au moment de l'exécution, bien que toutes les implémentations d' ApplicationContext n'aient pas cette capacité.

Le contexte dans une application Web est toujours une instance de WebApplicationContext . C'est une interface étendant ApplicationContext avec un contrat d'accès au ServletContext .

Quoi qu'il en soit, les applications ne devraient généralement pas se soucier de ces détails d'implémentation: le contexte de l'application Web racine est simplement un endroit centralisé pour définir les beans partagés.

2.1. Le ContextLoaderListener

Le contexte de l'application Web racine décrit dans la section précédente est géré par un écouteur de la classe org.springframework.web.context.ContextLoaderListener , qui fait partie du module spring-web .

Par défaut, l'écouteur chargera un contexte d'application XML à partir de /WEB-INF/applicationContext.xml . Cependant, ces valeurs par défaut peuvent être modifiées. Nous pouvons utiliser des annotations Java au lieu de XML, par exemple.

Nous pouvons configurer cet écouteur dans le descripteur de l'application web ( fichier web.xml ) ou par programme dans les environnements Servlet 3.x.

Dans les sections suivantes, nous examinerons chacune de ces options en détail.

2.2. Utilisation de web.xml et d'un contexte d'application XML

Lors de l'utilisation de web.xml , nous configurons l'auditeur comme d'habitude:

  org.springframework.web.context.ContextLoaderListener  

Nous pouvons spécifier un autre emplacement de la configuration de contexte XML avec le paramètre contextConfigLocation :

 contextConfigLocation /WEB-INF/rootApplicationContext.xml 

Ou plusieurs emplacements, séparés par des virgules:

 contextConfigLocation /WEB-INF/context1.xml, /WEB-INF/context2.xml 

Nous pouvons même utiliser des modèles:

 contextConfigLocation /WEB-INF/*-context.xml 

Dans tous les cas, un seul contexte est défini, en combinant toutes les définitions de bean chargées à partir des emplacements spécifiés.

2.3. Utilisation de web.xml et d'un contexte d'application Java

Nous pouvons également spécifier d'autres types de contextes en plus de celui basé sur XML par défaut. Voyons, par exemple, comment utiliser la configuration des annotations Java à la place.

Nous utilisons le paramètre contextClass pour indiquer à l'auditeur le type de contexte à instancier:

 contextClass  org.springframework.web.context.support.AnnotationConfigWebApplicationContext  

Chaque type de contexte peut avoir un emplacement de configuration par défaut. Dans notre cas, le AnnotationConfigWebApplicationContext n'en a pas, nous devons donc le fournir.

On peut ainsi lister une ou plusieurs classes annotées:

 contextConfigLocation  com.baeldung.contexts.config.RootApplicationConfig, com.baeldung.contexts.config.NormalWebAppConfig  

Ou nous pouvons indiquer au contexte d'analyser un ou plusieurs packages:

 contextConfigLocation com.baeldung.bean.config 

Et, bien sûr, nous pouvons mélanger et assortir les deux options.

2.4. Configuration par programmation avec Servlet 3.x

La version 3 de l'API Servlet a rendu la configuration via le fichier web.xml complètement facultative. Les bibliothèques peuvent fournir leurs fragments Web, qui sont des éléments de configuration XML qui peuvent enregistrer des écouteurs, des filtres, des servlets, etc.

En outre, les utilisateurs ont accès à une API qui permet de définir par programme chaque élément d'une application basée sur un servlet.

Le module spring-web utilise ces fonctionnalités et propose son API pour enregistrer les composants de l'application au démarrage.

Spring analyse le chemin de classe de l'application à la recherche d'instances de la classe org.springframework.web.WebApplicationInitializer . Il s'agit d'une interface avec une seule méthode, void onStartup (ServletContext servletContext) lève ServletException , qui est appelée au démarrage de l'application.

Voyons maintenant comment nous pouvons utiliser cette fonctionnalité pour créer les mêmes types de contextes d'application Web racine que nous avons vus précédemment.

2.5. Utilisation de Servlet 3.x et d'un contexte d'application XML

Commençons par un contexte XML, comme dans la section 2.2.

Nous allons implémenter la méthode onStartup susmentionnée :

public class ApplicationInitializer implements WebApplicationInitializer { @Override public void onStartup(ServletContext servletContext) throws ServletException { //... } }

Décomposons la mise en œuvre ligne par ligne.

Nous créons d'abord un contexte racine. Puisque nous voulons utiliser XML, il doit s'agir d'un contexte d'application basé sur XML, et puisque nous sommes dans un environnement Web, il doit également implémenter WebApplicationContext .

La première ligne est donc la version explicite du paramètre contextClass que nous avons rencontré précédemment, avec laquelle nous décidons quelle implémentation de contexte spécifique utiliser:

XmlWebApplicationContext rootContext = new XmlWebApplicationContext();

Ensuite, dans la deuxième ligne, nous indiquons au contexte où charger ses définitions de bean. Encore une fois, setConfigLocations est l'analogue programmatique du paramètre contextConfigLocation dans web.xml :

rootContext.setConfigLocations("/WEB-INF/rootApplicationContext.xml");

Enfin, nous créons un ContextLoaderListener avec le contexte racine et nous l'enregistrons avec le conteneur de servlet. Comme nous pouvons le voir, ContextLoaderListener a un constructeur approprié qui prend un WebApplicationContext et le met à disposition de l'application:

servletContext.addListener(new ContextLoaderListener(rootContext));

2.6. Utilisation de Servlet 3.x et d'un contexte d'application Java

Si nous voulons utiliser un contexte basé sur des annotations, nous pourrions modifier l'extrait de code dans la section précédente pour qu'il instancie plutôt un AnnotationConfigWebApplicationContext .

Cependant, voyons une approche plus spécialisée pour obtenir le même résultat.

The WebApplicationInitializer class that we've seen earlier is a general-purpose interface. It turns out that Spring provides a few more specific implementations, including an abstract class called AbstractContextLoaderInitializer.

Its job, as the name implies, is to create a ContextLoaderListener and register it with the servlet container.

We only have to tell it how to build the root context:

public class AnnotationsBasedApplicationInitializer extends AbstractContextLoaderInitializer { @Override protected WebApplicationContext createRootApplicationContext() { AnnotationConfigWebApplicationContext rootContext = new AnnotationConfigWebApplicationContext(); rootContext.register(RootApplicationConfig.class); return rootContext; } }

Here we can see that we no longer need to register the ContextLoaderListener, which saves us from a little bit of boilerplate code.

Note also the use of the register method that is specific to AnnotationConfigWebApplicationContext instead of the more generic setConfigLocations: by invoking it, we can register individual @Configuration annotated classes with the context, thus avoiding package scanning.

3. Dispatcher Servlet Contexts

Let's now focus on another type of application context. This time, we'll be referring to a feature which is specific to Spring MVC, rather than part of Spring's generic web application support.

Spring MVC applications have at least one Dispatcher Servlet configured (but possibly more than one, we'll talk about that case later). This is the servlet that receives incoming requests, dispatches them to the appropriate controller method, and returns the view.

Each DispatcherServlet has an associated application context. Beans defined in such contexts configure the servlet and define MVC objects like controllers and view resolvers.

Let's see how to configure the servlet's context first. We'll look at some in-depth details later.

3.1. Using web.xml and an XML Application Context

DispatcherServlet is typically declared in web.xml with a name and a mapping:

 normal-webapp  org.springframework.web.servlet.DispatcherServlet  1   normal-webapp /api/* 

If not otherwise specified, the name of the servlet is used to determine the XML file to load. In our example, we'll use the file WEB-INF/normal-webapp-servlet.xml.

We can also specify one or more paths to XML files, in a similar fashion to ContextLoaderListener:

 ...  contextConfigLocation /WEB-INF/normal/*.xml  

3.2. Using web.xml and a Java Application Context

When we want to use a different type of context we proceed like with ContextLoaderListener, again. That is, we specify a contextClass parameter along with a suitable contextConfigLocation:

 normal-webapp-annotations  org.springframework.web.servlet.DispatcherServlet   contextClass  org.springframework.web.context.support.AnnotationConfigWebApplicationContext    contextConfigLocation com.baeldung.contexts.config.NormalWebAppConfig  1 

3.3. Using Servlet 3.x and an XML Application Context

Again, we'll look at two different methods for programmatically declaring a DispatcherServlet, and we'll apply one to an XML context and the other to a Java context.

So, let's start with a generic WebApplicationInitializer and an XML application context.

As we've seen previously, we have to implement the onStartup method. However, this time we'll create and register a dispatcher servlet, too:

XmlWebApplicationContext normalWebAppContext = new XmlWebApplicationContext(); normalWebAppContext.setConfigLocation("/WEB-INF/normal-webapp-servlet.xml"); ServletRegistration.Dynamic normal = servletContext.addServlet("normal-webapp", new DispatcherServlet(normalWebAppContext)); normal.setLoadOnStartup(1); normal.addMapping("/api/*");

We can easily draw a parallel between the above code and the equivalent web.xml configuration elements.

3.4. Using Servlet 3.x and a Java Application Context

This time, we'll configure an annotations-based context using a specialized implementation of WebApplicationInitializer: AbstractDispatcherServletInitializer.

That's an abstract class that, besides creating a root web application context as previously seen, allows us to register one dispatcher servlet with minimum boilerplate:

@Override protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext secureWebAppContext = new AnnotationConfigWebApplicationContext(); secureWebAppContext.register(SecureWebAppConfig.class); return secureWebAppContext; } @Override protected String[] getServletMappings() { return new String[] { "/s/api/*" }; }

Here we can see a method for creating the context associated with the servlet, exactly like we've seen before for the root context. Also, we have a method to specify the servlet's mappings, as in web.xml.

4. Parent and Child Contexts

So far, we've seen two major types of contexts: the root web application context and the dispatcher servlet contexts. Then, we might have a question: are those contexts related?

It turns out that yes, they are. In fact, the root context is the parent of every dispatcher servlet context. Thus, beans defined in the root web application context are visible to each dispatcher servlet context, but not vice versa.

So, typically, the root context is used to define service beans, while the dispatcher context contains those beans that are specifically related to MVC.

Note that we've also seen ways to create the dispatcher servlet context programmatically. If we manually set its parent, then Spring does not override our decision, and this section no longer applies.

In simpler MVC applications, it's sufficient to have a single context associated to the only one dispatcher servlet. There's no need for overly complex solutions!

Still, the parent-child relationship becomes useful when we have multiple dispatcher servlets configured. But when should we bother to have more than one?

In general, we declare multiple dispatcher servlets when we need multiple sets of MVC configuration. For example, we may have a REST API alongside a traditional MVC application or an unsecured and a secure section of a website:

Note: when we extend AbstractDispatcherServletInitializer (see section 3.4), we register both a root web application context and a single dispatcher servlet.

So, if we want more than one servlet, we need multiple AbstractDispatcherServletInitializer implementations. However, we can only define one root context, or the application won't start.

Fortunately, the createRootApplicationContext method can return null. Thus, we can have one AbstractContextLoaderInitializer and many AbstractDispatcherServletInitializer implementations that don't create a root context. In such a scenario, it is advisable to order the initializers with @Order explicitly.

Also, note that AbstractDispatcherServletInitializer registers the servlet under a given name (dispatcher) and, of course, we cannot have multiple servlets with the same name. So, we need to override getServletName:

@Override protected String getServletName() { return "another-dispatcher"; }

5. A Parent and Child Context Example

Suppose that we have two areas of our application, for example a public one which is world accessible and a secured one, with different MVC configurations. Here, we'll just define two controllers that output a different message.

Also, suppose that some of the controllers need a service that holds significant resources; a ubiquitous case is persistence. Then, we'll want to instantiate that service only once, to avoid doubling its resource usage, and because we believe in the Don't Repeat Yourself principle!

Let's now proceed with the example.

5.1. The Shared Service

In our hello world example, we settled for a simpler greeter service instead of persistence:

package com.baeldung.contexts.services; @Service public class GreeterService { @Resource private Greeting greeting; public String greet() { return greeting.getMessage(); } }

We'll declare the service in the root web application context, using component scanning:

@Configuration @ComponentScan(basePackages = { "com.baeldung.contexts.services" }) public class RootApplicationConfig { //... }

We might prefer XML instead:

5.2. The Controllers

Let's define two simple controllers which use the service and output a greeting:

package com.baeldung.contexts.normal; @Controller public class HelloWorldController { @Autowired private GreeterService greeterService; @RequestMapping(path = "/welcome") public ModelAndView helloWorld() { String message = "

Normal " + greeterService.greet() + "

"; return new ModelAndView("welcome", "message", message); } } //"Secure" Controller package com.baeldung.contexts.secure; String message = "

Secure " + greeterService.greet() + "

";

As we can see, the controllers lie in two different packages and print different messages: one says “normal”, the other “secure”.

5.3. The Dispatcher Servlet Contexts

As we said earlier, we're going to have two different dispatcher servlet contexts, one for each controller. So, let's define them, in Java:

//Normal context @Configuration @EnableWebMvc @ComponentScan(basePackages = { "com.baeldung.contexts.normal" }) public class NormalWebAppConfig implements WebMvcConfigurer { //... } //"Secure" context @Configuration @EnableWebMvc @ComponentScan(basePackages = { "com.baeldung.contexts.secure" }) public class SecureWebAppConfig implements WebMvcConfigurer { //... }

Or, if we prefer, in XML:

5.4. Putting It All Together

Now that we have all the pieces, we just need to tell Spring to wire them up. Recall that we need to load the root context and define the two dispatcher servlets. Although we've seen multiple ways to do that, we'll now focus on two scenarios, a Java one and an XML one. Let's start with Java.

We'll define an AbstractContextLoaderInitializer to load the root context:

@Override protected WebApplicationContext createRootApplicationContext() { AnnotationConfigWebApplicationContext rootContext = new AnnotationConfigWebApplicationContext(); rootContext.register(RootApplicationConfig.class); return rootContext; } 

Then, we need to create the two servlets, thus we'll define two subclasses of AbstractDispatcherServletInitializer. First, the “normal” one:

@Override protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext normalWebAppContext = new AnnotationConfigWebApplicationContext(); normalWebAppContext.register(NormalWebAppConfig.class); return normalWebAppContext; } @Override protected String[] getServletMappings() { return new String[] { "/api/*" }; } @Override protected String getServletName() { return "normal-dispatcher"; } 

Then, the “secure” one, which loads a different context and is mapped to a different path:

@Override protected WebApplicationContext createServletApplicationContext() { AnnotationConfigWebApplicationContext secureWebAppContext = new AnnotationConfigWebApplicationContext(); secureWebAppContext.register(SecureWebAppConfig.class); return secureWebAppContext; } @Override protected String[] getServletMappings() { return new String[] { "/s/api/*" }; } @Override protected String getServletName() { return "secure-dispatcher"; }

And we're done! We've just applied what we touched in previous sections.

We can do the same with web.xml, again just by combining the pieces we've discussed so far.

Define a root application context:

  org.springframework.web.context.ContextLoaderListener   

A “normal” dispatcher context:

 normal-webapp  org.springframework.web.servlet.DispatcherServlet  1   normal-webapp /api/*  

And, finally, a “secure” context:

 secure-webapp  org.springframework.web.servlet.DispatcherServlet  1   secure-webapp /s/api/* 

6. Combining Multiple Contexts

There are other ways than parent-child to combine multiple configuration locations, to split big contexts and better separate different concerns. We've seen one example already: when we specify contextConfigLocation with multiple paths or packages, Spring builds a single context by combining all the bean definitions, as if they were written in a single XML file or Java class, in order.

However, we can achieve a similar effect with other means and even use different approaches together. Let's examine our options.

One possibility is component scanning, which we explain in another article.

6.1. Importing a Context Into Another

Alternatively, we can have a context definition import another one. Depending on the scenario, we have different kinds of imports.

Importing a @Configuration class in Java:

@Configuration @Import(SomeOtherConfiguration.class) public class Config { ... }

Loading some other type of resource, for example, an XML context definition, in Java:

@Configuration @ImportResource("classpath:basicConfigForPropertiesTwo.xml") public class Config { ... }

Finally, including an XML file in another one:

Thus, we have many ways to organize the services, components, controllers, etc., that collaborate to create our awesome application. And the nice thing is that IDEs understand them all!

7. Spring Boot Web Applications

Spring Boot automatically configures the components of the application, so, generally, there is less need to think about how to organize them.

Still, under the hood, Boot uses Spring features, including those that we've seen so far. Let's see a couple of noteworthy differences.

Spring Boot web applications running in an embedded container don't run any WebApplicationInitializer by design.

Should it be necessary, we can write the same logic in a SpringBootServletInitializer or a ServletContextInitializer instead, depending on the chosen deployment strategy.

However, for adding servlets, filters, and listeners as seen in this article, it is not necessary to do so. In fact, Spring Boot automatically registers every servlet-related bean to the container:

@Bean public Servlet myServlet() { ... }

The objects so defined are mapped according to conventions: filters are automatically mapped to /*, that is, to every request. If we register a single servlet, it is mapped to /, otherwise, each servlet is mapped to its bean name.

Si les conventions ci-dessus ne fonctionnent pas pour nous, nous pouvons définir un FilterRegistrationBean , ServletRegistrationBean ou ServletListenerRegistrationBean à la place. Ces classes nous permettent de contrôler les aspects fins de l'enregistrement.

8. Conclusions

Dans cet article, nous avons donné une vue détaillée des différentes options disponibles pour structurer et organiser une application Web Spring.

Nous avons laissé de côté certaines fonctionnalités, notamment la prise en charge d'un contexte partagé dans les applications d'entreprise, qui, au moment de la rédaction de cet article, est toujours absente de Spring 5.

L'implémentation de tous ces exemples et extraits de code se trouve dans le projet GitHub.