章节 IV. Spring Boot 特性

如果你的应用程序启动失败，注册的 FailureAnalyzers 将有机会提供专用的错误消息和具体的解决问题的措施。例如，如果你在端口 8080 上启动一个 web 应用，并且该端口已经在使用中，你应该可以看到类似以下消息的一些内容：

***************************
APPLICATION FAILED TO START
***************************

Description:

Embedded servlet container failed to start. Port 8080 was already in use.

Action:

Identify and stop the process that's listening on port 8080 or configure this application to listen on another port.

	Note
	Spring Boot 提供了许多 FailureAnalyzer 实现，你也可以添加你自己的。

如果没有失败分析器能够处理异常，你仍可以显示完整的条件报告，以便更好地理解错误所在。为此，你需要为 org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener 启用 debug 属性或启用 DEBUG 日志。

例如，如果你使用 java -jar 来运行你的应用程序，你可以像下面这样启用 debug 属性：

$ java -jar myproject-0.0.1-SNAPSHOT.jar --debug

在启动时打印的横幅可以通过在你的类路径中添加一个 banner.txt 或通过设置 spring.banner.location 为该文件的路径来修改。如果文件有 UTF-8 之外的编码，你可以设置 spring.banner.charset。除了文本文件之外，你也可在你的类路径中添加一个 banner.gif、banner.jpg 或 banner.png 图片文件，或者设置 spring.banner.image.location 属性。图像被转换成 ASCII 艺术表现，并打印在任何文本横幅之上。

在你的 banner.txt 文件中，你可以使用一些下面的占位符：

	Tip
	如果你要以编程的方式生成横幅，可以使用 SpringApplication.setBanner(…​) 方法。使用 org.springframework.boot.Banner 接口并实现你自己的 printBanner() 方法。

你还可以使用 spring.main.banner-mode 属性来确定横幅是否必须打印在 System.out（console）上，发送到配置的日志器（log），或者根本不生成（off）。

打印横幅被注册为一个单独的 bean，名称如下：springBootBanner。

	Note
	YAML映射 off 为 false，所以，如果你想禁用应用程序中的横幅，请务必添加引号，如下面的示例所示： spring: main: banner-mode: "off"

如果 SpringApplication 默认内容不符合你的口味，你可以创建本地实例并自定义它。例如，要关闭横幅，你可以写：

public static void main(String[] args) {
	SpringApplication app = new SpringApplication(MySpringConfiguration.class);
	app.setBannerMode(Banner.Mode.OFF);
	app.run(args);
}

	Note
	传递给 SpringApplication 的构造函数参数是 Spring bean 的配置源。大多数情况下，这些都是对 @Configuration 类的引用，但它们也可以是 XML 配置的引用或应该被扫描的包。

也可以通过使用 application.properties 文件来配置 SpringApplication。更多详细信息请参阅 章节 24, 外部配置

有关配置选项的完整列表，请参阅 SpringApplication Javadoc。

如果你需要构建一个 ApplicationContext 层次结构（具有父/子关系的多个上下文），或许你更喜欢使用 “fluent” 构造器 API，你可以使用 SpringApplicationBuilder。

SpringApplicationBuilder 允许你将多个方法调用链接在一起，并包含 parent 和 child 方法，它们可以创建层次结构，如下面的示例所示：

new SpringApplicationBuilder()
		.sources(Parent.class)
		.child(Application.class)
		.bannerMode(Banner.Mode.OFF)
		.run(args);

	Note
	创建 ApplicationContext 层次结构时有一些限制。例如，Web 组件必须包含在子上下文中，并且父子上下文都要使用相同的 Environment。完整的详细信息请参阅 SpringApplicationBuilder。

除了通常的 Spring Framework 事件之外，如 ContextRefreshedEvent，SpringApplication 还发送一些额外的应用程序事件。

	Note
	一些事件实际上是在 ApplicationContext 创建之前触发的，因此你不能使用 @Bean 来注册监听器。你可以使用 SpringApplication.addListeners(…​) 方法或 SpringApplicationBuilder.listeners(…​) 方法来注册它们。 如果你希望这些监听器自动注册，而不管应用程序是如何创建的，你可以在项目中添加一个 META-INF/spring.factories 文件，并使用 org.springframework.context.ApplicationListener 键来引用你的监听器，如下面的示例所示： org.springframework.context.ApplicationListener=com.example.project.MyListener

