文档

RocketMQ触发器

更新时间:
一键部署

消息队列 RocketMQ 版作为事件源通过事件总线EventBridge函数计算集成后,通过消息队列 RocketMQ 版触发器(以下简称RocketMQ触发器)能够触发关联函数执行,通过函数可以对发布到消息队列 RocketMQ 版中的消息进行自定义处理。本文介绍如何在函数计算控制台创建RocketMQ触发器、配置函数入口参数和编写代码并测试。

功能简介

您在函数计算的控制台提交触发器创建请求之后,函数计算会根据触发器的配置信息,自动在事件总线EventBridge侧创建事件流资源。

创建完成后,您可以在函数计算控制台查看触发器信息,同时也可以在事件总线EventBridge控制台查看自动创建的资源信息。当源消息队列 RocketMQ 版实例中有消息入队时,将会触发函数计算执行。执行时会根据您的攒批配置,将一个或多个消息事件以批的形式推送到函数中进行处理,适合端到端的流式数据处理场景。

注意事项

  • 作为触发源的消息队列 RocketMQ 版的实例必须和函数计算的函数在相同的地域。

  • 创建的事件流数量超过上限后,将无法再创建RocketMQ触发器。

在单个阿里云账号单个地域维度下,关于创建触发器涉及的资源数量的限制,请参见使用限制

前提条件

步骤一:创建触发器

  1. 登录函数计算控制台,在左侧导航栏,单击函数

  2. 在顶部菜单栏,选择地域,然后在函数页面,单击目标函数。

  3. 在函数配置页面,选择配置页签,在左侧导航栏,单击触发器,然后单击创建触发器

  4. 在创建触发器面板,填写相关信息,然后单击确定

    基础配置项说明如下所示。

    配置项

    操作

    本文示例

    触发器类型

    选择消息队列 RocketMQ 版

    消息队列 RocketMQ 版

    名称

    填写自定义的触发器名称。

    rocketmq-trigger

    版本或别名

    默认值为LATEST,如果您需要创建其他版本或别名的触发器,首先需要在函数详情页的右上角切换到该版本或别名。关于版本和别名的简介,请参见管理版本管理别名

    LATEST

    RocketMQ 实例

    选择已创建的消息队列 RocketMQ 版的实例。

    MQ_INST_164901546557****_BX7****

    Topic

    选择已创建的消息队列 RocketMQ 版实例的Topic。

    topic1

    Tag

    填写消息过滤标签。

    只有收到包含此处设置的过滤标签字符串的消息时,才会触发函数执行。

    tag

    Group ID

    选择已创建的消息队列 RocketMQ 版实例的Group ID。

    GID_group1

    消费位点

    选择消息的消费位点,即消息队列 RocketMQ 版从事件总线开始拉取消息的位置。取值说明如下。

    • 最新位点:从最新位点开始消费。

    • 最早位点:从最早位点开始消费。

    • 指定时间戳:从指定时间戳开始消费。

    最新位点

    调用方式

    选择函数调用方式。

    取值说明如下。

    • 同步调用:适用于顺序调用场景。单个(批)事件触发函数调用,等待函数执行完成返回结果后,再由下一个(批)事件继续触发函数调用。同步调用请求正文有效负载最大为32 MB。更多信息,请参见同步调用

    • 异步调用:可以快速消费事件。单个(批)事件触发函数调用,函数计算会立刻返回响应,再由下一个(批)事件继续触发函数调用。该过程中函数会异步执行。异步调用请求正文有效负载最大为128 KB。更多信息,请参见功能概览

    同步调用

    触发器启用状态

    创建触发器后是否立即启用。默认勾选启用触发器,即创建触发器后立即启用触发器。

    不涉及

    关于推送配置、重试和死信等高级配置项说明,请参见触发器高级功能

    创建完成后,在触发器名称列表中显示已创建的触发器。如需对创建的触发器进行修改或删除,具体操作,请参见触发器管理

步骤二:配置函数入口参数

