Package org.springframework.boot

Class SpringApplication

java.lang.Object
org.springframework.boot.SpringApplication
public class SpringApplication extends Object
Class that can be used to bootstrap and launch a Spring application from a Java main method. By default class will perform the following steps to bootstrap your application: In most circumstances the static run(Class, String[]) method can be called directly from your main method to bootstrap your application: 
 @Configuration
 @EnableAutoConfiguration
 public class MyApplication  {

   // ... Bean definitions

   public static void main(String[] args) {
     SpringApplication.run(MyApplication.class, args);
   }
 }

For more advanced configuration a SpringApplication instance can be created and customized before being run: 

 public static void main(String[] args) {
   SpringApplication application = new SpringApplication(MyApplication.class);
   // ... customize application settings here
   application.run(args)
 }
SpringApplications can read beans from a variety of different sources. It is generally recommended that a single @Configuration class is used to bootstrap your application, however, you may also set sources from: Configuration properties are also bound to the SpringApplication. This makes it possible to set SpringApplication properties dynamically, like additional sources ("spring.main.sources" - a CSV list) the flag to indicate a web environment ("spring.main.web-application-type=none") or the flag to switch off the banner ("spring.main.banner-mode=off").
Since:
1.0.0
Author:
Phillip Webb, Dave Syer, Andy Wilkinson, Christian Dupuis, Stephane Nicoll, Jeremy Rickard, Craig Burke, Michael Simons, Madhura Bhave, Brian Clozel, Ethan Rubinson, Chris Bono
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • run

      public ConfigurableApplicationContext run(String... args)
      Run the Spring application, creating and refreshing a new ApplicationContext.
      Parameters:
      args - the application arguments (usually passed from a Java main method)
      Returns:
      a running ApplicationContext

    • configureEnvironment

      protected void configureEnvironment(ConfigurableEnvironment environment, String[] args)
      Template method delegating to configurePropertySources(ConfigurableEnvironment, String[]) and configureProfiles(ConfigurableEnvironment, String[]) in that order. Override this method for complete control over Environment customization, or one of the above for fine-grained control over property sources or profiles, respectively.
      Parameters:
      environment - this application's environment
      args - arguments passed to the run method
      See Also:

    • configurePropertySources

      protected void configurePropertySources(ConfigurableEnvironment environment, String[] args)
      Add, remove or re-order any PropertySources in this application's environment.
      Parameters:
      environment - this application's environment
      args - arguments passed to the run method
      See Also:

    • configureProfiles

      protected void configureProfiles(ConfigurableEnvironment environment, String[] args)
      Configure which profiles are active (or active by default) for this application environment. Additional profiles may be activated during configuration file processing through the spring.profiles.active property.
      Parameters:
      environment - this application's environment
      args - arguments passed to the run method
      See Also:

    • bindToSpringApplication

      protected void bindToSpringApplication(ConfigurableEnvironment environment)
      Bind the environment to the SpringApplication.
      Parameters:
      environment - the environment to bind

    • createApplicationContext

      protected ConfigurableApplicationContext createApplicationContext()
      Strategy method used to create the ApplicationContext. By default this method will respect any explicitly set application context class or factory before falling back to a suitable default.
      Returns:
      the application context (not yet refreshed)
      See Also:

    • postProcessApplicationContext

      protected void postProcessApplicationContext(ConfigurableApplicationContext context)
      Apply any relevant post processing the ApplicationContext. Subclasses can apply additional processing as required.
      Parameters:
      context - the application context

    • applyInitializers

      protected void applyInitializers(ConfigurableApplicationContext context)
      Apply any ApplicationContextInitializers to the context before it is refreshed.
      Parameters:
      context - the configured ApplicationContext (not refreshed yet)
      See Also:

    • logStartupInfo

      protected void logStartupInfo(boolean isRoot)
      Called to log startup information, subclasses may override to add additional logging.
      Parameters:
      isRoot - true if this application is the root of a context hierarchy

    • logStartupProfileInfo

      protected void logStartupProfileInfo(ConfigurableApplicationContext context)
      Called to log active profile information.
      Parameters:
      context - the application context

    • getApplicationLog

      protected Log getApplicationLog()
      Returns the Log for the application. By default will be deduced.
      Returns:
      the application log

    • load

      protected void load(ApplicationContext context, Object[] sources)
      Load beans into the application context.
      Parameters:
      context - the context to load beans into
      sources - the sources to load

    • getResourceLoader

      public ResourceLoader getResourceLoader()
      The ResourceLoader that will be used in the ApplicationContext.
      Returns:
      the resourceLoader the resource loader that will be used in the ApplicationContext (or null if the default)

    • getClassLoader

      public ClassLoader getClassLoader()
      Either the ClassLoader that will be used in the ApplicationContext (if resourceLoader is set), or the context class loader (if not null), or the loader of the Spring ClassUtils class.
      Returns:
      a ClassLoader (never null)

    • createBeanDefinitionLoader

      protected org.springframework.boot.BeanDefinitionLoader createBeanDefinitionLoader(BeanDefinitionRegistry registry, Object[] sources)
      Factory method used to create the BeanDefinitionLoader.
      Parameters:
      registry - the bean definition registry
      sources - the sources to load
      Returns:
      the BeanDefinitionLoader that will be used to load beans

    • refresh

      protected void refresh(ConfigurableApplicationContext applicationContext)
      Refresh the underlying ApplicationContext.
      Parameters:
      applicationContext - the application context to refresh

    • afterRefresh

      protected void afterRefresh(ConfigurableApplicationContext context, ApplicationArguments args)
      Called after the context has been refreshed.
      Parameters:
      context - the application context
      args - the application arguments

    • registerLoggedException

      protected void registerLoggedException(Throwable exception)
      Register that the given exception has been logged. By default, if the running in the main thread, this method will suppress additional printing of the stacktrace.
      Parameters:
      exception - the exception that was logged

    • getMainApplicationClass

      public Class<?> getMainApplicationClass()
      Returns the main application class that has been deduced or explicitly configured.
      Returns:
      the main application class or null

    • setMainApplicationClass

      public void setMainApplicationClass(Class<?> mainApplicationClass)
      Set a specific main application class that will be used as a log source and to obtain version information. By default the main application class will be deduced. Can be set to null if there is no explicit application class.
      Parameters:
      mainApplicationClass - the mainApplicationClass to set or null

    • getWebApplicationType

      public WebApplicationType getWebApplicationType()
      Returns the type of web application that is being run.
      Returns:
      the type of web application
      Since:
      2.0.0

    • setWebApplicationType

      public void setWebApplicationType(WebApplicationType webApplicationType)
      Sets the type of web application to be run. If not explicitly set the type of web application will be deduced based on the classpath.
      Parameters:
      webApplicationType - the web application type
      Since:
      2.0.0

    • setAllowBeanDefinitionOverriding

      public void setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding)
      Sets if bean definition overriding, by registering a definition with the same name as an existing definition, should be allowed. Defaults to false.
      Parameters:
      allowBeanDefinitionOverriding - if overriding is allowed
      Since:
      2.1.0
      See Also:

    • setAllowCircularReferences

      public void setAllowCircularReferences(boolean allowCircularReferences)
      Sets whether to allow circular references between beans and automatically try to resolve them. Defaults to false.
      Parameters:
      allowCircularReferences - if circular references are allowed
      Since:
      2.6.0
      See Also:

    • setLazyInitialization

      public void setLazyInitialization(boolean lazyInitialization)
      Sets if beans should be initialized lazily. Defaults to false.
      Parameters:
      lazyInitialization - if initialization should be lazy
      Since:
      2.2
      See Also:

    • setHeadless

      public void setHeadless(boolean headless)
      Sets if the application is headless and should not instantiate AWT. Defaults to true to prevent java icons appearing.
      Parameters:
      headless - if the application is headless

    • setRegisterShutdownHook

      public void setRegisterShutdownHook(boolean registerShutdownHook)
      Sets if the created ApplicationContext should have a shutdown hook registered. Defaults to true to ensure that JVM shutdowns are handled gracefully.
      Parameters:
      registerShutdownHook - if the shutdown hook should be registered
      See Also:

    • setBanner

      public void setBanner(Banner banner)
      Sets the Banner instance which will be used to print the banner when no static banner file is provided.
      Parameters:
      banner - the Banner instance to use

    • setBannerMode

      public void setBannerMode(Banner.Mode bannerMode)
      Sets the mode used to display the banner when the application runs. Defaults to Banner.Mode.CONSOLE.
      Parameters:
      bannerMode - the mode used to display the banner

    • setLogStartupInfo

      public void setLogStartupInfo(boolean logStartupInfo)
      Sets if the application information should be logged when the application starts. Defaults to true.
      Parameters:
      logStartupInfo - if startup info should be logged.

    • setAddCommandLineProperties

      public void setAddCommandLineProperties(boolean addCommandLineProperties)
      Sets if a CommandLinePropertySource should be added to the application context in order to expose arguments. Defaults to true.
      Parameters:
      addCommandLineProperties - if command line arguments should be exposed

    • setAddConversionService

      public void setAddConversionService(boolean addConversionService)
      Sets if the ApplicationConversionService should be added to the application context's Environment.
      Parameters:
      addConversionService - if the application conversion service should be added
      Since:
      2.1.0

    • addBootstrapRegistryInitializer

      public void addBootstrapRegistryInitializer(BootstrapRegistryInitializer bootstrapRegistryInitializer)
      Adds BootstrapRegistryInitializer instances that can be used to initialize the BootstrapRegistry.
      Parameters:
      bootstrapRegistryInitializer - the bootstrap registry initializer to add
      Since:
      2.4.5

    • setDefaultProperties

      public void setDefaultProperties(Map<String,Object> defaultProperties)
      Set default environment properties which will be used in addition to those in the existing Environment.
      Parameters:
      defaultProperties - the additional properties to set

    • setDefaultProperties

      public void setDefaultProperties(Properties defaultProperties)
      Convenient alternative to setDefaultProperties(Map).
      Parameters:
      defaultProperties - some Properties

    • setAdditionalProfiles

      public void setAdditionalProfiles(String... profiles)
      Set additional profile values to use (on top of those set in system or command line properties).
      Parameters:
      profiles - the additional profiles to set

    • getAdditionalProfiles

      public Set<String> getAdditionalProfiles()
      Return an immutable set of any additional profiles in use.
      Returns:
      the additional profiles

    • setBeanNameGenerator

      public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator)
      Sets the bean name generator that should be used when generating bean names.
      Parameters:
      beanNameGenerator - the bean name generator

    • setEnvironment

      public void setEnvironment(ConfigurableEnvironment environment)
      Sets the underlying environment that should be used with the created application context.
      Parameters:
      environment - the environment

    • addPrimarySources

      public void addPrimarySources(Collection<Class<?>> additionalPrimarySources)
      Add additional items to the primary sources that will be added to an ApplicationContext when run(String...) is called.

      The sources here are added to those that were set in the constructor. Most users should consider using getSources()/setSources(Set) rather than calling this method.

      Parameters:
      additionalPrimarySources - the additional primary sources to add
      See Also:

    • getSources

      public Set<String> getSources()
      Returns a mutable set of the sources that will be added to an ApplicationContext when run(String...) is called.

      Sources set here will be used in addition to any primary sources set in the constructor.

      Returns:
      the application sources.
      See Also:

    • setSources

      public void setSources(Set<String> sources)
      Set additional sources that will be used to create an ApplicationContext. A source can be: a class name, package name, or an XML resource location.

      Sources set here will be used in addition to any primary sources set in the constructor.

      Parameters:
      sources - the application sources to set
      See Also:

    • getAllSources

      public Set<Object> getAllSources()
      Return an immutable set of all the sources that will be added to an ApplicationContext when run(String...) is called. This method combines any primary sources specified in the constructor with any additional ones that have been explicitly set.
      Returns:
      an immutable set of all sources

    • setResourceLoader

      public void setResourceLoader(ResourceLoader resourceLoader)
      Sets the ResourceLoader that should be used when loading resources.
      Parameters:
      resourceLoader - the resource loader

    • getEnvironmentPrefix

      public String getEnvironmentPrefix()
      Return a prefix that should be applied when obtaining configuration properties from the system environment.
      Returns:
      the environment property prefix
      Since:
      2.5.0

    • setEnvironmentPrefix

      public void setEnvironmentPrefix(String environmentPrefix)
      Set the prefix that should be applied when obtaining configuration properties from the system environment.
      Parameters:
      environmentPrefix - the environment property prefix to set
      Since:
      2.5.0

    • setApplicationContextFactory

      public void setApplicationContextFactory(ApplicationContextFactory applicationContextFactory)
      Sets the factory that will be called to create the application context. If not set, defaults to a factory that will create AnnotationConfigServletWebServerApplicationContext for servlet web applications, AnnotationConfigReactiveWebServerApplicationContext for reactive web applications, and AnnotationConfigApplicationContext for non-web applications.
      Parameters:
      applicationContextFactory - the factory for the context
      Since:
      2.4.0

    • setInitializers

      public void setInitializers(Collection<? extends ApplicationContextInitializer<?>> initializers)
      Sets the ApplicationContextInitializer that will be applied to the Spring ApplicationContext.
      Parameters:
      initializers - the initializers to set

    • addInitializers

      public void addInitializers(ApplicationContextInitializer<?>... initializers)
      Add ApplicationContextInitializers to be applied to the Spring ApplicationContext.
      Parameters:
      initializers - the initializers to add

    • getInitializers

      public Set<ApplicationContextInitializer<?>> getInitializers()
      Returns read-only ordered Set of the ApplicationContextInitializers that will be applied to the Spring ApplicationContext.
      Returns:
      the initializers

    • setListeners

      public void setListeners(Collection<? extends ApplicationListener<?>> listeners)
      Sets the ApplicationListeners that will be applied to the SpringApplication and registered with the ApplicationContext.
      Parameters:
      listeners - the listeners to set

    • addListeners

      public void addListeners(ApplicationListener<?>... listeners)
      Add ApplicationListeners to be applied to the SpringApplication and registered with the ApplicationContext.
      Parameters:
      listeners - the listeners to add

    • getListeners

      public Set<ApplicationListener<?>> getListeners()
      Returns read-only ordered Set of the ApplicationListeners that will be applied to the SpringApplication and registered with the ApplicationContext .
      Returns:
      the listeners

    • setApplicationStartup

      public void setApplicationStartup(ApplicationStartup applicationStartup)
      Set the ApplicationStartup to use for collecting startup metrics.
      Parameters:
      applicationStartup - the application startup to use
      Since:
      2.4.0

    • getApplicationStartup

      public ApplicationStartup getApplicationStartup()
      Returns the ApplicationStartup used for collecting startup metrics.
      Returns:
      the application startup
      Since:
      2.4.0

    • getShutdownHandlers

      public static SpringApplicationShutdownHandlers getShutdownHandlers()
      Return a SpringApplicationShutdownHandlers instance that can be used to add or remove handlers that perform actions before the JVM is shutdown.
      Returns:
      a SpringApplicationShutdownHandlers instance
      Since:
      2.5.1

    • run

      public static ConfigurableApplicationContext run(Class<?> primarySource, String... args)
      Static helper that can be used to run a SpringApplication from the specified source using default settings.
      Parameters:
      primarySource - the primary source to load
      args - the application arguments (usually passed from a Java main method)
      Returns:
      the running ApplicationContext

    • run

      public static ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args)
      Static helper that can be used to run a SpringApplication from the specified sources using default settings and user supplied arguments.
      Parameters:
      primarySources - the primary sources to load
      args - the application arguments (usually passed from a Java main method)
      Returns:
      the running ApplicationContext

    • main

      public static void main(String[] args) throws Exception
      A basic main that can be used to launch an application. This method is useful when application sources are defined through a --spring.main.sources command line argument.

      Most developers will want to define their own main method and call the run method instead.

      Parameters:
      args - command line arguments
      Throws:
      Exception - if the application cannot be started
      See Also:

    • exit

      public static int exit(ApplicationContext context, ExitCodeGenerator... exitCodeGenerators)
      Static helper that can be used to exit a SpringApplication and obtain a code indicating success (0) or otherwise. Does not throw exceptions but should print stack traces of any encountered. Applies the specified ExitCodeGenerators in addition to any Spring beans that implement ExitCodeGenerator. When multiple generators are available, the first non-zero exit code is used. Generators are ordered based on their Ordered implementation and @Order annotation.
      Parameters:
      context - the context to close if possible
      exitCodeGenerators - exit code generators
      Returns:
      the outcome (0 if successful)

    • withHook

      public static void withHook(SpringApplicationHook hook, Runnable action)
      Perform the given action with the given SpringApplicationHook attached if the action triggers an application run.
      Parameters:
      hook - the hook to apply
      action - the action to run
      Since:
      3.0.0
      See Also:

    • withHook

      public static <T> T withHook(SpringApplicationHook hook, ThrowingSupplier<T> action)
      Perform the given action with the given SpringApplicationHook attached if the action triggers an application run.
      Type Parameters:
      T - the result type
      Parameters:
      hook - the hook to apply
      action - the action to run
      Returns:
      the result of the action
      Since:
      3.0.0
      See Also: