MaxCompute支持您通过Java、Python语言编写代码创建UDAF，扩展MaxCompute的函数能力，满足个性化业务需求。本文为您介绍UDAF类型、使用限制、注意事项、开发流程及使用说明等信息。

背景信息

UDAF为用户自定义聚合函数，适用于多进一出业务场景。即其输入与输出是多对一的关系，将多条输入记录聚合成一个输出值。MaxCompute支持您通过如下两种代码语言编写UDAF。
UDAF类型说明
Java UDAF使用Java语言编写UDAF逻辑实现代码。更多信息，请参见Java UDAF。
Python UDAF使用Python语言编写UDAF逻辑实现代码，支持Python 2和Python 3：
  • Python 2 UDAF：Python语言版本为2.7。更多信息，请参见Python 2 UDAF。
  • Python 3 UDAF：Python语言版本为CPython-3.7.3。更多信息，请参见Python 3 UDAF。

使用限制

不支持通过自定义函数访问外网。如果您需要通过自定义函数访问外网，请根据业务情况填写并提交网络连接申请表单，MaxCompute技术支持团队会及时联系您完成网络开通操作。表单填写指导，请参见网络开通流程。

注意事项

使用自定义函数时，您需要注意：
  • 在性能上，自定义函数的性能低于内建函数，建议您优先使用内建函数实现相同逻辑的业务需求。
  • 在SQL语句中使用自定义函数时，如果计算的数据量过大并且存在倾斜，会导致作业占用的内存超出默认分配的内存。此时，您可以在Session级别设置set odps.sql.udf.joiner.jvm.memory=xxxx;属性来解决此问题。更多自定义函数常见问题，请参见MaxCompute UDF常见问题。
  • 当自定义函数的名称与内建函数的名称相同时，自定义函数会覆盖同名的内建函数。例如，MaxCompute中存在一个名称为CONCAT的自定义函数，则系统默认会调用自定义的CONCAT，不会调用内建函数CONCAT。如果您希望调用内建函数，需要在内建函数前增加::符号，例如select ::concat('ab', 'c');。

开发流程

UDAF的开发流程如下。

  • 当您使用Java代码编写MaxCompute UDF时，开发流程如下。Java开发流程
    序号可选/必选步骤功能介绍工具平台相关文档
    ①可选当您使用Maven编写代码时，需要先在Pom文件中添加代码相关SDK依赖，确保后续编写的代码可编译成功。例如开发自定义函数需要添加的SDK依赖为：
    <dependency>
    <groupId>com.aliyun.odps</groupId>
    <artifactId>odps-sdk-udf</artifactId>
   <version>0.29.10-public</version>
</dependency>
    您可以从Maven库中搜索odps-sdk-udf，获取SDK依赖版本信息。    		IntelliJ IDEA（Maven）无
    ②必选根据业务需求，编写自定义函数代码。IntelliJ IDEA（Maven）、MaxCompute Studio开发Java UDF
    ③必选通过本地运行或单元测试方式调试自定义函数，查看运行结果是否符合预期。
    ④必选调试自定义函数代码，确保本地运行成功后打包为JAR包。
    ⑤必选将JAR包作为资源上传至MaxCompute项目。使用客户端（odpscmd）连接、MaxCompute Studio、DataWorks
    ⑥必选基于上传的JAR包资源创建自定义函数。
    ⑦可选在查询数据代码中调用自定义函数。无
  • 当您使用Python代码编写MaxCompute UDF时，开发流程如下。Python开发流程
    序号可选/必选步骤功能介绍工具平台相关文档
    ①必选根据业务需求，编写自定义函数代码。MaxCompute Studio开发Python UDF
    ②必选通过本地运行或单元测试方式调试自定义函数，查看运行结果是否符合预期。
    ③必选将Python文件或依赖的资源（例如文件资源、表资源、第三方包）上传至MaxCompute项目。使用客户端（odpscmd）连接、MaxCompute Studio、DataWorks
    ④必选基于上传的Python文件或依赖的资源创建自定义函数。
    ⑤可选在查询数据代码中调用自定义函数。无

使用说明

自定义函数的使用方法如下：
  • 在归属MaxCompute项目中使用自定义函数：使用方法与内建函数类似，您可以参照内建函数的使用方法使用自定义函数。
  • 跨项目使用自定义函数：即在项目A中使用项目B的自定义函数，跨项目分享语句示例：select B:udf_in_other_project(arg0, arg1) as res from table_t;。更多跨项目分享信息，请参见基于Package跨项目访问资源。