本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
内置工具
该util
变量包含可帮助您处理数据的通用实用方法。除非另行指定,否则所有实用程序均使用 UTF-8 字符集。
编码工具
-
util.urlEncode(String)
-
将输入字符串作为
application/x-www-form-urlencoded
编码字符串返回。 -
util.urlDecode(String)
-
将
application/x-www-form-urlencoded
编码的字符串解码回未编码的形式。 util.base64Encode(string) : string
-
将输入编码为 base64 编码字符串。
util.base64Decode(string) : string
-
对 base64 编码字符串中的数据进行解码。
ID 生成工具
-
util.autoId()
-
返回 128 位随机生成的 UUID。
util.autoUlid()
-
返回 128 位随机生成的 UID(通用唯一可按字典顺序排序的标识符)。
util.autoKsuid()
-
返回 128 位随机生成的 KSUID(K-Sortable 唯一标识符)base62 编码为长度为 27 的字符串。
错误实用工具
-
util.error(String, String?, Object?, Object?)
-
引发自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,
errorType
可以指定字data
段、errorInfo
字段和字段。将在 GraphQL 响应中data
内部对应的error
块中添加errors
值。注意 data
将根据查询选择集进行筛选。将在 GraphQL 响应中errorInfo
内部对应的error
块中添加errors
值。errorInfo
不会根据查询选择集进行筛选。 -
util.appendError(String, String?, Object?, Object?)
-
追加自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,
errorType
可以指定字data
段、errorInfo
字段和字段。与util.error(String, String?, Object?, Object?)
不同,不会中断模板评估,所以数据可以返回调用者。将在 GraphQL 响应中data
内部对应的error
块中添加errors
值。注意 data
将根据查询选择集进行筛选。将在 GraphQL 响应中errorInfo
内部对应的error
块中添加errors
值。errorInfo
不会根据查询选择集进行筛选。
类型和模式匹配工具
util.matches(String, String) : Boolean
-
如果在第一个参数中指定的模式与第二个参数中提供的数据匹配,则返回 true。模式必须为正则表达式,例如
util.matches("a*b", "aaaaab")
。此功能以模式为基础,您可参考其他文档,进一步了解此内容。 -
util.authType()
-
返回描述请求使用的多重身份验证类型的字符串,返回 “IAM 授权”、“用户池授权”、“Open ID Connect 授权” 或 “API 密钥授权”。
返回值行为工具
-
util.escapeJavaScript(String)
-
以转义字符串形式返回输入 JavaScript 字符串。
Resolver 授权工具
-
util.unauthorized()
-
针对被解析的字段引发
Unauthorized
。在请求或响应映射模板中使用它来确定是否允许调用者解析该字段。