spring
当运行Spring Boot应用程序时,一切正常,我们将获得系统退出代码0 。 对于任何未处理的异常,应用程序将返回退出代码1 。
我们有可能从Spring Boot应用程序中返回自定义退出代码。 在本教程中,我们将学习如何做。
实现
让我们从创建一个实现ExitCodeGenerator接口的类开始:
@SpringBootApplication
public class SampleApplication implements ExitCodeGenerator {
public static void main(String[] args) {
System.exit(SpringApplication
.exit(SpringApplication.run(SampleApplication.class, args)));
}
@Override
public int getExitCode() {
return 25;
}
}
我们已经重写了getExitCode()方法以返回值25。因此,此应用程序现在将以退出代码25退出。
我们已经用SpringApplication.exit()方法包装了SpringApplication.run() 。
根据Spring文档,我们必须使用对SpringApplication.exit()方法的调用结果来调用System.exit() 。
收听
我们可以注册一个事件监听器来监听一个ExitCodeEvent :
@Bean
SampleEventListener sampleEventListener() {
return new SampleEventListener();
}
private static class SampleEventListener {
@EventListener
public void exitEvent(ExitCodeEvent event) {
LOG.info("Application Exit code: {}", event.getExitCode());
}
}
Spring Boot找到特定于应用程序的退出代码时将触发此事件。 现在,在应用程序退出时,将调用exitEvent()方法。
使用
ExitCodeExceptionMapper是一个策略接口,我们可以用来提供异常类型和退出代码之间的映射。
@Bean
ExitCodeExceptionMapper exitCodeToexceptionMapper() {
return exception -> {
if (exception.getCause() instanceof NumberFormatException) {
return 34;
}
if (exception.getCause() instanceof CustomTypeException) {
return 45;
}
...
return 1;
};
}
现在,对于NumberFormatException类型的异常,我们的应用程序将退出,退出代码为34 ,依此类推。
结论:
在本快速教程中,我们学习了如何在Spring Boot应用程序中返回自定义退出代码。 我们还为ExitCodeEvent实现了一个事件侦听器。
返回正确的退出代码将有助于我们对应用程序进行故障排除。
翻译自: https://www.javacodegeeks.com/2019/05/spring-boot-exit-codes-create-custom-exit-code.html
spring