更新时间:2023-12-29 GMT+08:00

Java函数开发指南(使用Eclipse工具)

函数定义

函数有明确的接口定义,如下:

作用域 返回参数 函数名(函数参数,Context参数)

  • 作用域:提供给FunctionGraph调用的用户函数必须定义为public。
  • 返回参数:用户定义,FunctionGraph负责转换为字符串,作为HTTP Response返回。对于返回参数对象类型,HTTP Response该类型的JSON字符串。
  • 函数名:用户定义函数名称。
  • 用户定义参数,当前函数只支持一个用户参数。对于复杂参数,建议定义为对象类型,以JSON字符串提供数据。FunctionGraph调用函数时,解析JSON为对象。
  • Context:runtime提供函数执行上下文,其接口定义在SDK接口说明。

创建Java函数时,函数入口参数需要提供函数完整的名字空间,参数格式为:包名.类名.函数名。

Java的initializer入口介绍

函数服务目前支持以下Java运行环境。

  • Java 8 (runtime = Java8)

    Initializer格式为:

    [包名].[类名].[执行函数名]

    示例:创建函数时指定的initializer为com.Demo.my_initializer,那么FunctionGraph会去加载com包,Demo类中定义的my_initializer函数。

    在函数服务中使用Java实现initializer接口,需要定义一个java函数作为initializer入口,一个最简单的initializer示例如下。

    public void my_initializer(Context context)
    {
    RuntimeLogger log = context.getLogger();
    log.log(String.format("ak:%s", context.getAccessKey()));
    }
  • 函数名

    my_initializer需要与实现initializer接口时的initializer字段相对应。

    示例:实现initializer接口时指定的Initializer入口为com.Demo.my_initializer,那么FunctionGraph会去加载com包,Demo类中定义的my_initializer函数。

  • context参数

    context参数中包含一些函数的运行时信息,例如:request id、临时AccessKey、function meta等。

SDK接口

FunctionGraph函数JavaSDK提供了Context接口和日志记录接口,SDK下载地址见Java SDK下载(校验文件:fss-java-sdk-sha256)。

  • Context接口

    Context接口提供函数获取函数执行上下文,例如,用户委托的AccessKey/SecretKey、当前请求ID、函数执行分配的内存空间、CPU数等。

    Context接口说明如表1所示。

    表1 Context类上下文方法说明

    方法名

    方法说明

    getRequestID( )

    获取请求ID。

    getRemainingTimeInMilliSeconds ( )

    获取函数剩余运行时间。

    getAccessKey( )

    获取用户委托的AccessKey(有效期24小时),使用该方法需要给函数配置委托。

    说明:

    当前函数工作流已停止维护Runtime SDK 中getAccessKey接口,您将无法使用getAccessKey获取临时AK。

    getSecretKey( )

    获取用户委托的SecretKey(有效期24小时),使用该方法需要给函数配置委托。

    说明:

    当前函数工作流已停止维护Runtime SDK 中getSecretKey接口,您将无法使用getSecretKey获取临时SK。

    getSecurityAccessKey( )

    获取用户委托的SecurityAccessKey(有效期24小时),使用该方法需要给函数配置委托。

    getSecuritySecretKey( )

    获取用户委托的SecuritySecretKey(有效期24小时),使用该方法需要给函数配置委托。

    getSecurityToken( )

    获取用户委托的SecurityToken(有效期24小时),使用该方法需要给函数配置委托。

    getUserData(string key)

    通过key获取用户通过环境变量传入的值。

    getFunctionName( )

    获取函数名称。

    getRunningTimeInSeconds ( )

    获取函数超时时间。

    getVersion( )

    获取函数的版本。

    getMemorySize( )

    分配的内存。

    getCPUNumber( )

    获取函数占用的CPU资源。

    getPackage( )

    获取函数组。

    getToken( )

    获取用户委托的token(有效期24小时),使用该方法需要给函数配置委托。

    getLogger( )

    获取context提供的logger方法(默认会输出时间、请求ID等信息)。

    getAlias

    获取函数的别名

    getToken()、getAccessKey()和getSecretKey()方法返回的内容包含敏感信息,请谨慎使用,避免造成用户敏感信息的泄露。

  • 日志接口

    Java SDK日志接口日志说明如表2所示。

    表2 日志接口说明表

    方法名

    方法说明

    RuntimeLogger()

    记录用户输入日志。包含方法如下:log(String string)。

执行结果

执行结果由3部分组成:函数返回、执行摘要和日志。

表3 执行结果说明

参数项

执行成功

执行失败

函数返回

返回函数中定义的返回信息。

返回包含错误信息和堆栈异常报错信息的JSON文件。格式如下:

{
  "errorMessage": "",
  "stackTrace": []
}

errorMessage:Runtime返回的错误信息

stackTrace:Runtime返回的堆栈异常报错信息

执行摘要

显示请求ID、配置内存、执行时长、实际使用内存和收费时长。

显示请求ID、配置内存、执行时长、实际使用内存和收费时长。

日志

打印函数日志,最多显示4KB的日志。

打印报错信息,最多显示4KB的日志。