Kettle-ActiveMQ Consumer插件开发笔记

2024-04-29 08:32
文章标签 开发 笔记 插件 kettle activemq consumer

本文主要是介绍Kettle-ActiveMQ Consumer插件开发笔记，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

ActiveMQ Consumer插件开发笔记

源代码

https://github.com/tangwenixng/soyuan-activemq-plugin

概览

前提

该插件基于kettle 8.1.0.0-365 开发

如果是其他版本，不保证可用。(由于继承的BaseStreamingDialog等父类会随版本而变化)

本插件模仿官方Kafka插件源码编写：

https://github.com/pentaho/big-data-plugin/tree/master/kettle-plugins/kafka

暂不支持topic，需要的可自行修改源码(工程量应该不大)。

必备模板

首先必须创建的4个类：

  • ActiveMQConsumer extends BaseStreamStep implements StepInterface
  • ActiveMQConsumerData extends TransExecutorData implements StepDataInterface
  • ActiveMQConsumerDialog extends BaseStreamingDialog implements StepDialogInterface
  • ActiveMQConsumerMeta extends BaseStreamStepMeta implements StepMetaInterface

注意这4个类继承的父类比较特殊，不同于一般的步骤插件继承的是BaseStep***

然后创建多语言(资源)配置文件：结构如下图所示

接下来将分别说明刚刚列举的4个类。

ActiveMQConsumerMeta

ActiveMQConsumerMeta是非常重要的一个类。

  1. 可视化Dialog里看到的属性值(比如: Text框框)在点击了确认按钮时会保存到ActiveMQConsumerMeta中对应的成员变量的。当第一次打开步骤界面Dialog时(即open方法时-后面会讲到),也是从ActiveMQConsumerMeta中读取成员变量赋值到Text框框中。
  2. 当在Kettle编辑界面点击了保存Save按钮时，会将ActiveMQConsumerMeta中的属性通过getXML()方法写入到文件(ktr)中。当点击运行按钮时，kettle会调用loadXML()将ktr文件内容读取到ActiveMQConsumerMeta成员变量中。同理readRep和saveRep。

上面介绍了Meta类的主要工作，接着具体说明下代码中需要注意的点：

Step注解

@Step(id = "ActiveMQConsumer",name = "ActiveMQConsumer.TypeLongDesc",description = "ActiveMQConsumer.TypeTooltipDesc",image = "com/soyuan/steps/activemq/resources/activemq.svg",categoryDescription = "i18n:org.pentaho.di.trans.step:BaseStep.Category.Streaming",i18nPackageName = "com.soyuan.steps.activemq",documentationUrl = "ActiveMQConsumer.DocumentationURL",casesUrl = "ActiveMQConsumer.CasesURL",forumUrl = "ActiveMQConsumer.ForumURL"
)
@InjectionSupported(localizationPrefix = "ActiveMQConsumerMeta.Injection.")

@step注解是定义步骤的规范，kettle会自动扫描此注解，并将它注入到插件容器内。

  • id必须是全局唯一的
  • name: 也就是我们在可视化界面中看到的插件名字。后面跟的ActiveMQConsumer.TypeLongDesc指向的是配置文件properties中的属性
  • @InjectionSupported(localizationPrefix = "ActiveMQConsumerMeta.Injection.") 中的ActiveMQConsumerMeta.Injection.需要配合ActiveMQConsumerMeta中的成员变量来使用。比如：
/*** 连接地址*/
@Injection( name = "BROKER_URL" )
private String brokerUrl;

这里的BROKER_URL和刚刚的ActiveMQConsumerMeta.Injection.搭配起来就成了ActiveMQConsumer.Injection.BROKER_URL。

这个属性也是在配置文件properties中配置的

构造方法

public ActiveMQConsumerMeta() {super();...setSpecificationMethod(ObjectLocationSpecificationMethod.FILENAME);
}
  • 注意指定setSpecificationMethod(ObjectLocationSpecificationMethod.FILENAME);这里设置的ObjectLocationSpecificationMethod.FILENAME值会在ActiveMQConsumerDialog.getData()用到

接口方法

@Override
public StepInterface getStep(StepMeta stepMeta, StepDataInterface stepDataInterface, int copyNr, TransMeta transMeta, Trans trans) {return new ActiveMQConsumer(stepMeta, stepDataInterface, copyNr, transMeta, trans);
}@Override
public StepDataInterface getStepData() {return new ActiveMQConsumerData();
}

