UDF开发（Java）

您可以使用Java语言编写UDF代码，代码中需要包含如下信息：

• Java包（Package）：可选。

  您可以将定义的Java类打包，为后续查找和使用类提供方便。

• 继承UDF类：必选。

  必需携带的UDF类为com.aliyun.odps.udf.UDF。当您需要使用其他UDF类或者需要用到复杂数据类型时，请根据MaxCompute SDK添加需要的类。例如STRUCT数据类型对应的UDF类为com.aliyun.odps.data.Struct。

• @Resolve注解：可选。

  格式为@Resolve(<signature>)，signature用于定义函数的输入参数和返回值的数据类型。当您需要在UDF中使用STRUCT数据类型时，无法基于com.aliyun.odps.data.Struct反射分析得到Field Name和Field Type，所以需要用@Resolve注解来辅助获取。即如果您需要在UDF中使用STRUCT，请在UDF Class中加上@Resolve注解，注解只会影响参数或返回值中包含com.aliyun.odps.data.Struct的重载。例如@Resolve("struct<a:string>,string->string")。详细使用示例，请参见复杂数据类型示例。

• 自定义Java类：必选。

  UDF代码的组织单位，定义了实现业务需求的变量及方法。

• evaluate方法：必选。

  非静态的Public方法，位于自定义的Java类中。evaluate方法的输入参数和返回值的数据类型将作为SQL语句中UDF的函数签名Signature（定义UDF的输入与输出数据类型）。

  您可以在UDF中实现多个evaluate方法，在调用UDF时，MaxCompute会依据UDF调用的参数类型匹配正确的evaluate方法。

  编写Java UDF时可以使用Java Type或Java Writable Type，MaxCompute项目支持处理的数据类型与Java数据类型的详细映射关系，请参见附录：数据类型。

• UDF初始化或结束代码：可选。您可以通过void setup(ExecutionContext ctx)和void close()分别实现UDF初始化和结束。void setup(ExecutionContext ctx)方法会在evaluate方法前调用且仅会调用一次，可以用来初始化一些计算所需要的资源或类的成员对象。void close()方法会在evaluate方法结束后调用，可以用来执行一些清理工作，例如关闭文件。

UDF代码示例如下。

• 使用Java Type类型

  //将定义的Java类组织在org.alidata.odps.udf.examples包中。
  package org.alidata.odps.udf.examples;  
  //继承UDF类。
  import com.aliyun.odps.udf.UDF;         
  //自定义Java类。
  public final class Lower extends UDF { 
  //evaluate方法。其中：String标识输入参数的数据类型，return标识返回值。
      public String evaluate(String s) { 
          if (s == null) { 
          return null; 
      } 
          return s.toLowerCase(); 
    } 
  }

• 使用Java Writable Type类型

  //将定义的Java类组织在com.aliyun.odps.udf.example包中。
  package com.aliyun.odps.udf.example;
  //添加Java Writable Type类型必需的类。
  import com.aliyun.odps.io.Text;
  //继承UDF类。
  import com.aliyun.odps.udf.UDF;
  //自定义Java类。
  public class MyConcat extends UDF {
    private Text ret = new Text();
  //evaluate方法。其中：Text标识输入参数的数据类型，return标识返回值。
    public Text evaluate(Text a, Text b) {
        if (a == null || b == null) {
        return null;
      }
        ret.clear();
        ret.append(a.getBytes(), 0, a.getLength());
        ret.append(b.getBytes(), 0, b.getLength());
        return ret;
    }
  }

数据类型映射

为确保编写Java UDF过程中使用的数据类型与MaxCompute支持的数据类型保持一致，您需要关注二者间的数据类型映射关系。具体映射关系如下。

Hive兼容数据类型

当MaxCompute项目采用2.0数据类型版本时，支持Hive风格的UDF，您可以直接使用在MaxCompute兼容的Hive版本上开发的Hive UDF。

MaxCompute兼容的Hive版本为2.1.0，对应Hadoop版本为2.7.2。如果UDF是在其他版本的Hive或Hadoop上开发的，您需要使用兼容的Hive或Hadoop版本重新编译UDF JAR包。

在MaxCompute上使用Hive UDF的具体案例，请参见兼容Hive Java UDF示例。