[翻译]SpringBoot系列-SpringApplicati
public class SpringApplication extends Object
这个类能用来引导java方法和启动Spring应用程序的类。默认情况下,类将引导你启动以下应用程序:
- 创建一个适当的ApplicationContext实例(依赖于你的路径)
- 注册一个CommandLinePropertySource来将命令行参数展示为Spring properties
- 刷新应用上下文,载入单例bean
- 触发部分CommandLineRunner类
大多数情况,从你应用的主方法可以直接访问static run(Class String[]).
@Configuration
@EnableAutoConfiguration
public class MyApplication {
// ... Bean definitions
public static void main(String[] args) throws Exception {
SpringApplication.run(MyApplication.class, args);
}
}
对于更高级的配置,SpringApplication实例可以在运行之前创建和自定义:
public static void main(String[] args) throws Exception {
SpringApplication application = new SpringApplication(MyApplication.class);
// ... customize application settings here
application.run(args)
}
SpringApplication能从不动的资源文件中读取beans。通常建议你使用单个@Configuration类来引导你的应用程序,但你也可以从以下位置设置源:
- 由AnnotatedBeanDefinitionReader加载的完全限定的类名
- 由XmlBeanDefinitionReader加载的XML资源的位置,或由GroovyBeanDefinitionReader加载的groovy脚本
- 要由ClassPathBeanDefinitionScanner扫描的包的名称
配置属性也绑定到SpringApplication。这样可以动态地设置SpringApplication属性,如额外的源(“spring.main.sources” - 一个CSV列表),用于指示Web环境的标志(“spring.main.web-application-type = none”)或标志关闭横幅(“spring.main.banner-mode = off”)。
字段详情
DEFAULT_CONTEXT_CLASS
public static final String DEFAULT_CONTEXT_CLASS
非Web环境默认使用的应用程序上下文的类名称。
DEFAULT_WEB_CONTEXT_CLASS
public static final String DEFAULT_WEB_CONTEXT_CLASS
Web环境默认使用的应用程序上下文的类名称。
DEFAULT_REACTIVE_WEB_CONTEXT_CLASS
public static final String DEFAULT_REACTIVE_WEB_CONTEXT_CLASS
默认情况下反应式Web环境将使用的应用程序上下文的类名称。
BANNER_LOCATION_PROPERTY_VALUE
public static final String BANNER_LOCATION_PROPERTY_VALUE
默认banner位置。
BANNER_LOCATION_PROPERTY
public static final String BANNER_LOCATION_PROPERTY
banner位置属性键
构造函数详情
public SpringApplication(Class<?>... primarySources)
创建一个新的SpringApplication实例。应用程序上下文将从指定的主源加载bean(有关详细信息,请参阅类级别的文档)。在调用run(String ...)之前,可以自定义该实例。
primarySources - 主bean源
public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources)
创建一个新的SpringApplication实例。应用程序上下文将从指定的主源加载bean(有关详细信息,请参阅类级别的文档)。在调用run(String ...)之前,可以自定义该实例。
resourceLoader - 要使用的资源加载器
primarySources - 主bean源
方法详情
public ConfigurableApplicationContext run(String... args)
运行Spring应用程序,创建和刷新一个新的ApplicationContext。
args - 应用程序参数(通常从Java main方法传递)
protected void configureEnvironment(ConfigurableEnvironment environment, String[] args)
以该顺序委派configurePropertySources(ConfigurableEnvironment,String [])和configureProfiles(ConfigurableEnvironment,String []))的模板方法。覆盖此方法以完全控制环境定制,或分别对属性源或配置文件进行细粒度控制。
protected void configurePropertySources(ConfigurableEnvironment environment, String[] args)
在此应用程序的环境中添加,删除或重新排序任何PropertySources。
environment - 应用的环境
args - 传递给run方法的参数
protected void configureProfiles(ConfigurableEnvironment environment, String[] args)
为此应用程序环境配置哪些配置文件处于活动状态(或默认情况下处于活动状态)。通过spring.profiles.active属性可以在配置文件处理期间激活附加配置文件。
environment - 应用的环境
args - 传递给run方法的参数
protected void bindToSpringApplication(ConfigurableEnvironment environment)
将环境绑定到SpringApplication。
environment - 绑定的环境
protected ConfigurableApplicationContext createApplicationContext()
用于创建ApplicationContext的策略方法。默认情况下,该方法将在任何明确设置的应用程序上下文或应用程序上下文类之后才能返回到合适的默认值。
return:应用程序上下文(尚未刷新)
protected void postProcessApplicationContext(ConfigurableApplicationContext context)
应用任何相关的后处理ApplicationContext。子类可以根据需要应用其他处理。
context - 应用上下文
protected void applyInitializers(ConfigurableApplicationContext context)
在应用任何ApplicationContextInitializer之前刷新它。
context - 配置的ApplicationContext(尚未刷新)
protected void logStartupInfo(boolean isRoot)
调用记录启动信息,子类可以覆盖以添加其他日志记录。
isRoot - 如果此应用程序是上下文层次结构的根,则为true
protected void logStartupProfileInfo(ConfigurableApplicationContext context)
调用以记录活动的配置文件信息。
context - 应用程序上下文
protected Log getApplicationLog()
返回应用程序的日志。默认情况下将被推断。
return:应用程序日志
protected void load(ApplicationContext context, Object[] sources)
将bean加载到应用程序上下文中。
context - 将bean加载到源的上下文
sources - 要加载的源
public ResourceLoader getResourceLoader()
将在ApplicationContext中使用的ResourceLoader。
return:resourceLoader将在ApplicationContext中使用的资源加载器(如果是默认值,则为null)
public ClassLoader getClassLoader()
将在ApplicationContext(如果resourceLoader设置,或上下文类加载器(如果不为null))或Spring ClassUtils类的加载器中使用的ClassLoader。
return:类加载器(永不为null)
protected org.springframework.boot.BeanDefinitionLoader createBeanDefinitionLoader(BeanDefinitionRegistry registry, Object[] sources)
用于创建BeanDefinitionLoader的工厂方法。
registry - bean定义的注册表
sources - 载入的资源
return:将用于加载bean的BeanDefinitionLoader
protected void refresh(ApplicationContext applicationContext)
刷新底层的ApplicationContext。
applicationContext - 应用程序上下文进行刷新
protected void afterRefresh(ConfigurableApplicationContext context, ApplicationArguments args)
在上下文刷新后调用。
context - 应用的上下文
args - 应用的程序参数
protected void registerLoggedException(Throwable exception)
注册给定的异常已被记录。默认情况下,如果在主线程中运行,此方法将抑制堆栈跟踪的附加打印。
execption:记录的异常
public Class<?> getMainApplicationClass()
返回被推导或显式配置的主应用程序类。
return:主应用程序类或null
public void setMainApplicationClass(Class<?> mainApplicationClass)
设置将用作日志源并获取版本信息的特定主应用程序类。默认情况下,将推导出主应用程序类。如果没有显式应用程序类,可以设置为null。
mainApplicationClass - 要设置的mainApplicationClass或null
public WebApplicationType getWebApplicationType()
返回正在运行的Web应用程序的类型。
public void setWebApplicationType(WebApplicationType webApplicationType)
设置要运行的Web应用程序的类型。如果没有明确设置,将基于类路径推断Web应用程序的类型。
webApplicationType - Web应用程序类型
public void setHeadless(boolean headless)
设置应用程序是否headless,不应实例化AWT。默认为true,以防止出现java图标。
headless - 如果应用程序headless
public void setBanner(Banner banner)
设置当没有提供静态横幅文件时将用于打印横幅的横幅实例。
banner - 要使用的Banner实例
public void setBannerMode(Banner.Mode bannerMode)
设置应用程序运行时显示横幅的模式。默认为Banner.Mode.CONSOLE。
bannerMode - 用于显示横幅的模式
public void setLogStartupInfo(boolean logStartupInfo)
设置应用程序启动时是否应该记录应用程序信息。默认为true。
logStartupInfo - 如果启动信息应该被记录。
public void setAddCommandLineProperties(boolean addCommandLineProperties)
设置是否应将CommandLinePropertySource添加到应用程序上下文中以便公开参数。默认为true。
addCommandLineProperties - 如果要暴露命令行参数
public void setDefaultProperties(Map<String,Object> defaultProperties)
设置除了现有环境中的默认环境属性之外将使用的默认环境属性。
defaultProperties - 要设置的其他属性
public void setDefaultProperties(Properties defaultProperties)
方便的替代setDefaultProperties(Map)。