public class SpringApplication extends Object
ApplicationContext
instance (depending on your
classpath)CommandLinePropertySource
to expose command line arguments as
Spring propertiesCommandLineRunner
beansrun(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) 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 application = new SpringApplication(MyApplication.class); // ... customize application settings here application.run(args) }
SpringApplication
s 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:
AnnotatedBeanDefinitionReader
XmlBeanDefinitionReader
, or
a groovy script to be loaded by GroovyBeanDefinitionReader
ClassPathBeanDefinitionScanner
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").run(Class, String[])
,
run(Class[], String[])
,
SpringApplication(Class...)
Modifier and Type | Field and Description |
---|---|
static String |
BANNER_LOCATION_PROPERTY
Banner location property key.
|
static String |
BANNER_LOCATION_PROPERTY_VALUE
Default banner location.
|
static String |
DEFAULT_CONTEXT_CLASS
The class name of application context that will be used by default for non-web
environments.
|
static String |
DEFAULT_REACTIVE_WEB_CONTEXT_CLASS
The class name of application context that will be used by default for reactive web
environments.
|
static String |
DEFAULT_SERVLET_WEB_CONTEXT_CLASS
The class name of application context that will be used by default for web
environments.
|
Constructor and Description |
---|
SpringApplication(Class<?>... primarySources)
Create a new
SpringApplication instance. |
SpringApplication(org.springframework.core.io.ResourceLoader resourceLoader,
Class<?>... primarySources)
Create a new
SpringApplication instance. |
Modifier and Type | Method and Description |
---|---|
void |
addInitializers(org.springframework.context.ApplicationContextInitializer<?>... initializers)
Add
ApplicationContextInitializer s to be applied to the Spring
ApplicationContext . |
void |
addListeners(org.springframework.context.ApplicationListener<?>... listeners)
Add
ApplicationListener s to be applied to the SpringApplication and
registered with the ApplicationContext . |
void |
addPrimarySources(Collection<Class<?>> additionalPrimarySources)
Add additional items to the primary sources that will be added to an
ApplicationContext when
run(String...) is called. |
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
ApplicationContextInitializer s to the context before it is
refreshed. |
protected void |
bindToSpringApplication(org.springframework.core.env.ConfigurableEnvironment environment)
Bind the environment to the
SpringApplication . |
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
PropertySource s 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. |
Set<Object> |
getAllSources()
Return an immutable set of all the sources that will be added to an
ApplicationContext when
run(String...) is called. |
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
ApplicationContextInitializer s that
will be applied to the Spring ApplicationContext . |
Set<org.springframework.context.ApplicationListener<?>> |
getListeners()
Returns read-only ordered Set of the
ApplicationListener s 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<String> |
getSources()
Returns a mutable set of the sources that will be added to an ApplicationContext
when
run(String...) is called. |
WebApplicationType |
getWebApplicationType()
Returns the type of web application that is being run.
|
boolean |
isWebEnvironment()
Deprecated.
since 2.0.0 in favor of
getWebApplicationType() |
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(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. |
static org.springframework.context.ConfigurableApplicationContext |
run(Class<?> primarySource,
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
ApplicationListener s 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<String> sources)
Set additional sources that will be used to create an ApplicationContext.
|
void |
setWebApplicationType(WebApplicationType webApplicationType)
Sets the type of web application to be run.
|
void |
setWebEnvironment(boolean webEnvironment)
Deprecated.
since 2.0.0 in favor of
setWebApplicationType(WebApplicationType) |
public static final String DEFAULT_CONTEXT_CLASS
public static final String DEFAULT_SERVLET_WEB_CONTEXT_CLASS
public static final String DEFAULT_REACTIVE_WEB_CONTEXT_CLASS
public static final String BANNER_LOCATION_PROPERTY_VALUE
public static final String BANNER_LOCATION_PROPERTY
public SpringApplication(Class<?>... primarySources)
SpringApplication
instance. The application context will load
beans from the specified primary sources (see class-level
documentation for details. The instance can be customized before calling
run(String...)
.primarySources
- the primary bean sourcesrun(Class, String[])
,
SpringApplication(ResourceLoader, Class...)
,
setSources(Set)
public SpringApplication(org.springframework.core.io.ResourceLoader resourceLoader, Class<?>... primarySources)
SpringApplication
instance. The application context will load
beans from the specified primary sources (see class-level
documentation for details. The instance can be customized before calling
run(String...)
.resourceLoader
- the resource loader to useprimarySources
- the primary bean sourcesrun(Class, String[])
,
setSources(Set)
public org.springframework.context.ConfigurableApplicationContext run(String... args)
ApplicationContext
.args
- the application arguments (usually passed from a Java main method)ApplicationContext
protected void configureEnvironment(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
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.environment
- this application's environmentargs
- arguments passed to the run
methodconfigureProfiles(ConfigurableEnvironment, String[])
,
configurePropertySources(ConfigurableEnvironment, String[])
protected void configurePropertySources(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
PropertySource
s in this application's
environment.environment
- this application's environmentargs
- arguments passed to the run
methodconfigureEnvironment(ConfigurableEnvironment, String[])
protected void configureProfiles(org.springframework.core.env.ConfigurableEnvironment environment, String[] args)
spring.profiles.active
property.environment
- this application's environmentargs
- arguments passed to the run
methodconfigureEnvironment(ConfigurableEnvironment, String[])
,
ConfigFileApplicationListener
protected void bindToSpringApplication(org.springframework.core.env.ConfigurableEnvironment environment)
SpringApplication
.environment
- the environment to bindprotected org.springframework.context.ConfigurableApplicationContext createApplicationContext()
ApplicationContext
. By default this
method will respect any explicitly set application context or application context
class before falling back to a suitable default.setApplicationContextClass(Class)
protected void postProcessApplicationContext(org.springframework.context.ConfigurableApplicationContext context)
ApplicationContext
. Subclasses can
apply additional processing as required.context
- the application contextprotected void applyInitializers(org.springframework.context.ConfigurableApplicationContext context)
ApplicationContextInitializer
s to the context before it is
refreshed.context
- the configured ApplicationContext (not refreshed yet)ConfigurableApplicationContext.refresh()
protected void logStartupInfo(boolean isRoot)
isRoot
- true if this application is the root of a context hierarchyprotected void logStartupProfileInfo(org.springframework.context.ConfigurableApplicationContext context)
context
- the application contextprotected org.apache.commons.logging.Log getApplicationLog()
Log
for the application. By default will be deduced.protected void load(org.springframework.context.ApplicationContext context, Object[] sources)
context
- the context to load beans intosources
- the sources to loadpublic org.springframework.core.io.ResourceLoader getResourceLoader()
public ClassLoader getClassLoader()
resourceLoader
is set, or the context
class loader (if not null), or the loader of the Spring ClassUtils
class.protected org.springframework.boot.BeanDefinitionLoader createBeanDefinitionLoader(org.springframework.beans.factory.support.BeanDefinitionRegistry registry, Object[] sources)
BeanDefinitionLoader
.registry
- the bean definition registrysources
- the sources to loadBeanDefinitionLoader
that will be used to load beansprotected void refresh(org.springframework.context.ApplicationContext applicationContext)
ApplicationContext
.applicationContext
- the application context to refreshprotected void afterRefresh(org.springframework.context.ConfigurableApplicationContext context, ApplicationArguments args)
context
- the application contextargs
- the application argumentsprotected void registerLoggedException(Throwable exception)
exception
- the exception that was loggedpublic Class<?> getMainApplicationClass()
null
public void setMainApplicationClass(Class<?> mainApplicationClass)
null
if there is no explicit application class.mainApplicationClass
- the mainApplicationClass to set or null
@Deprecated public boolean isWebEnvironment()
getWebApplicationType()
SpringApplication
is running within a web environment.true
if running within a web environment, otherwise false
.setWebEnvironment(boolean)
public WebApplicationType getWebApplicationType()
@Deprecated public void setWebEnvironment(boolean webEnvironment)
setWebApplicationType(WebApplicationType)
webEnvironment
- if the application is running in a web environmentpublic void setWebApplicationType(WebApplicationType webApplicationType)
webApplicationType
- the web application typepublic void setHeadless(boolean headless)
true
to prevent java icons appearing.headless
- if the application is headlesspublic void setRegisterShutdownHook(boolean registerShutdownHook)
ApplicationContext
should have a shutdown hook
registered. Defaults to true
to ensure that JVM shutdowns are handled
gracefully.registerShutdownHook
- if the shutdown hook should be registeredpublic void setBanner(Banner banner)
Banner
instance which will be used to print the banner when no
static banner file is provided.banner
- the Banner instance to usepublic void setBannerMode(Banner.Mode bannerMode)
Banner.Mode.CONSOLE
.bannerMode
- the mode used to display the bannerpublic void setLogStartupInfo(boolean logStartupInfo)
true
.logStartupInfo
- if startup info should be logged.public void setAddCommandLineProperties(boolean addCommandLineProperties)
CommandLinePropertySource
should be added to the application
context in order to expose arguments. Defaults to true
.addCommandLineProperties
- if command line arguments should be exposedpublic void setDefaultProperties(Map<String,Object> defaultProperties)
Environment
.defaultProperties
- the additional properties to setpublic void setDefaultProperties(Properties defaultProperties)
setDefaultProperties(Map)
.defaultProperties
- some Properties
public void setAdditionalProfiles(String... profiles)
profiles
- the additional profiles to setpublic void setBeanNameGenerator(org.springframework.beans.factory.support.BeanNameGenerator beanNameGenerator)
beanNameGenerator
- the bean name generatorpublic void setEnvironment(org.springframework.core.env.ConfigurableEnvironment environment)
environment
- the environmentpublic void addPrimarySources(Collection<Class<?>> additionalPrimarySources)
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.
additionalPrimarySources
- the additional primary sources to addSpringApplication(Class...)
,
getSources()
,
setSources(Set)
,
getAllSources()
public Set<String> getSources()
run(String...)
is called.
Sources set here will be used in addition to any primary sources set in the constructor.
SpringApplication(Class...)
,
getAllSources()
public void setSources(Set<String> sources)
Sources set here will be used in addition to any primary sources set in the constructor.
sources
- the application sources to setSpringApplication(Class...)
,
getAllSources()
public Set<Object> getAllSources()
run(String...)
is called. This method combines any
primary sources specified in the constructor with any additional ones that have
been explicitly set
.public void setResourceLoader(org.springframework.core.io.ResourceLoader resourceLoader)
ResourceLoader
that should be used when loading resources.resourceLoader
- the resource loaderpublic void setApplicationContextClass(Class<? extends org.springframework.context.ConfigurableApplicationContext> applicationContextClass)
ApplicationContext
that will be created. If not
specified defaults to DEFAULT_SERVLET_WEB_CONTEXT_CLASS
for web based
applications or AnnotationConfigApplicationContext
for non web based
applications.applicationContextClass
- the context class to setpublic void setInitializers(Collection<? extends org.springframework.context.ApplicationContextInitializer<?>> initializers)
ApplicationContextInitializer
that will be applied to the Spring
ApplicationContext
.initializers
- the initializers to setpublic void addInitializers(org.springframework.context.ApplicationContextInitializer<?>... initializers)
ApplicationContextInitializer
s to be applied to the Spring
ApplicationContext
.initializers
- the initializers to addpublic Set<org.springframework.context.ApplicationContextInitializer<?>> getInitializers()
ApplicationContextInitializer
s that
will be applied to the Spring ApplicationContext
.public void setListeners(Collection<? extends org.springframework.context.ApplicationListener<?>> listeners)
ApplicationListener
s that will be applied to the SpringApplication
and registered with the ApplicationContext
.listeners
- the listeners to setpublic void addListeners(org.springframework.context.ApplicationListener<?>... listeners)
ApplicationListener
s to be applied to the SpringApplication and
registered with the ApplicationContext
.listeners
- the listeners to addpublic Set<org.springframework.context.ApplicationListener<?>> getListeners()
ApplicationListener
s that will be
applied to the SpringApplication and registered with the ApplicationContext
.public static org.springframework.context.ConfigurableApplicationContext run(Class<?> primarySource, String... args)
SpringApplication
from the
specified source using default settings.primarySource
- the primary source to loadargs
- the application arguments (usually passed from a Java main method)ApplicationContext
public static org.springframework.context.ConfigurableApplicationContext run(Class<?>[] primarySources, String[] args)
SpringApplication
from the
specified sources using default settings and user supplied arguments.primarySources
- the primary sources to loadargs
- the application arguments (usually passed from a Java main method)ApplicationContext
public static void main(String[] args) throws Exception
Most developers will want to define their own main method and call the
run
method instead.
args
- command line argumentsException
- if the application cannot be startedrun(Class[], String[])
,
run(Class, String...)
public static int exit(org.springframework.context.ApplicationContext context, ExitCodeGenerator... exitCodeGenerators)
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)context
- the context to close if possibleexitCodeGenerators
- exist code generatorsCopyright © 2018 Pivotal Software, Inc.. All rights reserved.