这两个方法是接口必须实现的，按照模板来就行

成员变量

看代码注释

//固定用法，配合BaseMessages类从配置文件中读取配置
private static Class<?> PKG = ActiveMQConsumerMeta.class;/*** 以下静态变量用于定义xml中的标签tag*/
public static final String BROKER_URL = "brokerUrl";
public static final String QUEUE_NAME = "queue";public static final String TRANSFORMATION_PATH = "transformationPath";
public static final String BATCH_SIZE = "batchSize";
public static final String BATCH_DURATION = "batchDuration";public static final String OUTPUT_FIELD_TAG_NAME = "OutputField";
public static final String INPUT_NAME_ATTRIBUTE = "input";
public static final String TYPE_ATTRIBUTE = "type";public static final String ADVANCED_CONFIG = "advancedConfig" ;
private static final String CONFIG_OPTION = "option";
private static final String OPTION_PROPERTY = "property";
private static final String OPTION_VALUE = "value";/*** 连接地址*/
@Injection( name = "BROKER_URL" )
private String brokerUrl;/*** 队列名称*/
@Injection(name="QUEUE")
private String queue;/*** 注入的配置: 注意是transient* 在哪赋值的-Dialog中*/
@Injection(name = "NAMES", group = "CONFIGURATION_PROPERTIES")
protected transient List<String> injectedConfigNames;@Injection(name = "VALUES", group = "CONFIGURATION_PROPERTIES")
protected transient List<String> injectedConfigValues;private ActiveMQConsumerField msgIdField;
private ActiveMQConsumerField msgField;
private ActiveMQConsumerField timestampField;/*** 存放xml 中的advancedConfig option*/
private Map<String, String> config = new LinkedHashMap<>();

brokerUrl queue config msgIdField config 等变量是核心，它们流转于Dialog、ActiveMQConsumer(StepInterface)中。

injectedConfigNames、injectedConfigValues 是用于辅助生成config变量的(可以丢掉)

config变量对应的是Options Tab中的属性，是可变化的(可删除、增加)

msgField封装成ActiveMQConsumerField 枚举类,是便于可扩展以及可流转。（后面再详细叙说）

其他方法