应用程序事件按以下顺序发送，如果你的应用程序运行：

	Tip
	你通常不需要使用应用程序事件，但知道它们的存在是很方便的。在内部，Spring Boot 使用事件来处理各种任务。

应用程序事件是使用 Spring Framework 的事件发布机制发送的。这种机制的一部分确保子上下文中发布给监听器的事件也会发布到一些父上下文中的监听器。因此，如果你的应用程序使用 SpringApplication 实例的层次结构，那么监听器可以接收同一类型的应用程序事件的多个实例。

为了允许监听器区分其上下文的事件和派生上下文的事件，它应该请求注入其应用程序上下文，然后将注入的上下文与事件的上下文进行比较。上下文可以通过实现 ApplicationContextAware 来注入，如果监听器是一个 bean，则使用 @Autowired。

SpringApplication 试图为你创建正确的 ApplicationContext 类型。用于确认 WebApplicationType 的算法相当简单：

这意味着，如果你在同一个应用程序中使用 Spring MVC 和 Spring WebFlux 的新 WebClient，默认情况下将使用 Spring MVC。你可以很容易地通过 setWebApplicationType(WebApplicationType) 来覆盖它。

还可以调用 setApplicationContextClass(…​) 来完全控制所使用的 ApplicationContext 类型。

	Tip
	在 JUnit 测试中使用 SpringApplication 时，经常需要调用 setWebApplicationType(WebApplicationType.NONE)。

如果你需要访问传递给 SpringApplication.run(…​) 的应用程序参数，你可以注入 org.springframework.boot.ApplicationArguments bean。ApplicationArguments 接口提供了对原始的 String[] 参数和 option 和 non-option 参数的访问，如下面的示例所示：

import org.springframework.boot.*;
import org.springframework.beans.factory.annotation.*;
import org.springframework.stereotype.*;

@Component
public class MyBean {

	@Autowired
	public MyBean(ApplicationArguments args) {
		boolean debug = args.containsOption("debug");
		List<String> files = args.getNonOptionArgs();
		// if run with "--debug logfile.txt" debug=true, files=["logfile.txt"]
	}

}

	Tip
	Spring Boot 还使用 Spring Environment 注册了 CommandLinePropertySource。这样，你也可以通过使用 @Value 注解来注入单个应用程序参数。

如果你需要在 SpringApplication 启动之后运行一些特定的代码，则可以实现 ApplicationRunner 或 CommandLineRunner 接口。两个接口以相同的方式工作，并提供一个单独的 run 方法，这都是在 SpringApplication.run(…​) 完成之前调用。

CommandLineRunner 提供了一个简单的字符串数组形式的应用程序参数的访问，而 ApplicationRunner 则使用前面讨论的 ApplicationArguments 接口。下面的示例展示了一个带有 run 方法的 CommandLineRunner。

import org.springframework.boot.*;
import org.springframework.stereotype.*;

@Component
public class MyBean implements CommandLineRunner {

	public void run(String... args) {
		// Do something...
	}

}

如果定义了几个 CommandLineRunner 或 ApplicationRunner bean 必须按特定的顺序调用，你可以额外实现 org.springframework.core.Ordered 接口或使用 org.springframework.core.annotation.Order 注解。

每个 SpringApplication 注册了一个 JVM 中的关闭钩子，以确保在退出时关闭 ApplicationContext。可以使用所有标准的 Spring 生命周期回调（如 DisposableBean 接口或 @PreDestroy 注解）。

此外，如果希望 SpringApplication.exit() 调用时，bean 会返回特定的退出代码，则它们可以实现 org.springframework.boot.ExitCodeGenerator 接口。这个退出代码可以传递给 System.exit() 以将它作为状态代码返回，如下面的示例所示：

@SpringBootApplication
public class ExitCodeApplication {

	@Bean
	public ExitCodeGenerator exitCodeGenerator() {
		return () -> 42;
	}

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

}

此外，ExitCodeGenerator 接口可以通过异常来实现。当遇到这样的异常时，Spring Boot 返回由实现的 getExitCode() 方法提供的退出代码。

可以通过指定 spring.application.admin.enabled 属性来启用管理员相关的特性。这在 MBeanServer 平台上暴漏了 SpringApplicationAdminMXBean。你可以使用此特性远程管理 Spring Boot 应用程序。这个特性也可以用于所有服务封装器实现。

	Tip
	如果你想知道应用程序运行在哪个 HTTP 端口上，可以通过 local.server.port 键来获得。

	Caution
	启用此功能时要小心，因为 MBean 暴露了一个关闭应用程序的方法。