文档首页> 函数工作流 FunctionGraph> 开发指南> Java> 开发事件函数> Java函数开发指南（使用Eclipse工具）
更新时间：2024-03-05 GMT+08:00
查看PDF

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.huawei.Demo.my_initializer，那么FunctionGraph会去加载com.huawei包，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.huawei.Demo.my_initializer，那么FunctionGraph会去加载com.huawei包，Demo类中定义的my_initializer函数。

  • context参数

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

SDK接口

FunctionGraph函数JavaSDK提供了Event事件接口、Context接口和日志记录接口，SDK下载地址见Java SDK下载（校验文件：fss-java-sdk-2.0.5.sha256）。

  • Event事件接口

    Java SDK加入了触发器事件结构体定义，目前支持DMS、DIS、SMN、TIMER、APIG、Kafka、。在需要使用触发器的场景时，编写相关代码更简单。

    1. APIG触发器相关方法说明
      1. APIGTriggerEvent相关方法说明
        表1 APIGTriggerEvent相关方法说明

        方法名

        方法说明

        isBase64Encoded()

        Event中的body是否是base64编码

        getHttpMethod()

        获取Http请求方法

        getPath()

        获取Http请求路径

        getBody()

        获取Http请求body

        getPathParameters()

        获取所有路径参数

        getRequestContext()

        获取相关的APIG配置（返回APIGRequestContext对象）

        getHeaders()

        获取Http请求头

        getQueryStringParameters()

        获取查询参数

        说明：

        当前查询参数不支持取值为数组，如果查询参数的取值需要为数组，请自定义对应的触发器事件结构体。

        getRawBody()

        获取base64编码前的内容

        getUserData()

        获取APIG自定义认证中设置的userdata
        表2 APIGRequestContext相关方法说明

        方法名

        方法说明

        getApiId()

        获取API的ID

        getRequestId()

        获取此次API请求的requestId

        getStage()

        获取发布环境名称

        getSourceIp()

        获取APIG自定义认证信息中的源IP
      2. APIGTriggerResponse相关方法说明
        表3 APIGTriggerResponse构造方法说明

        方法名

        方法说明

        无参构造APIGTriggerResponse()

        其中headers设置为null，statusCode设置为200，body设置为" "，isBase64Encoded设置为false

        三个参数构造APIGTriggerResponse(statusCode, headers, body)

        isBase64Encoded设置为false，其他均以输入为准

        四个参数构造APIGTriggerResponse(statusCode, headers, isBase64Encoded, body)

        按照对应顺序设置值即可
        表4 APIGTriggerResponse相关方法说明

        方法名

        方法说明

        setBody(String body)

        设置消息体

        setHeaders(Map<String,String> headers)

        设置最终返回的Http响应头

        setStatusCode(int statusCode)

        设置Http状态码

        setBase64Encoded(boolean isBase64Encoded)

        设置body是否经过base64编码

        setBase64EncodedBody(String body)

        将输入进行base64编码，并设置到Body中

        addHeader(String key, String value)

        增加一组Http header

        removeHeader(String key)

        从现有的header中移除指定header

        addHeaders(Map<String,String> headers)

        增加多个header

        APIGTriggerResponse有headers属性，可以通过setHeaders方法和带有headers参数的构造函数对齐进行初始化。

    2. DIS触发器相关方法说明
      表5 DISTriggerEvent相关方法说明

      方法名

      方法说明

      getShardID()

      获取分区ID

      getMessage()

      获取DIS消息体（DISMessage结构）

      getTag()

      获取函数版本

      getStreamName()

      获取通道名称
      表6 DISMessage相关方法说明

      方法名

      方法说明

      getNextPatitionCursor()

      获取下一个游标

      getRecords()

      获取消息记录（DISRecord结构）

      getMillisBehindLatest()

      保留方法（目前返回0）
      表7 DISRecord相关方法说明

      方法名

      方法说明

      getPartitionKey()

      获取数据分区

      getData()

      数据

      getRawData()

      data经过base64解码后的字符串，UTF-8编码

      getSequenceNumber()

      获取序列号（每个记录的唯一标识）
    3. DMS触发器相关方法说明
      表8 DMSTriggerEvent相关方法说明

      方法名

      方法说明

      getQueueId()

      获取队列ID

      getRegion()

      获取区域名称

      getEventType()

      获取事件类型（返回“MessageCreated”）

      getConsumerGroupId()

      获取消费组ID

      getMessages()

      获取DMS消息（DMSMessage结构）
      表9 DMSMessage相关方法说明

      方法名

      方法说明

      getBody()

      获取DMS消息体

      getAttributes()

      获取DMS消息属性集合
    4. SMN触发器相关方法说明
      表10 SMNTriggerEvent相关方法说明

      方法名

      方法说明

      getRecord()

      获取消息记录集合（SMNRecord结构）
      表11 SMNRecord相关方法说明

      方法名

      方法说明

      getEventVersion()

      获取事件版本（当前为1.0）

      getEventSubscriptionUrn()

      获取订阅URN

      getEventSource()

      获取事件源

      getSmn()

      获取SMN事件消息体（SMNBody结构）
      表12 SMNBody相关方法说明

      方法名

      方法说明

      getTopicUrn()

      获取SMN主题URN

      getTimeStamp()

      获取消息时间戳

      getMessageAtrributes()

      获取消息属性集合

      getMessage()

      获取消息体

      getType()

      获取消息类型

      getMessageId()

      获取消息ID

      getSubject()

      获取消息主题
    5. 定时触发器相关方法说明
      表13 TimerTriggerEvent相关方法说明

      方法名

      方法说明

      getVersion()

      获取版本名称（当前为“v1.0”）

      getTime()

      获取当前时间

      getTriggerType()

      获取触发器类型（“Timer”）

      getTriggerName()

      获取触发器名称

      getUserEvent()

      获取触发器附加信息
    6. Kafka触发器相关方法说明
      表14 Kafka触发器相关方法说明

      方法名

      方法说明

      getEventVersion

      获取事件版本

      getRegion

      获取地区

      getEventTime

      获取产生时间

      getTriggerType

      获取触发器类型

      getInstanceId

      获取实例ID

      getRecords

      获取记录体
    1. 例如使用APIG触发器时，只需要把入口函数（假如函数名为handler）的第一个参数按照如下方式设置：handler(APIGTriggerEvent event, Context context)。
    2. 关于所有TriggerEvent，上面提到的TriggerEvent方法均有与之对应的set方法，建议在本地调试时使用；DIS和LTS均有对应的getRawData()方法，但无与之相应的setRawData()方法。
  • Context接口

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

    Context接口说明如表15所示。

    表15 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日志接口日志说明如表16所示。

    表16 日志接口说明表

    方法名

    方法说明

    RuntimeLogger()

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