@Override
public RowMeta getRowMeta(String origin, VariableSpace space) throws KettleStepException {RowMeta rowMeta = new RowMeta();putFieldOnRowMeta(getMsgIdField(), rowMeta, origin, space);putFieldOnRowMeta(getMsgField(), rowMeta, origin, space);putFieldOnRowMeta(getTimestampField(), rowMeta, origin, space);return rowMeta;
}private void putFieldOnRowMeta(ActiveMQConsumerField field, RowMetaInterface rowMeta,String origin, VariableSpace space) throws KettleStepException {if (field != null && !Utils.isEmpty(field.getOutputName())) {try {String value = space.environmentSubstitute(field.getOutputName());ValueMetaInterface v = ValueMetaFactory.createValueMeta(value,field.getOutputType().getValueMetaInterfaceType());//这里为什么要set步骤名称v.setOrigin(origin);rowMeta.addValueMeta(v);} catch (KettlePluginException e) {throw new KettleStepException(BaseMessages.getString(PKG,"ActiveMQConsumerInputMeta.UnableToCreateValueType",field), e);}}
}public List<ActiveMQConsumerField> getFieldDefinitions() {return Lists.newArrayList(getMsgIdField(), getMsgField(), getTimestampField());
}protected void setField(ActiveMQConsumerField field) {field.getInputName().setFieldOnMeta(this, field);
}
  • getRowMeta 是用于获取输出的字段的，即一行数据由哪几列组成。在步骤初始化(ActiveMQConsumer#init)的时候被调用。
  • putFieldOnRowMeta 组装一列数据（数据名称、类型）
  • getFieldDefinitions 获取输出字段列表（只是简单的将成员变量组成列表）
  • setField(ActiveMQConsumerField field) 这里比较绕–稍候描述

ActiveMQConsumerDialog

ActiveMQConsumerDialog 继承了 BaseStreamingDialog，BaseStreamingDialog中实现了open 方法 ，所以不需要复写open方法，只需重写以下几个方法即可。

  • getDialogTitle()-设置标题
  • buildSetup(Composite wSetupComp) - 实现启动页面（必要的信息-服务器地址、队列名称）
  • getData()-重写此方法，将meta中的信息设置到启动页面的元素和父类的Text 或者 其他Tab也中(如果有的话)
  • createAdditionalTabs() 在此方法里创建额外的Tab
  • additionalOks(BaseStreamStepMeta meta)：确认按钮，将Dialog中的数据保存至meta中。保存启动页、额外Tab页数据
  • getFieldNames() -如果创建了Field Tab,这里对应的是Output Name(第2列)
  • getFieldTypes() -如果创建了Field Tab,这里对应的是Type(第3列)

构造方法

public ActiveMQConsumerDialog(Shell parent, Object in, TransMeta tr, String sname) {super(parent, in, tr, sname);this.consumerMeta = (ActiveMQConsumerMeta) in;
}

需要注意的是 第二个参数是Object(实际是ActiveMQConsumerMeta对象)

getData()

@Override
protected void getData() {...switch ( specificationMethod ) {case FILENAME:wTransPath.setText(Const.NVL(meta.getFileName(), ""));break;case REPOSITORY_BY_NAME:String fullPath = Const.NVL(meta.getDirectoryPath(), "") + "/" + Const.NVL(meta.getTransName(), "");wTransPath.setText(fullPath);break;case REPOSITORY_BY_REFERENCE:referenceObjectId = meta.getTransObjectId();getByReferenceData(referenceObjectId);break;default:break;}...
}

这一段直接抄过来即可。

additionalOks()

将Dialog中的数据保存至meta中。保存启动页、额外Tab页数据

@Override
protected void additionalOks(BaseStreamStepMeta meta) {consumerMeta.setBrokerUrl(wBrokerUrl.getText());consumerMeta.setQueue(wQueue.getText());//将field值设置到meta中setFieldsFromTable();//将option中的值设置到meta中setOptionsFromTable();
}

注意一下setFieldsFromTable()方法=>保存field

/*** 将field值设置到meta中*/
private void setFieldsFromTable() {int itemCount = fieldsTable.getItemCount();for (int rowIndex = 0; rowIndex < itemCount; rowIndex++) {TableItem row = fieldsTable.getTable().getItem(rowIndex);String inputName = row.getText(1);String outputName = row.getText(2);String outputType = row.getText(3);final ActiveMQConsumerField.Name ref = ActiveMQConsumerField.Name.valueOf(inputName.toUpperCase());final ActiveMQConsumerField field = new ActiveMQConsumerField(ref, outputName,ActiveMQConsumerField.Type.valueOf(outputType));consumerMeta.setField(field);}
}

将Field Table中每一行数据 实例化成 ActiveMQConsumerField对象，然后set到meta中。

consumerMeta.setField(field);最终会调用 类似 consumerMeta.setMsgField 等具体的set方法,可以仔细研究一下ActiveMQConsumerField类

getFieldNames()

getFieldNames()和getFieldTypes() 从描述来看，其实是提取Field Tab中的值，但它们的实际作用是什么呢？

如上图所示，当点击了New(新建转换)并保存后，在新文件中的Get records from stream步骤中就会有Field Tab中的值了

ActiveMQConsumerData

ActiveMQConsumerData 继承自 TransExecutorData ，只有一个成员变量 RowMetaInterface outputRowMeta=>存储[行元数据]

ActiveMQConsumer

ActiveMQConsumer继承自BaseStreamStep，所以无需重写processRow(),只需重写init()方法即可。

@Override
public boolean init(StepMetaInterface stepMetaInterface, StepDataInterface stepDataInterface) {ActiveMQConsumerMeta meta = (ActiveMQConsumerMeta) stepMetaInterface;ActiveMQConsumerData data = (ActiveMQConsumerData) stepDataInterface;if (!super.init(meta,data)){logError(BaseMessages.getString(PKG, "ActiveMQConsumer.Error.InitFailed"));return false;}try {//创建[行元数据]-即:输出哪些字段data.outputRowMeta = meta.getRowMeta(getStepname(), this);} catch (KettleStepException e) {log.logError(e.getMessage(), e);}//创建activemq connectionfinal Connection connection;try {connection = ActiveMQFactory.getConn(meta.getActiveMQEntity());//subtransExecutor:子转换执行器window = new FixedTimeStreamWindow<>(subtransExecutor,data.outputRowMeta,getDuration(),getBatchSize());source = new ActiveMQStreamSource(connection, meta, data, this);} catch (JMSException e) {log.logError(e.getMessage(),e);return false;}return true;
}

以上是init方法的全部内容。我们来分段看。

try {//创建[行元数据]-即:输出哪些字段data.outputRowMeta = meta.getRowMeta(getStepname(), this);
} catch (KettleStepException e) {log.logError(e.getMessage(), e);
}

meta.getRowMeta(getStepname(), this);刚刚在ActiveMQConsumerMeta中已经介绍过了。主要是构建[行数据]-即列名称、类型。

connection = ActiveMQFactory.getConn(meta.getActiveMQEntity());从meta中获取服务器地址、队列名称等信息来获取连接。

//subtransExecutor:子转换执行器
window = new FixedTimeStreamWindow<>(subtransExecutor,data.outputRowMeta,getDuration(),getBatchSize());

固定这样写，将 data.outputRowMeta【行元数据】传给子窗口即可

source = new ActiveMQStreamSource(connection, meta, data, this);

source是父类BaseStreamStep的一个成员变量protected StreamSource<List<Object>> source ，所以我们的ActiveMQStreamSource是StreamSource<List<Object>>的实现类。

主要的职责是消费ActiveMQ的数据，然后传递给子窗口，怎么传递不需要关心。

我们现在看ActiveMQStreamSource代码。

ActiveMQStreamSource

在open()方法中有这样一段代码：

final List<ValueMetaInterface> valueMetas = consumerData.outputRowMeta.getValueMetaList();
positions = new HashMap<>(valueMetas.size());for (int i = 0; i < valueMetas.size(); i++) {for (ActiveMQConsumerField.Name name : ActiveMQConsumerField.Name.values()) {final ActiveMQConsumerField field = name.getFieldFromMeta(consumerMeta);String outputName = field.getOutputName();if (outputName != null && outputName.equals(valueMetas.get(i).getName())) {positions.putIfAbsent(name, i);}}
}

目的是找出某一列的位置。 假如：Message-1 MessageId-2

callable = new ActiveMQConsumerCallable(connection, super::close);
future = executorService.submit(callable);

具体的消费线程ActiveMQConsumerCallable

while (!closed.get()) {final TextMessage msg = (TextMessage) consumer.receive(1000L);if (msg != null) {List<List<Object>> rows = new ArrayList<>(1);final List<Object> row = processMessageAsRow(msg);rows.add(row);acceptRows(rows);session.commit();}
}

一直尝试拉取activemq的数据，如果有数据，调用processMessageAsRow(msg)处理数据，然后调用acceptRows(rows)传递给后续的步骤处理。

List<Object> processMessageAsRow(TextMessage msg) throws JMSException {Object[] rowData = RowDataUtil.allocateRowData(consumerData.outputRowMeta.size());if (positions.get(ActiveMQConsumerField.Name.MESSAGEID) != null) {rowData[positions.get(ActiveMQConsumerField.Name.MESSAGEID)] = msg.getJMSMessageID();}if (positions.get(ActiveMQConsumerField.Name.MESSAGE) != null) {rowData[positions.get(ActiveMQConsumerField.Name.MESSAGE)] = msg.getText();}if (positions.get(ActiveMQConsumerField.Name.TIMESTAMP) != null) {rowData[positions.get(ActiveMQConsumerField.Name.TIMESTAMP)] = msg.getJMSTimestamp();}return Arrays.asList(rowData);
}

processMessageAsRows其实就是将从active mq拿到的数据塞到对应的列(这也是为什么一开始要有positions = new HashMap<>(valueMetas.size())的原因)上去。

至此，ActiveMQ Consumer插件开发的主要步骤就介绍完毕了。

这篇关于Kettle-ActiveMQ Consumer插件开发笔记的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/945593。

相关文章

基于Python开发一个有趣的工作时长计算器

基于Python开发一个有趣的工作时长计算器

《基于Python开发一个有趣的工作时长计算器》随着远程办公和弹性工作制的兴起,个人及团队对于工作时长的准确统计需求日益增长,本文将使用Python和PyQt5打造一个工作时长计算器,感兴趣的小伙伴可... 目录概述功能介绍界面展示php软件使用步骤说明代码详解1.窗口初始化与布局2.工作时长计算核心逻辑3
阅读更多...
maven中的maven-antrun-plugin插件示例详解

maven中的maven-antrun-plugin插件示例详解

《maven中的maven-antrun-plugin插件示例详解》maven-antrun-plugin是Maven生态中一个强大的工具,尤其适合需要复用Ant脚本或实现复杂构建逻辑的场景... 目录1. 核心功能2. 典型使用场景3. 配置示例4. 关键配置项5. 优缺点分析6. 最佳实践7. 常见问题
阅读更多...
python web 开发之Flask中间件与请求处理钩子的最佳实践

python web 开发之Flask中间件与请求处理钩子的最佳实践

《pythonweb开发之Flask中间件与请求处理钩子的最佳实践》Flask作为轻量级Web框架,提供了灵活的请求处理机制,中间件和请求钩子允许开发者在请求处理的不同阶段插入自定义逻辑,实现诸如... 目录Flask中间件与请求处理钩子完全指南1. 引言2. 请求处理生命周期概述3. 请求钩子详解3.1
阅读更多...
如何基于Python开发一个微信自动化工具

如何基于Python开发一个微信自动化工具

《如何基于Python开发一个微信自动化工具》在当今数字化办公场景中,自动化工具已成为提升工作效率的利器,本文将深入剖析一个基于Python的微信自动化工具开发全过程,有需要的小伙伴可以了解下... 目录概述功能全景1. 核心功能模块2. 特色功能效果展示1. 主界面概览2. 定时任务配置3. 操作日志演示
阅读更多...
JavaScript实战：智能密码生成器开发指南

JavaScript实战：智能密码生成器开发指南

本文通过JavaScript实战开发智能密码生成器，详解如何运用crypto.getRandomValues实现加密级随机密码生成，包含多字符组合、安全强度可视化、易混淆字符排除等企业级功能。学习密码强度检测算法与信息熵计算原理，获取可直接嵌入项目的完整代码，提升Web应用的安全开发能力 目录
阅读更多...
MyBatis分页插件PageHelper深度解析与实践指南

MyBatis分页插件PageHelper深度解析与实践指南

《MyBatis分页插件PageHelper深度解析与实践指南》在数据库操作中,分页查询是最常见的需求之一,传统的分页方式通常有两种内存分页和SQL分页,MyBatis作为优秀的ORM框架,本身并未提... 目录1. 为什么需要分页插件？2. PageHelper简介3. PageHelper集成与配置3.
阅读更多...
Maven 插件配置分层架构深度解析

Maven 插件配置分层架构深度解析

《Maven插件配置分层架构深度解析》：本文主要介绍Maven插件配置分层架构深度解析,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Maven 插件配置分层架构深度解析引言：当构建逻辑遇上复杂配置第一章 Maven插件配置的三重境界1.1 插件配置的拓扑
阅读更多...
Idea插件MybatisX失效的问题解决

Idea插件MybatisX失效的问题解决

《Idea插件MybatisX失效的问题解决》：本文主要介绍Idea插件MybatisX失效的问题解决,详细的介绍了4种问题的解决方法,具有一定的参考价值,感兴趣的可以了解一下... 目录一、重启idea或者卸载重装MyBATis插件（无需多言）二、检查.XML文件与.Java（该文件后缀Idea可能会隐藏
阅读更多...
一文教你如何解决Python开发总是import出错的问题

一文教你如何解决Python开发总是import出错的问题

《一文教你如何解决Python开发总是import出错的问题》经常朋友碰到Python开发的过程中import包报错的问题,所以本文将和大家介绍一下可编辑安装（EditableInstall）模式,可... 目录摘要1. 可编辑安装（Editable Install）模式到底在解决什么问题？2. 原理3.
阅读更多...
Python+PyQt5开发一个Windows电脑启动项管理神器

Python+PyQt5开发一个Windows电脑启动项管理神器

《Python+PyQt5开发一个Windows电脑启动项管理神器》：本文主要介绍如何使用PyQt5开发一款颜值与功能并存的Windows启动项管理工具,不仅能查看/删除现有启动项,还能智能添加新... 目录开篇：为什么我们需要启动项管理工具功能全景图核心技术解析1. Windows注册表操作2. 启动文件
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2