函数

您可以通过注册用户定义函数来扩展 SpEL，这些函数可以使用 #functionName(…​) 语法在表达式中调用，与标准方法调用一样，函数调用也支持可变参数（varargs）。

可以通过 EvaluationContext 实现的 setVariable() 方法将函数注册为变量。

StandardEvaluationContext 还定义了 registerFunction(…​) 方法，提供了一种便捷的方式将函数注册为 java.lang.reflect.Method 或 java.lang.invoke.MethodHandle。

由于函数与评估上下文中的变量共享一个命名空间，因此必须小心确保函数名和变量名不重叠。

以下示例展示了如何使用 java.lang.reflect.Method 通过反射注册用户定义函数进行调用

  • Java

  • Kotlin

Method method = ...;

EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();
context.setVariable("myFunction", method);
val method: Method = ...

val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()
context.setVariable("myFunction", method)

例如，考虑以下用于反转字符串的工具方法

  • Java

  • Kotlin

public abstract class StringUtils {

	public static String reverseString(String input) {
		return new StringBuilder(input).reverse().toString();
	}
}
fun reverseString(input: String): String {
	return StringBuilder(input).reverse().toString()
}

您可以注册和使用上述方法，示例如下

  • Java

  • Kotlin

ExpressionParser parser = new SpelExpressionParser();

EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();
context.setVariable("reverseString",
		StringUtils.class.getMethod("reverseString", String.class));

// evaluates to "olleh"
String helloWorldReversed = parser.parseExpression(
		"#reverseString('hello')").getValue(context, String.class);
val parser = SpelExpressionParser()

val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()
context.setVariable("reverseString", ::reverseString.javaMethod)

// evaluates to "olleh"
val helloWorldReversed = parser.parseExpression(
		"#reverseString('hello')").getValue(context, String::class.java)

函数也可以注册为 java.lang.invoke.MethodHandle。如果 MethodHandle 的目标和参数在注册前已完全绑定，这可能会带来更高效的使用场景；但同时也支持部分绑定的 handle。

考虑 String#formatted(Object…​) 实例方法，它根据模板和可变数量的参数（可变参数）生成消息。

您可以注册和使用 formatted 方法作为 MethodHandle，示例如下

  • Java

  • Kotlin

ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();

MethodHandle mh = MethodHandles.lookup().findVirtual(String.class, "formatted",
		MethodType.methodType(String.class, Object[].class));
context.setVariable("message", mh);

// evaluates to "Simple message: <Hello World>"
String message = parser.parseExpression("#message('Simple message: <%s>', 'Hello World', 'ignored')")
		.getValue(context, String.class);
val parser = SpelExpressionParser()
val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()

val mh = MethodHandles.lookup().findVirtual(String::class.java, "formatted",
		MethodType.methodType(String::class.java, Array<Any>::class.java))
context.setVariable("message", mh)

// evaluates to "Simple message: <Hello World>"
val message = parser.parseExpression("#message('Simple message: <%s>', 'Hello World', 'ignored')")
		.getValue(context, String::class.java)

如前所述，也支持绑定 MethodHandle 并注册已绑定的 MethodHandle。如果目标和所有参数都已绑定，这种方式可能会更高效。在这种情况下，SpEL 表达式中不需要任何参数，示例如下

  • Java

  • Kotlin

ExpressionParser parser = new SpelExpressionParser();
EvaluationContext context = SimpleEvaluationContext.forReadOnlyDataBinding().build();

String template = "This is a %s message with %s words: <%s>";
Object varargs = new Object[] { "prerecorded", 3, "Oh Hello World!", "ignored" };
MethodHandle mh = MethodHandles.lookup().findVirtual(String.class, "formatted",
	MethodType.methodType(String.class, Object[].class))
		.bindTo(template)
		// Here we have to provide the arguments in a single array binding:
		.bindTo(varargs);
context.setVariable("message", mh);

// evaluates to "This is a prerecorded message with 3 words: <Oh Hello World!>"
String message = parser.parseExpression("#message()")
		.getValue(context, String.class);
val parser = SpelExpressionParser()
val context = SimpleEvaluationContext.forReadOnlyDataBinding().build()

val template = "This is a %s message with %s words: <%s>"
val varargs = arrayOf("prerecorded", 3, "Oh Hello World!", "ignored")

val mh = MethodHandles.lookup().findVirtual(String::class.java, "formatted",
	MethodType.methodType(String::class.java, Array<Any>::class.java))
		.bindTo(template)
		// Here we have to provide the arguments in a single array binding:
		.bindTo(varargs)
context.setVariable("message", mh)

// evaluates to "This is a prerecorded message with 3 words: <Oh Hello World!>"
val message = parser.parseExpression("#message()")
		.getValue(context, String::class.java)