开发Java函数

开发Java函数，以下给出demo实例步骤（使用Eclipse工具）：

  1. 创建函数工程

    1. 配置Eclipse，创建java工程JavaTest，如图1所示。
      图1 创建工程
    2. 添加工程依赖

      根据Java SDK下载提供的SDK地址，下载JavaRuntime SDK到本地开发环境解压，如图2所示。

      图2 下载SDK解压
    3. 配置依赖

      在工程目录下创建lib目录，将zip中的Runtime-2.0.5.jar拷贝到该目录中，并把该jar添加为工程依赖。如图3所示。

      图3 配置依赖

  2. 创建本地函数

    1. 创建包com.huawei.demo，并在包下创建TriggerTests类，如图4所示。
      图4 创建com.huawei.demo
    2. 在TriggerTests.java中定义函数运行入口，示例代码如下，如图5所示。 
       1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
      		 
      package com.huawei.demo;

import java.io.UnsupportedEncodingException;
import java.util.HashMap;
import java.util.Map;

import com.huawei.services.runtime.Context;
import com.huawei.services.runtime.entity.apig.APIGTriggerEvent;
import com.huawei.services.runtime.entity.apig.APIGTriggerResponse;
import com.huawei.services.runtime.entity.dis.DISTriggerEvent;
import com.huawei.services.runtime.entity.dms.DMSTriggerEvent;
import com.huawei.services.runtime.entity.smn.SMNTriggerEvent;
import com.huawei.services.runtime.entity.timer.TimerTriggerEvent;

public class TriggerTests {
    public APIGTriggerResponse apigTest(APIGTriggerEvent event, Context context){
        System.out.println(event);
        Map<String, String> headers = new HashMap<String, String>();
        headers.put("Content-Type", "application/json");
        return new APIGTriggerResponse(200, headers, event.toString());
    }

    public String smnTest(SMNTriggerEvent event, Context context){
        System.out.println(event);
        return "ok";
    }

    public String dmsTest(DMSTriggerEvent event, Context context){
        System.out.println(event);
        return "ok";
    }

    public String timerTest(TimerTriggerEvent event, Context context){
        System.out.println(event);
        return "ok";
    }

    public String disTest(DISTriggerEvent event, Context context) throws UnsupportedEncodingException{
        System.out.println(event);
        System.out.println(event.getMessage().getRecords()[0].getRawData());
        return "ok";
    }

}
      图5 定义函数运行入口

      当函数的事件源是APIG时，相关约束条件请参考Base64解码和返回结构体的说明。

  3. 工程打包

    1. 右击工程，选择“Export”，如图6所示。
      图6 打包
    2. 选择导出为jar，设置导出目录，如图7、图8所示。
      图7 选择
      图8 导出

  4. 创建Java函数，上传程序包。
  5. 测试函数

    1. 创建测试事件。

      在事件模板中选择“apig-event-template”，并保存。

    2. 单击“测试”并执行。

      函数执行结果分为三部分，分别为函数返回（由callback返回）、执行摘要、日志输出（由console.log或getLogger()方法获取的日志方法输出）。

    3. 创建一个APIG触发器。
    4. 访问调用URL，如图9所示。
      图9 访问调用URL

      把入口改成com.huawei.demo.TriggerTests.smnTest，并把事件模板改成smn。

  6. 在Java中使用自定义参数类型

    在工程中新建Person类，如图10所示。
    图10 新建Person类
    新建PersonTest.java，并在其中加入入口函数，如图11所示。
    图11 新建PersonTest.java

    导出新包后，先在函数配置详情界面上传JAR包，再修改函数执行入口为“com.huawei.demo.PersonTest.personTest”并保存。

    图12 上传JAR包

    打开配置测试事件对话框，选择空白模板，输入测试事件内容。

    单击“创建”后执行测试。

执行结果

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

表17 执行结果说明

参数项

执行成功

执行失败

函数返回

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

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

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

errorMessage：Runtime返回的错误信息

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

执行摘要

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

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

日志

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

打印报错信息，最多显示4KB的日志。
父主题： 开发事件函数