此版本仍在开发中,尚未被认为是稳定版。请使用最新稳定版 Spring Shell 4.0.1spring-doc.cadn.net.cn

异常处理

在编写命令时,正确处理异常非常重要,以确保应用程序在面对错误时能够表现得可预测。 Spring Shell 通过 `0` 接口允许您有效地管理异常,并将它们映射到特定的退出代码和用户友好的消息。spring-doc.cadn.net.cn

ExitStatusExceptionMapper接口提供了一种在命令执行期间将抛出的异常映射到特定退出代码和消息的方式。 通过实现此接口,您可以为不同的异常类型定义自定义行为,从而向用户提供有意义的信息,并控制应用程序的退出状态。spring-doc.cadn.net.cn

实现ExitStatusExceptionMapper

The ExitStatusExceptionMapper 是一个功能接口,扩展自 java.util.Function,并接受一个 Exception 作为输入,返回一个 ExitStatus。 你可以实现此方法来处理特定异常,并返回适当的退出代码和消息。例如:spring-doc.cadn.net.cn

@Bean
public ExitStatusExceptionMapper myCustomExceptionMapper() {
	return exception -> new ExitStatus(42, "42! The answer to life, the universe and everything!");
}

注册Mapper

程序化注册

当程序化注册命令时,您可以使用Command.Builder类中的exitStatusExceptionMapper方法来设置ExitStatusExceptionMapper。例如:spring-doc.cadn.net.cn

@Bean
public Command sayHello() {
	return Command.builder()
			.name("hello")
			.description("Say hello to a given name")
			.group("Greetings")
			.help("A command that greets the user with 'Hello ${name}!'. Usage: hello [-n | --name]=<name>")
			.exitStatusExceptionMapper(exception -> new ExitStatus(42, "42! The answer to life, the universe and everything!"))
			.execute(context -> {
				String name = context.getOptionByName("name").value();
				if (name.equals("42")) {
					throw new RuntimeException("Error!");
				}
				System.out.println("Hello " + name + "!");
			});
}

注解基础注册

当使用基于注解的命令注册时,可以通过在@Command注解的exitStatusExceptionMapper属性中指定自定义ExitStatusExceptionMapper来实现。例如:spring-doc.cadn.net.cn

@Command(name = "hello", description = "Say hello to a given name", group = "Greetings",
		help = "A command that greets the user with 'Hello ${name}!'. Usage: hello [-n | --name]=<name>",
		exitStatusExceptionMapper = "myCustomExceptionMapper")
public void sayHello(@Option(shortName = 'n', longName = "name", description = "the name of the person to greet",
		defaultValue = "World") String name) {
	if (name.equals("42")) {
		throw new RuntimeException("Error!");
	}
	System.out.println("Hello " + name + "!");
}

@Bean
public ExitStatusExceptionMapper myCustomExceptionMapper() {
	return exception -> new ExitStatus(42, "42! The answer to life, the universe and everything!");
}

The custom mapper 应该定义为一个 Spring 框架中的 Bean,这样它就可以通过名称在 @Command 注释中被引用。spring-doc.cadn.net.cn