hive中添加UDF

叁歲伎倆 2022-10-06 14:48 132阅读 0赞

# Hive中有三种UDF: #

1、用户定义函数(user-defined function)UDF；

2、 用户定义聚集函数（user-defined aggregate function ， UDAF ）；

3、用户定义表生成函数（user-defined table-generating function， UDTF ）。

=======================================================================================

UDF操作作用于单个数据行，并且产生一个数据行作为输出。大多数函数都属于这一类（比如数学函数和字符串函数）。

UDAF 接受多个输入数据行，并产生一个输出数据行。像COUNT和MAX这样的函数就是聚集函数。

UDTF 操作作用于单个数据行，并且产生多个数据行-------一个表作为输出。lateral view explore()

简单来说：

UDF:返回对应值，一对一

UDAF：返回聚类值，多对一

UDTF：返回拆分值，一对多

# UDF #

1、UDF函数可以直接应用于select语句，对查询结构做格式化处理后，再输出内容。

2、编写UDF函数的时候需要注意一下几点：

a）自定义UDF需要继承org.apache.hadoop.hive.ql.UDF。

b）需要实现evaluate函数，evaluate函数支持重载。

例：写一个返回字符串长度的Demo:

![复制代码][48304ba5e6f9fe08f3fa1abda7d326ab.png]

import org.apache.hadoop.hive.ql.exec.UDF;
    
    public class GetLength extends UDF{
        public int evaluate(String str) {
            try{
                return str.length();
            }catch(Exception e){
                return -1;
            }
        }
    }

![复制代码][48304ba5e6f9fe08f3fa1abda7d326ab.png]

3、步骤

a）把程序打包放到目标机器上去；

b）进入hive客户端，添加jar包：

hive> add jar /root/hive_udf.jar

c）创建临时函数：

hive> create temporary function getLen as 'com.raphael.len.GetLength';

d）查询HQL语句：

![复制代码][48304ba5e6f9fe08f3fa1abda7d326ab.png]

hive> select getLen(info) from apachelog;
    OK
    60
    29
    87
    102
    69
    60
    67
    79
    66
    Time taken: 0.072 seconds, Fetched: 9 row(s)

![复制代码][48304ba5e6f9fe08f3fa1abda7d326ab.png]

e）销毁临时函数：

hive> DROP TEMPORARY FUNCTION getLen;

eg2:

Hive的UDF开发只需要重构UDF类的evaluate函数即可。例：  
  
  
package hive.connect;  
  
  
import org.apache.hadoop.hive.ql.exec.UDF;  
  
  
public final class Add extends UDF \{  
  
  
public Integer evaluate(Integer a, Integer b) \{  
  
  
               if (null == a || null == b) \{  
  
  
                               return null;  
  
  
               \} return a + b;  
  
  
\}  
  
  
public Double evaluate(Double a, Double b) \{  
  
  
               if (a == null || b == null)  
  
  
                               return null;  
  
  
                               return a + b;  
  
  
               \}  
  
  
public Integer evaluate(Integer... a) \{  
  
  
               int total = 0;  
  
  
               for (int i = 0; i < a.length; i++)  
  
  
                               if (a\[i\] != null)  
  
  
                                              total += a\[i\];  
  
  
                                              return total;  
  
  
                               \}  
  
  
\}  
  
  
4、步骤  
  
  
a）把程序打包放到目标机器上去；  
  
  
b）进入hive客户端，添加jar包：hive>add jar /run/jar/udf\_test.jar;  
  
  
c）创建临时函数：hive>CREATE TEMPORARY FUNCTION add\_example AS 'hive.udf.Add';  
  
  
d）查询HQL语句：  
  
  
SELECT add\_example(8, 9) FROM scores;  
  
  
SELECT add\_example(scores.math, scores.art) FROM scores;  
  
  
SELECT add\_example(6, 7, 8, 6.8) FROM scores;  
  
  
e）销毁临时函数：hive> DROP TEMPORARY FUNCTION add\_example;  
  
  
5、细节在使用UDF的时候，会自动进行类型转换，例如：  
  
  
SELECT add\_example(8,9.1) FROM scores;  
  
  
注：  
  
  
1.   UDF只能实现一进一出的操作，如果需要实现多进一出，则需要实现UDAF

# UDAF #

多行进一行出，如sum()、min()，用在group  by时

1.必须继承

org.apache.hadoop.hive.ql.exec.UDAF(函数类继承)

org.apache.hadoop.hive.ql.exec.UDAFEvaluator(内部类Evaluator实现UDAFEvaluator接口)

