Как реализовать одновременный запуск сервлета с запуском приложения?

Для одновременного запуска сервлета с запуском приложения используются следующие механизмы:

1. Элемент <load-on-startup> в web.xml:

   • В дескрипторе развертывания web.xml для каждого сервлета, который должен быть загружен при старте приложения, добавляется элемент <load-on-startup>.
   • Значение этого элемента определяет порядок загрузки сервлетов. Положительное целое число указывает порядок загрузки (меньшее число загружается первым). Если значение равно нулю или отрицательно, загрузка происходит "лениво" (по первому запросу к сервлету).
   • Если несколько сервлетов имеют одинаковое значение, порядок загрузки не гарантируется.

   <!-- web.xml -->
   <web-app>
       <servlet>
           <servlet-name>MyStartupServlet</servlet-name>
           <servlet-class>com.example.MyStartupServlet</servlet-class>
           <load-on-startup>1</load-on-startup> <!-- Загрузить при старте, в первую очередь -->
       </servlet>
       <servlet>
           <servlet-name>AnotherStartupServlet</servlet-name>
           <servlet-class>com.example.AnotherStartupServlet</servlet-class>
           <load-on-startup>2</load-on-startup> <!-- Загрузить при старте, после MyStartupServlet -->
       </servlet>
       <!-- ... другие элементы ... -->
   </web-app>
   

2. Аннотация @WebServlet с параметром loadOnStartup:

   • В контейнерах сервлетов, поддерживающих спецификацию Servlet 3.0 и выше, можно использовать аннотацию @WebServlet прямо над классом сервлета.
   • Параметр loadOnStartup в аннотации выполняет ту же роль, что и элемент <load-on-startup> в web.xml.

   // com.example.MyStartupServlet.java
   import javax.servlet.ServletConfig;
   import javax.servlet.ServletException;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   import java.io.IOException;
   
   @WebServlet(urlPatterns = "/startup", loadOnStartup = 1) // Загрузить при старте с порядком 1
   public class MyStartupServlet extends HttpServlet {
   
       @Override
       public void init(ServletConfig config) throws ServletException {
           super.init(config);
           // Код инициализации, который выполняется при старте сервлета
           System.out.println("MyStartupServlet инициализирован при старте приложения.");
       }
   
       @Override
       protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
           response.getWriter().println("Hello from MyStartupServlet!");
       }
   }
   

   // com.example.AnotherStartupServlet.java
   import javax.servlet.ServletConfig;
   import javax.servlet.ServletException;
   import javax.servlet.annotation.WebServlet;
   import javax.servlet.http.HttpServlet;
   import javax.servlet.http.HttpServletRequest;
   import javax.servlet.http.HttpServletResponse;
   import java.io.IOException;
   
   @WebServlet(urlPatterns = "/another-startup", loadOnStartup = 2) // Загрузить при старте с порядком 2
   public class AnotherStartupServlet extends HttpServlet {
   
       @Override
       public void init(ServletConfig config) throws ServletException {
           super.init(config);
           // Код инициализации
           System.out.println("AnotherStartupServlet инициализирован при старте приложения.");
       }
   
       @Override
       protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
           response.getWriter().println("Hello from AnotherStartupServlet!");
       }
   }
   

При запуске приложения контейнер сервлетов (например, Tomcat, Jetty) читает дескриптор развертывания или сканирует аннотации в классах сервлетов. Для сервлетов с load-on-startup (или loadOnStartup) больше или равно нулю, контейнер вызывает метод init() сервлета сразу после загрузки и инициализации самого веб-приложения (Servlet Context). Это гарантирует, что сервлет будет готов к работе еще до получения первого запроса.

Основная логика, которая должна выполняться при старте приложения, реализуется в методе init() сервлета.