Comment créer un servlet dans Spring?

Dans Spring, vous pouvez créer un servlet de plusieurs manières :

1. Utilisation de HttpServletBean ou FrameworkServlet : Spring fournit des classes abstraites qui étendent HttpServlet, facilitant l'intégration avec le contexte Spring. FrameworkServlet est plus général et est utilisé pour de nombreux frameworks web Spring (par exemple, DispatcherServlet).

   // Exemple d'un servlet simple héritant de FrameworkServlet
   // Dans une application réelle, des configurations supplémentaires sont généralement nécessaires
   public class MySpringServlet extends org.springframework.web.servlet.FrameworkServlet {
   
       @Override
       protected void doService(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException, java.io.IOException {
           // Logique de traitement de la requête
           response.getWriter().write("Bonjour de MySpringServlet!");
       }
   }
   

2. Enregistrement manuel avec les annotations @Bean et ServletRegistrationBean : Dans la configuration Spring (généralement dans une classe annotée avec @Configuration), vous pouvez créer une instance de votre servlet et l'envelopper dans ServletRegistrationBean. Cela permet de configurer de manière flexible le mappage URL et les paramètres du servlet.

   import org.springframework.boot.web.servlet.ServletRegistrationBean;
   import org.springframework.context.annotation.Bean;
   import org.springframework.context.annotation.Configuration;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   import java.io.IOException;
   
   @Configuration
   public class ServletConfig {
   
       @Bean
       public ServletRegistrationBean<HttpServlet> myCustomServletRegistration() {
           ServletRegistrationBean<HttpServlet> registration = new ServletRegistrationBean<>(new MyCustomServlet());
           registration.addUrlMappings("/custom-servlet/*"); // Mappage URL
           registration.setLoadOnStartup(1); // Pour l'initialisation au démarrage
           return registration;
       }
   
       // Exemple de servlet personnalisé
       public static class MyCustomServlet extends HttpServlet {
           @Override
           protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
               response.getWriter().write("Ceci est un servlet personnalisé!");
           }
       }
   }
   

3. Utilisation des mécanismes standard des servlets dans Spring Boot (@ServletComponentScan) : En Spring Boot, si vous ajoutez l'annotation @ServletComponentScan à la classe principale de l'application (ou à toute classe de configuration), Spring Boot scannera automatiquement les packages à la recherche de classes annotées avec les annotations standard des servlets (@WebServlet, @WebFilter, @WebListener) et les enregistrera.

   import org.springframework.boot.SpringApplication;
   import org.springframework.boot.autoconfigure.SpringBootApplication;
   import org.springframework.boot.web.servlet.ServletComponentScan;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   import java.io.IOException;
   
   @SpringBootApplication
   @ServletComponentScan // Active la recherche d'annotations de servlets
   public class MySpringBootApp {
       public static void main(String[] args) {
           SpringApplication.run(MySpringBootApp.class, args);
       }
   
       // Exemple de servlet qui sera enregistré automatiquement
       @WebServlet("/auto-servlet")
       public static class AutoRegisteredServlet extends HttpServlet {
           @Override
           protected void doGet(HttpServletRequest request, HttpServletResponse response) throws IOException {
               response.getWriter().write("Servlet enregistré automatiquement!");
           }
       }
   }
   

Le choix de la méthode dépend de vos besoins. Pour une intégration avec le contexte Spring et ses fonctionnalités (par exemple, DI), on utilise souvent FrameworkServlet ou l'enregistrement via ServletRegistrationBean. Pour des cas simples ou la migration de servlets existants, @ServletComponentScan peut suffire. Dans la majorité des applications web Spring MVC, le servlet principal est DispatcherServlet, qui est configuré automatiquement dans Spring Boot.