MaxCompute：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樣本。