文档首页/ 函数工作流 FunctionGraph/ 开发指南/ Java/ 开发Java事件函数/ Java函数开发指南(使用IDEA工具创建maven工程)
更新时间:2025-08-05 GMT+08:00
分享

Java函数开发指南(使用IDEA工具创建maven工程)

本章节介绍使用IDEA工具创建maven工程开发Java函数。关于Java函数接口定义、Initializer入口介绍以及SDK接口说明请参考Java函数开发概述

操作流程

您可以跟随本文以下步骤从头开始创建Java工程和Java函数,也可以直接下载Java的函数样例工程包并从步骤三:创建Java函数并测试开始操作。

步骤一:使用IDEA创建maven工程

  1. 创建函数工程
    配置IDEA,创建maven工程,如图1所示。
    图1 创建工程
  2. 添加工程依赖

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

    图2 下载SDK解压
    1. 将zip中的Runtime-2.0.5.jar拷贝到本地目录,例如d:\\runtime中,在命令行窗口执行如下命令安装到本地的maven仓库中。
      mvn install:install-file -Dfile=d:\runtime\RunTime-2.0.5.jar -DgroupId=RunTime -DartifactId=RunTime -Dversion=2.0.5 -Dpackaging=jar
    2. 在pom.xml中配置dependency,如下所示。
      <dependency>
      <groupId>Runtime</groupId>
      <artifactId>Runtime</artifactId>
      <version>2.0.5</version>
      </dependency>
    3. 配置其他的依赖包,以obs依赖包为例,如下所示。
      <dependency>
      <groupId>com.huaweicloud</groupId>
      <artifactId>esdk-obs-java</artifactId>
      <version>3.21.4</version>
      </dependency>
    4. 在pom.xml中添加插件用来将代码和依赖包打包到一起。请把mainClass替换为真实的类。
      <build>
        <plugins>
          <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
              <descriptorRefs>
                <descriptorRef>jar-with-dependencies</descriptorRef>
              </descriptorRefs>
              <archive>
                <manifest>
                  <mainClass>com.huawei.demo.TriggerTests</mainClass>
                </manifest>
              </archive>
              <finalName>${project.name}</finalName>
            </configuration>
            <executions>
              <execution>
                <id>make-assembly</id>
                <phase>package</phase>
                <goals><goal>single</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
  3. 配置函数资源
    创建包com.huawei.demo,并在包下创建TriggerTests类,如图3所示。
    图3 创建TriggerTests类
  4. 配置函数代码
    在TriggerTests.java中定义函数运行入口,示例代码如下:
     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
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    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.lts.LTSTriggerEvent;
    import com.huawei.services.runtime.entity.smn.SMNTriggerEvent;
    import com.huawei.services.runtime.entity.timer.TimerTriggerEvent;
    import com.huawei.services.runtime.entity.eventgrid.EventGridTriggerEvent;
    
    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";
        }
    
        public String ltsTest(LTSTriggerEvent event, Context context) throws UnsupportedEncodingException {
            System.out.println(event);
            event.getLts().getData();
            System.out.println("raw data: " + event.getLts().getRawData());
            return "ok";
        }
    
        public String eventgridTest(EventGridTriggerEvent event, Context context){
            System.out.println(event);return "ok";
        }
    }
    

    示例代码中添加了多个入口函数,分别使用了不同的触发器事件类型,可通过FunctionGraph控制台修改函数执行入口测试不同的入口函数。当函数的事件源是APIG时,相关约束条件请参考Base64解码和返回结构体的说明

    修改函数执行入口:

    在FunctionGraph控制台左侧导航栏选择“函数 > 函数列表”,单击需要设置的“函数名称”进入函数详情页,选择“设置 > 常规设置”,配置“函数执行入口”参数,如图4所示。
    图4 函数执行入口
  5. 工程编译打包

    在命令行窗口执行如下命令进行编译打包。编译完成后在target目录会生成一个demo-jar-with-dependencies.jar。

    mvn package assembly:single

步骤二:创建Java函数并测试

  1. 登录函数工作流控制台,左侧导航栏选择函数 > 函数列表,单击右上角“创建函数”进入创建函数页面,选择“创建空白函数”。
  2. 图5所示,配置函数基本信息,配置完成后单击右下角“创建函数”完成创建。
    图5 创建Java函数

  3. 进入函数详情页,在“代码”页签下,单击右侧上传代码 > JAR文件 ,添加步骤一:使用IDEA创建maven工程的JAR文件上传。
  4. 上传成功后,选择“设置 > 常规设置”,修改需要测试的函数执行入口参数,单击保存
  5. 回到“代码”页签,单击代码编辑区的“测试”,选择“创建新的测试事件”,在云事件模板列表中选择需要测试的事件模板,单击“创建”
  6. 单击“测试”,查看函数执行结果。

    函数执行结果分为三部分,分别为函数返回(由callback返回)、执行摘要、日志输出(由console.log或getLogger()方法获取的日志方法输出),参考表1查看结果说明。

    表1 执行结果说明

    参数项

    执行成功

    执行失败

    函数返回

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

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

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

    errorMessage:Runtime返回的错误信息

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

    执行摘要

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

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

    日志

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

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

    如需测试示例代码中的其他事件源触发器,例如SMN事件源,可在函数的常规设置中,将函数执行入口修改为com.huawei.demo.TriggerTests.smnTest,并参考以上步骤,创建新的消息通知服务SMN测试事件进行函数测试。

相关文档