2.Evaluator需要实现 init、iterate、terminatePartial、merge、terminate这几个函数

init():类似于构造函数，用于UDAF的初始化

iterate():接收传入的参数，并进行内部的轮转，返回boolean

terminatePartial():无参数，其为iterate函数轮转结束后，返回轮转数据，类似于hadoop的Combiner

merge():接收terminatePartial的返回结果，进行数据merge操作，其返回类型为boolean

terminate():返回最终的聚集函数结果

eg:

一、用法  
  
  
1、一下两个包是必须的import org.apache.hadoop.hive.ql.exec.UDAF和 org.apache.hadoop.hive.ql.exec.UDAFEvaluator。  
  
  
2、函数类需要继承UDAF类，内部类Evaluator实UDAFEvaluator接口。  
  
  
3、Evaluator需要实现 init、iterate、terminatePartial、merge、terminate这几个函数。  
  
  
a）init函数实现接口UDAFEvaluator的init函数。  
  
  
b）iterate接收传入的参数，并进行内部的轮转。其返回类型为boolean。  
  
  
c）terminatePartial无参数，其为iterate函数轮转结束后，返回轮转数据，terminatePartial类似于hadoop的Combiner。  
  
  
d）merge接收terminatePartial的返回结果，进行数据merge操作，其返回类型为boolean。  
  
  
e）terminate返回最终的聚集函数结果。  
  
  
package hive.udaf;  
  
  
import org.apache.hadoop.hive.ql.exec.UDAF;  
  
  
import org.apache.hadoop.hive.ql.exec.UDAFEvaluator;  
  
  
public class Avg extends UDAF \{  
  
  
         public static class AvgState \{  
  
  
         private long mCount;  
  
  
         private double mSum;  
  
  
\}  
  
  
public static class AvgEvaluator implements UDAFEvaluator \{  
  
  
         AvgState state;  
  
  
         public AvgEvaluator() \{  
  
  
                   super();  
  
  
                   state = new AvgState();  
  
  
                   init();  
  
  
\}  
  
  
/\*\* \* init函数类似于构造函数，用于UDAF的初始化 \*/  
  
  
public void init() \{  
  
  
         state.mSum = 0;  
  
  
         state.mCount = 0;  
  
  
\}  
  
  
/\*\* \* iterate接收传入的参数，并进行内部的轮转。其返回类型为boolean \* \* @param o \* @return \*/  
  
  
public boolean iterate(Double o) \{  
  
  
         if (o != null) \{  
  
  
                   state.mSum += o;  
  
  
                   state.mCount++;  
  
  
         \} return true;  
  
  
\}  
  
  
/\*\* \* terminatePartial无参数，其为iterate函数轮转结束后，返回轮转数据， \* terminatePartial类似于hadoop的Combiner \* \* @return \*/  
  
  
public AvgState terminatePartial() \{  
  
  
         // combiner  
  
  
         return state.mCount == 0 ? null : state;  
  
  
\}  
  
  
/\*\* \* merge接收terminatePartial的返回结果，进行数据merge操作，其返回类型为boolean \* \* @param o \* @return \*/  
  
  
public boolean terminatePartial(Double o) \{                  
  
  
         if (o != null) \{  
  
  
                   state.mCount += o.mCount;  
  
  
                   state.mSum += o.mSum;  
  
  
         \}  
  
  
         return true;  
  
  
\}  
  
  
/\*\* \* terminate返回最终的聚集函数结果 \* \* @return \*/  
  
  
public Double terminate() \{  
  
  
         return state.mCount == 0 ? null : Double.valueOf(state.mSum / state.mCount);  
  
  
\}  
  
  
\}  
  
  
5、执行求平均数函数的步骤  
  
  
a）将java文件编译成Avg\_test.jar。  
  
  
b）进入hive客户端添加jar包：  
  
  
hive>add jar /run/jar/Avg\_test.jar。  
  
  
c）创建临时函数：  
  
  
hive>create temporary function avg\_test 'hive.udaf.Avg';  
  
  
d）查询语句：  
  
  
hive>select avg\_test(scores.math) from scores;  
  
  
e）销毁临时函数：  
  
  
hive>drop temporary function avg\_test;  
  
  
五、总结  
  
  
1、重载evaluate函数。  
  
  
2、UDF函数中参数类型可以为Writable，也可为java中的基本数据对象。  
  
  
3、UDF支持变长的参数。  
  
  
4、Hive支持隐式类型转换。  
  
  
5、客户端退出时，创建的临时函数自动销毁。  
  
  
6、evaluate函数必须要返回类型值，空的话返回null，不能为void类型。  
  
  
7、UDF是基于单条记录的列进行的计算操作，而UDFA则是用户自定义的聚类函数，是基于表的所有记录进行的计算操作。  
  
  
8、UDF和UDAF都可以重载。  
  
  
9、查看函数  
  
  
SHOW FUNCTIONS;

# UDTF #

## **1. UDTF介绍** ##

UDTF(User-Defined Table-Generating Functions) 用来解决 输入一行输出多行(On-to-many maping) 的需求。

## **2. 编写自己需要的UDTF** ##

继承org.apache.hadoop.hive.ql.udf.generic.GenericUDTF,实现initialize, process, close三个方法。

UDTF首先会调用initialize方法，此方法返回UDTF的返回行的信息（返回个数，类型）。

初始化完成后，会调用process方法,真正的处理过程在process函数中，在process中，每一次forward()调用产生一行；如果产生多列可以将多个列的值放在一个数组中，然后将该数组传入到forward()函数。

最后close()方法调用，对需要清理的方法进行清理。

下面是我写的一个用来切分”key:value;key:value;”这种字符串，返回结果为key, value两个字段。供参考：

![复制代码][69c5a8ac3fa60e0848d784a6dd461da6.png]

import java.util.ArrayList;
    
