about spring boot how to disable web environment correctly

Question

Spring boot non-web application, when start it has below error

Caused by: org.springframework.context.ApplicationContextException: Unable to start EmbeddedWebApplicationContext due to missing EmbeddedServletContainerFactory bean.
at org.springframework.boot.context.embedded.EmbeddedWebApplicationContext.getEmbeddedServletContainerFactory(EmbeddedWebApplicationContext.java:185) ~[spring-boot-1.3.5.RELEASE.jar:1.3.5.RELEASE]

Then I tried below manner

new SpringApplication().setWebEnvironment(false);

then start it still have above error.

Then tried

@SpringBootApplication(exclude={SpringDataWebAutoConfiguration.class})

but still have the same error.

At last I tried add below configuration in application.properties

spring.main.web-environment=false

this time it works.

Why the first two manner cannot work?

Answer 1

Starting from Spring Boot 2.0

-web(false)/setWebEnvironment(false) is deprecated and instead Web-Application-Type can be used to specify

• Application Properties

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

• or SpringApplicationBuilder

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

---

Where WebApplicationType:

• NONE - The application should not run as a web application and should not start an embedded web server.
• REACTIVE - The application should run as a reactive web application and should start an embedded reactive web server.
• SERVLET - The application should run as a servlet-based web application and should start an embedded servlet web server.

Courtesy: Another SO Answer