ExecuteGroovyScript
编辑人(全网同名)：酷酷的诚 邮箱：zhangchengk@foxmail.com
描述
Groovy脚本处理器。脚本负责处理传入的流文件以及任何脚本创建的流文件(例如，转移到成功或删除)。如果处理不完整或不正确，会话将回滚。
属性配置
在下面的列表中，必需属性的名称以粗体显示。任何其他属性(不是粗体)都被认为是可选的，并且指出属性默认值（如果有默认值），以及属性是否支持表达式语言。
| 属性名称 | 默认值 | 可选值 | 描述 |
|---|---|---|---|
| Script File | 要执行的脚本文件的路径。只能使用一个脚本文件或脚本主体 支持表达式语言:true | ||
| Script Body | 要执行的脚本体。只能使用一个脚本文件或脚本主体 | ||
| Failure strategy | rollback | ▪rollback ▪transfer to failure | 如何对待未处理的异常。如果希望通过代码管理异常，请保留默认值“rollback”。如果选中“transfer to failure”且有未处理异常发生，则此会话会将从传入队列接收的所有流文件都传输到“failure”关系，并带有附加属性:ERROR_MESSAGE和ERROR_STACKTRACE。如果选择 “rollback”且有未处理异常发生，则将从传入队列接收到的所有流文件进行惩罚并返回。如果处理器没有传入连接，则此参数无效。 |
| Additional classpath | 用分号分隔的类路径列表。 支持表达式语言:true |
动态属性：
该处理器允许用户指定属性的名称和值。
| 属性名称 | 属性值 | 描述 |
|---|---|---|
| 要更新的脚本引擎属性 | 要将其设置为的值 | 用动态属性的值指定的值更新由动态属性的键指定的脚本引擎属性。 支持表达式语言:true |
连接关系
| 名称 | 描述 |
|---|---|
| failure | 处理失败的流文件 |
| sucess | 成功处理的流文件 |
读取属性
没有指定。
写属性
没有指定。
状态管理
此组件不存储状态。
限制
| Required Permission | Explanation |
|---|---|
| execute code | 提供操作符执行任意代码的能力，假设NiFi具有所有权限。 |
输入要求
没有指定。
系统资源方面的考虑
没有指定。
应用场景
该处理器用于执行groovy脚本，可以灵活处理Flowfile.
详细说明
参数绑定说明表
| variable | type | description |
|---|---|---|
| session | org.apache.nifi.processor.ProcessSession | 用于获取，更改和传输输入文件的会话 |
| context | org.apache.nifi.processor.ProcessContext | 上下文（几乎没有用） |
| log | org.apache.nifi.logging.ComponentLog | 该处理器实例的日志记录器 |
| REL_SUCCESS | org.apache.nifi.processor.Relationship | 成功的路由关系 |
| REL_FAILURE | org.apache.nifi.processor.Relationship | 失败的路由关系 |
| CTL | java.util.HashMap<String,ControllerService> | 使用由处理器属性CTL.* 定义的控制器服务填充的Map映射。前缀CTL.*属性可以链接到控制器服务，并可以无需使用其他代码从脚本访问此服务。 |
| SQL | java.util.HashMap<String,groovy.sql.Sql> | Map填充了Groovy.sql.Sql对象，这些对象连接到使用处理器属性SQL.*定义的相应数据库。SQL.*属性只能链接到DBCPSercice。 |
| RecordReader | java.util.HashMap<String,RecordReaderFactory> | 使用由RecordReader.*处理器属性定义的控制器服务填充的Map映射。 RecordReader.属性将链接到RecordReaderFactory控制器服务实例。 |
| RecordWriter | java.util.HashMap<String,RecordSetWriterFactory> | 使用由RecordWriter.*处理器属性定义的控制器服务填充的Map映射。RecordWriter.属性将链接到RecordSetWriterFactory控制器服务实例。 |
| Dynamic processor properties | org.apache.nifi.components.PropertyDescriptor | 所有不是以CTL或SQL开头的处理器属性都绑定到脚本变量 |
示例说明
流程模板xml(1.9.2)
ExecuteGroovyScript.xml1.使用Groovy脚本组装数据
groovy脚本:这段脚本执行一个SQL 查询MySQL 并将结果写入到输出流属性
//By zhangchengk@foxmail.com
import groovy.json.JsonSlurper
import groovy.sql.Sql
import groovy.json.JsonOutput
//get the flowfile
def ff = session.get()
if(!ff)return
Map map = [:]
// get attributes of this flowfile
def tablename= ff.getAttribute('tableName')
// build the sql which select from slave table
def sql = "select * from ${tablename} limit 1"
//SQL.mydb references http://docs.groovy-lang.org/2.4.10/html/api/groovy/sql/Sql.html object
List list = SQL.mydb.rows(sql.toString()) //important to cast to String
map.put("result",list[0].toString())
def output = JsonOutput.toJson(map)
session.remove(ff)
def newff = session.create()
newff.putAttribute("data", output )
//transfer flow file to success
REL_SUCCESS << newff
