Spring Boot sans le serveur Web

J'ai une simple application Spring Boot qui récupère les messages d'une file d'attente JMS et enregistre certaines données dans un fichier journal, mais n'a pas besoin d'un serveur Web. Existe-t-il un moyen de démarrer Spring Boot sans le serveur Web?

Spring boot n'inclura pas le tomcat intégré si vous n'avez pas de dépendances Tomcat sur le chemin de classe. Vous pouvez voir ce fait vous-même à la classe EmbeddedServletContainerAutoConfigurationdont vous pouvez trouver la source ici .

La viande du code est l'utilisation de l' @ConditionalOnClassannotation sur la classeEmbeddedTomcat

Aussi, pour plus d'informations, consultez ceci et ce guide et cette partie de la documentation

si vous souhaitez exécuter spring boot sans conteneur de servlet, mais avec un sur le chemin de classe (par exemple pour les tests), utilisez ce qui suit, comme décrit dans la documentation de spring boot :

@Configuration
@EnableAutoConfiguration
public class MyClass{
    public static void main(String[] args) throws JAXBException {
                 SpringApplication app = new SpringApplication(MyClass.class);
         app.setWebEnvironment(false); //<<<<<<<<<
         ConfigurableApplicationContext ctx = app.run(args);
    }
}

aussi, je viens de tomber sur cette propriété:

spring.main.web-environment=false

Spring Boot 2.x

• Propriétés de l'application

  spring.main.web-application-type=NONE 
  # REACTIVE, SERVLET
  

• ou SpringApplicationBuilder

  @SpringBootApplication
  public class MyApplication {
  
      public static void main(String[] args) {
          new SpringApplicationBuilder(MyApplication.class)
              .web(WebApplicationType.NONE) // .REACTIVE, .SERVLET
              .run(args);
     }
  }
  

Où WebApplicationType :

• NONE - L'application ne doit pas s'exécuter en tant qu'application Web et ne doit pas démarrer un serveur Web intégré.
• REACTIVE - L'application doit s'exécuter en tant qu'application Web réactive et doit démarrer un serveur Web réactif intégré.
• SERVLET - L'application doit s'exécuter en tant qu'application Web basée sur un servlet et doit démarrer un serveur Web de servlet intégré.

Vous pouvez créer quelque chose comme ceci:

@SpringBootApplication
public class Application {
  public static void main(String[] args) {
    new SpringApplicationBuilder(Application.class).web(false).run(args);
  }
}

Et

@Component
public class CommandLiner implements CommandLineRunner {

  @Override
  public void run(String... args) throws Exception {
    // Put your logic here
  }

}

La dépendance est toujours là mais non utilisée.

La solution la plus simple. dans votre fichier application.properties. ajoutez la propriété suivante comme mentionné par une réponse précédente:

spring.main.web-environment = false

Pour la version 2.0.0 de Spring boot starter, utilisez la propriété suivante:

spring.main.web-application-type = aucun

Pour obtenir de la documentation sur toutes les propriétés, utilisez ce lien: https://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html

Pour Spring boot v2.1.3.RELEASE, ajoutez simplement les propriétés suivantes dans application.propertes:

spring.main.web-application-type=none

Utilisez ce code.

SpringApplication application = new SpringApplication(DemoApplication.class);
application.setWebApplicationType(WebApplicationType.NONE);
application.run(args);

Si vous avez besoin d'une fonctionnalité Web dans votre application (comme org.springframework.web.client.RestTemplatepour les appels REST) ​​mais que vous ne souhaitez pas démarrer un serveur TOMCAT, excluez-la simplement dans le POM:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
    </exclusions>
</dependency>

• Grâce au programme:

  ConfigurableApplicationContext ctx =  new  SpringApplicationBuilder(YourApplicationMain.class)
  .web(WebApplicationType.NONE)
  .run(args);

• Via le fichier application.properties:

  spring.main.web-environment=false 

• Via le fichier application.yml:

  spring:
   main:
    web-environment:false

Si vous souhaitez utiliser l'un des modèles "Getting Started" du site spring.io, mais que vous n'avez besoin d'aucun des éléments liés aux servlets fournis avec le modèle "default" ("gs / spring-boot"), vous pouvez essayer le modèle de tâches de planification (dont le pom * contient spring-boot-starter, etc.) à la place:

https://spring.io/guides/gs/scheduling-tasks/

Cela vous donne Spring Boot et l'application fonctionne de manière autonome (aucun servlet ou spring-webmvc, etc. n'est inclus dans le pom). C'est ce que vous vouliez (même si vous devrez peut-être ajouter des éléments spécifiques à JMS, comme quelqu'un d'autre le souligne déjà).

[* J'utilise Maven, mais je suppose qu'une version Gradle fonctionnera de la même manière].

Supprimer la dépendance suivante sur votre fichier pom fonctionnera pour moi

  <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

Pour Kotling, voici ce que j'ai utilisé ces derniers temps:

// src/main/com.blabla/ShellApplication.kt

/**
 * Main entry point for the shell application.
 */
@SpringBootApplication
public class ShellApplication : CommandLineRunner {
    companion object {
        @JvmStatic
        fun main(args: Array<String>) {
            val application = SpringApplication(ShellApplication::class.java)
            application.webApplicationType = WebApplicationType.NONE
            application.run(*args);
        }
    }

    override fun run(vararg args: String?) {}
}

// src/main/com.blabla/command/CustomCommand.kt

@ShellComponent
public class CustomCommand {
    private val logger = KotlinLogging.logger {}

    @ShellMethod("Import, create and update data from CSV")
    public fun importCsv(@ShellOption() file: String) {
        logger.info("Hi")
    }
}

Et tout démarre normalement avec un shell avec ma commande personnalisée disponible.

Vous pouvez utiliser la dépendance spring-boot-starter. Cela n'aura pas le contenu Web.

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
</dependency>

Dans Spring Boot, Spring Web dependency fournit un serveur Web Apache Tomcat intégré. Si vous supprimez la dépendance spring-boot-starter-web dans le fichier pom.xml, il ne fournit pas de serveur Web intégré.

supprimer la dépendance suivante

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>

Similaire à @nayun oh réponse ci-dessus, mais pour les anciennes versions de Spring, utilisez ce code:

SpringApplication application = new SpringApplication(DemoApplication.class);
application.setApplicationContextClass(AnnotationConfigApplicationContext.class);
application.run(args);