     import org.apache.hadoop.hive.ql.udf.generic.GenericUDTF;
     import org.apache.hadoop.hive.ql.exec.UDFArgumentException;
     import org.apache.hadoop.hive.ql.exec.UDFArgumentLengthException;
     import org.apache.hadoop.hive.ql.metadata.HiveException;
     import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspector;
     import org.apache.hadoop.hive.serde2.objectinspector.ObjectInspectorFactory;
     import org.apache.hadoop.hive.serde2.objectinspector.StructObjectInspector;
     import org.apache.hadoop.hive.serde2.objectinspector.primitive.PrimitiveObjectInspectorFactory;
    
     public class ExplodeMap extends GenericUDTF{
    
         @Override
         public void close() throws HiveException {
             // TODO Auto-generated method stub    
         }
    
         @Override
         public StructObjectInspector initialize(ObjectInspector[] args)
                 throws UDFArgumentException {
             if (args.length != 1) {
                 throw new UDFArgumentLengthException("ExplodeMap takes only one argument");
             }
             if (args[0].getCategory() != ObjectInspector.Category.PRIMITIVE) {
                 throw new UDFArgumentException("ExplodeMap takes string as a parameter");
             }
    
             ArrayList<String> fieldNames = new ArrayList<String>();
             ArrayList<ObjectInspector> fieldOIs = new ArrayList<ObjectInspector>();
             fieldNames.add("col1");
             fieldOIs.add(PrimitiveObjectInspectorFactory.javaStringObjectInspector);
             fieldNames.add("col2");
             fieldOIs.add(PrimitiveObjectInspectorFactory.javaStringObjectInspector);
    
             return ObjectInspectorFactory.getStandardStructObjectInspector(fieldNames,fieldOIs);
         }
    
         @Override
         public void process(Object[] args) throws HiveException {
             String input = args[0].toString();
             String[] test = input.split(";");
             for(int i=0; i<test.length; i++) {
                 try {
                     String[] result = test[i].split(":");
                     forward(result);
                 } catch (Exception e) {
                     continue;
                 }
             }
         }
     }

![复制代码][69c5a8ac3fa60e0848d784a6dd461da6.png]

## **3. 使用方法** ##

UDTF有两种使用方法，一种直接放到select后面，一种和lateral view一起使用。

1：直接select中使用

select explode_map(properties) as (col1,col2) from src;

不可以添加其他字段使用

select a, explode_map(properties) as (col1,col2) from src

不可以嵌套调用

select explode_map(explode_map(properties)) from src

不可以和group by/cluster by/distribute by/sort by一起使用

select explode_map(properties) as (col1,col2) from src group by col1, col2

2：和lateral view一起使用

select src.id, mytable.col1, mytable.col2 from src lateral view explode_map(properties) mytable as col1, col2;

此方法更为方便日常使用。执行过程相当于单独执行了两次抽取，然后union到一个表里。

[48304ba5e6f9fe08f3fa1abda7d326ab.png]: /images/20221005/46aa69c087944819b8f4bd7e3169c8e6.png
[69c5a8ac3fa60e0848d784a6dd461da6.png]: /images/20221005/eeb3b1d6f4ad408c8ece747d2d45de84.png