【Hive】自定义函数

时间：2021-09-15 12:11:20

　　Hive的自定义函数无法满足实际业务的需要，所以为了扩展性，Hive官方提供了自定义函数来实现需要的业务场景。

1、定义

(1)udf(user defined function)：  自定义函数，特点是输入一行，输出一行

(2)udaf(user defined aggregation function)：自定义聚合函数，特点是输入多行，输出一行

(3)udtf(User-Defined Table-Generating Functions):自定义拆分函数，特点是输入一行，输出多行

2、使用

(1)开发UDF

　　函数类需要继承org.apache.hadoop.hive.ql.UDF

　 实现evaluate函数

　(2)开发UDAF

　　函数类需要继承UDAF类，内部类Evaluator实UDAFEvaluator接口。　　

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

　 init函数实现接口UDAFEvaluator的init函数。

　　iterate接收传入的参数，并进行内部的轮转。其返回类型为boolean。

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

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

　　terminate返回最终的聚集函数结果。

　(3)开发UDTF　　　

　　函数类需要继承org.apache.hadoop.hive.ql.udf.generic.GenericUDTF

　　实现initialize, process, close三个方法。

　　initialize方法返回UDTF的返回行的信息（返回个数，类型）

　　process方法对传入的参数进行处理，可以通过forword()方法把结果返回

　　close()方法需要清理的方法进行清理

3.项目示例

　(1)环境搭配

　　因为写函数的时候所用到的jar比较多，这里我使用的是maven自动导入。

　　所以我们首先建立一个maven项目，我这里使用的是hadoop2.6.0+hive1.1.0

　　在配置文件中添加一下内容，然后点击更新配置

　　<repositories>

   <repository>
      <id>apache</id>
      <url>http://maven.apache.org</url>
    </repository>
  </repositories>
  <dependencies>
    <dependency>
      <groupId>org.apache.hadoop</groupId>
      <artifactId>hadoop-mapreduce-client-core</artifactId>
      <version>2.6.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.hadoop</groupId>
      <artifactId>hadoop-common</artifactId>
      <version>2.6.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.hadoop</groupId>
      <artifactId>hadoop-mapreduce-client-common</artifactId>
      <version>2.6.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.hadoop</groupId>
      <artifactId>hadoop-mapreduce-client-jobclient</artifactId>
      <version>2.6.0</version>
    </dependency>
    <dependency>
      <groupId>org.apache.hive</groupId>
      <artifactId>hive-exec</artifactId>
      <version>1.1.0</version>
    </dependency>
  </dependencies>
（2）编写UDTF
　　 继承org.apache.hadoop.hive.ql.udf.generic.GenericUDTF,实现initialize, process, close三个方法。
    UDTF首先会调用initialize方法，此方法返回UDTF的返回行的信息（返回个数，类型）。
    初始化完成后，会调用process方法,真正的处理过程在process函数中，
    在process中，每一次forward()调用产生一行；如果产生多列可以将多个列的值放在一个数组中，然后将该数组传入到forward()函数。
    最后close()方法调用，对需要清理的方法进行清理。
　　
　　下面是一个把map(key,value)的一列切分成key，value两列的例子
　　
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");

         }

　　　　　//定义返回信息，这里为两列String类型的数据

         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);//每一次forward产生一行数据，多列可以返回一个数组
　　　　　　　　　　//注意，每次forward回去的数据必须是一个数组，数组从头到尾与之前定义的返回列对应的，result[0]对应col1，result[1]对应col2
　　　　　　　　　　//每次forward产生一行数据
　　　　　　　　　　//数组大小取决于你之前定义返回列数

             } catch (Exception e) {

                 continue;

             }

         }

     }

 }

　（3)打包

　　我们这里采用的是用maven的命令打包

　　我们打开cmd，打开到项目porm.xml文件所在目录

　　然后输入mvn clean package -DskipTests=true命令

　　打包成功在文件下target目录下会找到打包好的jar包

　　然后我们需要把jar放在集群中再添加到hive中

　　我们打开hive

　　输入

　　add jar + jar包绝对路径;
　　create temporary function 函数明 as '项目名.类名';

　　注意这里创建的是临时函数，每次使用的时候都要进行导入。

　 (4）使用

　　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到一个表里。　

 

相关文章