消息队列 RocketMQ 版事件源会以event的形式作为输入参数传递给函数,您可以手动将event传给函数模拟触发事件,测试函数代码是否正确。

  1. 在函数配置页面的代码页签,单击测试函数右侧的image.png图标,从下拉列表中,选择配置测试参数

  2. 配置测试参数面板,选择创建新测试事件编辑已有测试事件,填写事件名称和事件内容,然后单击确定。

    event格式如下所示。

    [
        {
        "id":"94ebc15f-f0db-4bbe-acce-56fb72fb****",
        "source":"RocketMQ-Function-rocketmq-trigger",
        "specversion":"1.0",
        "type":"mq:Topic:SendMessage",
        "datacontenttype":"application/json; charset=utf-8",
        "subject":"acs:mq:cn-hangzhou:164901546557****:MQ_INST_164901546557****_BXhFHryi%TopicName",
        "time":"2021-04-08T06:01:20.766Z",
        "aliyunaccountid":"164901546557****",
        "aliyunpublishtime":"2021-10-15T02:05:16.791Z",
        "aliyunoriginalaccountid":"164901546557****",
        "aliyuneventbusname":"RocketMQ-Function-rocketmq-trigger",
        "aliyunregionid":"cn-chengdu",
        "aliyunpublishaddr":"42.120.XX.XX",
        "data":{
            "topic":"TopicName",
            "systemProperties":{
                "MIN_OFFSET":"0",
                "TRACE_ON":"true",
                "MAX_OFFSET":"8",
                "MSG_REGION":"cn-hangzhou",
                "KEYS":"systemProperties.KEYS",
                "CONSUME_START_TIME":1628577790396,
                "TAGS":"systemProperties.TAGS",
                "INSTANCE_ID":"MQ_INST_164901546557****_BXhFHryi"
            },
            "userProperties":{
    
            },
            "body":"TEST"
        }
        },
        {
        "id":"94ebc15f-f0db-4bbe-acce-56fb72fb****",
        "source":"RocketMQ-Function-rocketmq-trigger",
        "specversion":"1.0",
        "type":"mq:Topic:SendMessage",
        "datacontenttype":"application/json; charset=utf-8",
        "subject":"acs:mq:cn-hangzhou:164901546557****:MQ_INST_164901546557****_BXhFHryi%TopicName",
        "time":"2021-04-08T06:01:20.766Z",
        "aliyunaccountid":"164901546557****",
        "aliyunpublishtime":"2021-10-15T02:05:16.791Z",
        "aliyunoriginalaccountid":"164901546557****",
        "aliyuneventbusname":"RocketMQ-Function-rocketmq-trigger",
        "aliyunregionid":"cn-chengdu",
        "aliyunpublishaddr":"42.120.XX.XX",
        "data":{
            "topic":"TopicName",
            "systemProperties":{
                "MIN_OFFSET":"0",
                "TRACE_ON":"true",
                "MAX_OFFSET":"8",
                "MSG_REGION":"cn-hangzhou",
                "KEYS":"systemProperties.KEYS",
                "CONSUME_START_TIME":1628577790396,
                "TAGS":"systemProperties.TAGS",
                "INSTANCE_ID":"MQ_INST_164901546557****_BXhFHryi"
            },
            "userProperties":{
    
            },
            "body":"TEST"
        }
        }
    ]

    data字段包含的参数解释如下表所示。关于CloudEvents规范中定义的参数解释,请参见事件概述

    参数类型示例值描述
    topicStringTopicNameTopic名称。
    systemPropertiesMap系统属性。
    MIN_OFFSETInt0最低位点。
    TRACE_ONBooleantrue是否有消息轨迹。取值说明如下:
    • true:有消息轨迹。
    • false:无消息轨迹。
    MAX_OFFSETInt8最高位点。
    MSG_REGIONStringcn-hangzhou发送消息的地域。
    KEYSStringsystemProperties.KEYS过滤属性。
    CONSUME_START_TIMELong1628577790396开始消费时间。单位:毫秒。
    UNIQ_KEYStringAC14C305069E1B28CDFA3181CDA2****消息唯一键。
    TAGSStringsystemProperties.TAGS过滤属性。
    INSTANCE_IDStringMQ_INST_123456789098****_BXhFHryi实例ID。
    userPropertiesMap用户属性。
    bodyStringTEST消息内容。

步骤三:编写函数代码并测试

完成触发器创建后,您可以开始编写并测试函数代码,以验证代码的正确性。在实际操作过程中,当消息队列 RocketMQ 版事件通过事件总线EventBridge投递到函数计算时,触发器会自动触发函数的执行。

  1. 在函数配置页面的代码页签,在代码编辑器中编写代码,然后单击部署代码

    本文以Node.js函数代码为例。

    'use strict';
    /*
    To enable the initializer feature
    please implement the initializer function as below:
    exports.initializer = (context, callback) => {
      console.log('initializing');
      callback(null, '');
    };
    */
    exports.handler = (event, context, callback) => {
      console.log("event: %s", event);
      //解析event参数,对event进行处理。
      callback(null, 'return result');
    }
  2. 单击测试函数

更多信息

如需对创建的触发器进行修改或删除,具体操作,请参见触发器管理

  • 本页导读 (1)