org.springframework.boot

Class SpringApplication


  • public class SpringApplication
extends Object
    Classes 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:
    • Create an appropriate ApplicationContext instance (depending on your classpath)
    • Register a CommandLinePropertySource to expose command line arguments as Spring properties
    • Refresh the application context, loading all singleton beans
    • Trigger any CommandLineRunner beans
    In most circumstances the static run(Object, 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) throws Exception {
     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) throws Exception {
   SpringApplication app = new SpringApplication(MyApplication.class);
   // ... customize app settings here
   app.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, any of the following sources can also be used:
    • Class - A Java class to be loaded by AnnotatedBeanDefinitionReader
    • Resource - An XML resource to be loaded by XmlBeanDefinitionReader, or a groovy script to be loaded by GroovyBeanDefinitionReader
    • Package - A Java package to be scanned by ClassPathBeanDefinitionScanner
    • CharSequence - A class name, resource handle or package name to loaded as appropriate. If the CharSequence cannot be resolved to class and does not resolve to a Resource that exists it will be considered a Package.

    Author:
    Phillip Webb, Dave Syer, Andy Wilkinson, Christian Dupuis, Stephane Nicoll, Jeremy Rickard, Craig Burke, Michael Simons, Ethan Rubinson
    See Also:
    run(Object, String[]), run(Object[], String[]), SpringApplication(Object...)

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addInitializers(org.springframework.context.ApplicationContextInitializer<?>... initializers)
      Add ApplicationContextInitializers to be applied to the Spring ApplicationContext.
      void addListeners(org.springframework.context.ApplicationListener<?>... listeners)
      Add ApplicationListeners to be applied to the SpringApplication and registered with the ApplicationContext.
      protected void afterRefresh(org.springframework.context.ConfigurableApplicationContext context, ApplicationArguments args)
      Called after the context has been refreshed.
      protected void applyInitializers(org.springframework.context.ConfigurableApplicationContext context)
      Apply any ApplicationContextInitializers to the context before it is refreshed.
      protected void configureEnvironment(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
      Template method delegating to configurePropertySources(ConfigurableEnvironment, String[]) and configureProfiles(ConfigurableEnvironment, String[]) in that order.
      protected void configureProfiles(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
      Configure which profiles are active (or active by default) for this application environment.
      protected void configurePropertySources(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
      Add, remove or re-order any PropertySources in this application's environment.
      protected org.springframework.context.ConfigurableApplicationContext createApplicationContext()
      Strategy method used to create the ApplicationContext.
      protected org.springframework.boot.BeanDefinitionLoader createBeanDefinitionLoader(org.springframework.beans.factory.support.BeanDefinitionRegistry registry, Object[] sources)
      Factory method used to create the BeanDefinitionLoader.
      static int exit(org.springframework.context.ApplicationContext context, ExitCodeGenerator... exitCodeGenerators)
      Static helper that can be used to exit a SpringApplication and obtain a code indicating success (0) or otherwise.
      protected org.apache.commons.logging.Log getApplicationLog()
      Returns the Log for the application.
      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.
      Set<org.springframework.context.ApplicationContextInitializer<?>> getInitializers()
      Returns read-only ordered Set of the ApplicationContextInitializers that will be applied to the Spring ApplicationContext.
      Set<org.springframework.context.ApplicationListener<?>> getListeners()
      Returns read-only ordered Set of the ApplicationListeners that will be applied to the SpringApplication and registered with the ApplicationContext .
      Class<?> getMainApplicationClass()
      Returns the main application class that has been deduced or explicitly configured.
      org.springframework.core.io.ResourceLoader getResourceLoader()
      The ResourceLoader that will be used in the ApplicationContext.
      Set<Object> getSources()
      Returns a mutable set of the sources that will be added to an ApplicationContext when run(String...) is called.
      boolean isWebEnvironment()
      Returns whether this SpringApplication is running within a web environment.
      protected void load(org.springframework.context.ApplicationContext context, Object[] sources)
      Load beans into the application context.
      protected void logStartupInfo(boolean isRoot)
      Called to log startup information, subclasses may override to add additional logging.
      protected void logStartupProfileInfo(org.springframework.context.ConfigurableApplicationContext context)
      Called to log active profile information.
      static void main(String[] args)
      A basic main that can be used to launch an application.
      protected void postProcessApplicationContext(org.springframework.context.ConfigurableApplicationContext context)
      Apply any relevant post processing the ApplicationContext.
      protected void refresh(org.springframework.context.ApplicationContext applicationContext)
      Refresh the underlying ApplicationContext.
      protected void registerLoggedException(Throwable exception)
      Register that the given exception has been logged.
      static org.springframework.context.ConfigurableApplicationContext run(Object[] sources, String[] args)
      Static helper that can be used to run a SpringApplication from the specified sources using default settings and user supplied arguments.
      static org.springframework.context.ConfigurableApplicationContext run(Object source, String... args)
      Static helper that can be used to run a SpringApplication from the specified source using default settings.
      org.springframework.context.ConfigurableApplicationContext run(String... args)
      Run the Spring application, creating and refreshing a new ApplicationContext.
      void setAddCommandLineProperties(boolean addCommandLineProperties)
      Sets if a CommandLinePropertySource should be added to the application context in order to expose arguments.
      void setAdditionalProfiles(String... profiles)
      Set additional profile values to use (on top of those set in system or command line properties).
      void setApplicationContextClass(Class<? extends org.springframework.context.ConfigurableApplicationContext> applicationContextClass)
      Sets the type of Spring ApplicationContext that will be created.
      void setBanner(Banner banner)
      Sets the Banner instance which will be used to print the banner when no static banner file is provided.
      void setBannerMode(Banner.Mode bannerMode)
      Sets the mode used to display the banner when the application runs.
      void setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator beanNameGenerator)
      Sets the bean name generator that should be used when generating bean names.
      void setDefaultProperties(Map<String,Object> defaultProperties)
      Set default environment properties which will be used in addition to those in the existing Environment.
      void setDefaultProperties(Properties defaultProperties)
      Convenient alternative to setDefaultProperties(Map).
      void setEnvironment(org.springframework.core.env.ConfigurableEnvironment environment)
      Sets the underlying environment that should be used with the created application context.
      void setHeadless(boolean headless)
      Sets if the application is headless and should not instantiate AWT.
      void setInitializers(Collection<? extends org.springframework.context.ApplicationContextInitializer<?>> initializers)
      Sets the ApplicationContextInitializer that will be applied to the Spring ApplicationContext.
      void setListeners(Collection<? extends org.springframework.context.ApplicationListener<?>> listeners)
      Sets the ApplicationListeners that will be applied to the SpringApplication and registered with the ApplicationContext.
      void setLogStartupInfo(boolean logStartupInfo)
      Sets if the application information should be logged when the application starts.
      void setMainApplicationClass(Class<?> mainApplicationClass)
      Set a specific main application class that will be used as a log source and to obtain version information.
      void setRegisterShutdownHook(boolean registerShutdownHook)
      Sets if the created ApplicationContext should have a shutdown hook registered.
      void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
      Sets the ResourceLoader that should be used when loading resources.
      void setSources(Set<Object> sources)
      The sources that will be used to create an ApplicationContext.
      void setWebEnvironment(boolean webEnvironment)
      Sets if this application is running within a web environment.

    • Field Detail

      • DEFAULT_CONTEXT_CLASS

        public static final String DEFAULT_CONTEXT_CLASS
        The class name of application context that will be used by default for non-web environments.
        See Also:
        Constant Field Values

      • DEFAULT_WEB_CONTEXT_CLASS

        public static final String DEFAULT_WEB_CONTEXT_CLASS
        The class name of application context that will be used by default for web environments.
        See Also:
        Constant Field Values

      • BANNER_LOCATION_PROPERTY_VALUE

        public static final String BANNER_LOCATION_PROPERTY_VALUE
        Default banner location.
        See Also:
        Constant Field Values

      • BANNER_LOCATION_PROPERTY

        public static final String BANNER_LOCATION_PROPERTY
        Banner location property key.
        See Also:
        Constant Field Values

    • Method Detail

      • run

        public org.springframework.context.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

      • configurePropertySources

        protected void configurePropertySources(org.springframework.core.env.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:
        configureEnvironment(ConfigurableEnvironment, String[])

      • configureProfiles

        protected void configureProfiles(org.springframework.core.env.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 via the spring.profiles.active property.
        Parameters:
        environment - this application's environment
        args - arguments passed to the run method
        See Also:
        configureEnvironment(ConfigurableEnvironment, String[]), ConfigFileApplicationListener

      • createApplicationContext

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

      • postProcessApplicationContext

        protected void postProcessApplicationContext(org.springframework.context.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(org.springframework.context.ConfigurableApplicationContext context)
        Apply any ApplicationContextInitializers to the context before it is refreshed.
        Parameters:
        context - the configured ApplicationContext (not refreshed yet)
        See Also:
        ConfigurableApplicationContext.refresh()

      • 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(org.springframework.context.ConfigurableApplicationContext context)
        Called to log active profile information.
        Parameters:
        context - the application context

      • getApplicationLog

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

      • load

        protected void load(org.springframework.context.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 org.springframework.core.io.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(org.springframework.beans.factory.support.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(org.springframework.context.ApplicationContext applicationContext)
        Refresh the underlying ApplicationContext.
        Parameters:
        applicationContext - the application context to refresh

      • afterRefresh

        protected void afterRefresh(org.springframework.context.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

      • isWebEnvironment

        public boolean isWebEnvironment()
        Returns whether this SpringApplication is running within a web environment.
        Returns:
        true if running within a web environment, otherwise false.
        See Also:
        setWebEnvironment(boolean)

      • setWebEnvironment

        public void setWebEnvironment(boolean webEnvironment)
        Sets if this application is running within a web environment. If not specified will attempt to deduce the environment based on the classpath.
        Parameters:
        webEnvironment - if the application is running in a web environment

      • 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

      • 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

      • 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

      • 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

      • setBeanNameGenerator

        public void setBeanNameGenerator(org.springframework.beans.factory.support.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(org.springframework.core.env.ConfigurableEnvironment environment)
        Sets the underlying environment that should be used with the created application context.
        Parameters:
        environment - the environment

      • setSources

        public void setSources(Set<Object> sources)
        The sources that will be used to create an ApplicationContext. A valid source is one of: a class, class name, package, package name, or an XML resource location. Can also be set using constructors and static convenience methods (e.g. run(Object[], String[])).

        NOTE: sources defined here will be used in addition to any sources specified on construction.

        Parameters:
        sources - the sources to set
        See Also:
        SpringApplication(Object...)

      • setResourceLoader

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

      • setApplicationContextClass

        public void setApplicationContextClass(Class<? extends org.springframework.context.ConfigurableApplicationContext> applicationContextClass)
        Sets the type of Spring ApplicationContext that will be created. If not specified defaults to DEFAULT_WEB_CONTEXT_CLASS for web based applications or AnnotationConfigApplicationContext for non web based applications.
        Parameters:
        applicationContextClass - the context class to set

      • setInitializers

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

      • addInitializers

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

      • getInitializers

        public Set<org.springframework.context.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 org.springframework.context.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(org.springframework.context.ApplicationListener<?>... listeners)
        Add ApplicationListeners to be applied to the SpringApplication and registered with the ApplicationContext.
        Parameters:
        listeners - the listeners to add

      • getListeners

        public Set<org.springframework.context.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

      • run

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

      • run

        public static org.springframework.context.ConfigurableApplicationContext run(Object[] sources,
                                                                             String[] args)
        Static helper that can be used to run a SpringApplication from the specified sources using default settings and user supplied arguments.
        Parameters:
        sources - the 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 via 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:
        run(Object[], String[]), run(Object, String...)

      • exit

        public static int exit(org.springframework.context.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 ExitCodeGenerator in addition to any Spring beans that implement ExitCodeGenerator. In the case of multiple exit codes the highest value will be used (or if all values are negative, the lowest value will be used)
        Parameters:
        context - the context to close if possible
        exitCodeGenerators - exist code generators
        Returns:
        the outcome (0 if successful)

Copyright © 2019 Pivotal Software, Inc.. All rights reserved.