技术文章

当前位置:首页>帮助手册>技术文章

o2server 消息和消息处理器使用,如何将消息推送到webSocket 推送消息 日历消息 自建表 welink 钉钉 企业微信 公众号 邮件 mq restful jdbc hadoop或自建消

时间:2022-04-22   
内容导读

本篇说明O2OA 平台的消息分发机制,处理器按队列顺序消费事件产生的消息,既有系统内置的推送,也有面向外部的转发。配置文件默认不随程序提供,需从样例目录复制后再改,改动须重启方可生效。各处理器可组合叠加,并借助脚本加载器改写内容、过滤器剔除消息。外置通道覆盖消息队列、邮件与数据库等去向,自定义消息落库后需调用接口取用并回写完成标志,超期数据由定时任务清理。

消息处理器

o2server 内置了消息处理机制,用于发送各类通知消息,也可以用于数据同步和事件发送。

比如流程中的待办消息提醒:

1.png

是使用 ws(websocket)消息处理器来实现的,钉钉上的待办消息处理则是使用 dingding(钉钉消息推送)实现的。

内置消息处理器类型

内置消息处理由系统自动完成,内置消息处理大多用于实现消息推送,一般情况下无需干预。

外置消息处理器类型

外置消息处理器类型可以将消息推送到系统外部,需要进行配置和干预才能完成特定功能。

消息类型

处理器本质上是一个队列,先入先出地处理进入队列的消息,这些消息来源于 o2server 事件,下面以流程为例逐一说明目前支持的消息类型。

流程消息

配置消息处理器处理消息

o2server 可以通过配置,设置使用特定的消息处理器来处理特定的消息。

config/messages.json

默认情况下,config 目录下没有 messages.json 文件,系统使用默认配置来处理消息。系统提供的配置样例在 configSample 目录下,需要手工将默认配置文件拷贝到 config 目录下进行配置。修改 messages.json 需要重启服务器才能生效。

configSample/messages.json

consumersV2 配置声明

后续版本将删除 consumersV2 配置项。

配置项说明

我们以待办提醒为例进行配置项说明。默认情况下,系统会通过 websocket 进行待办消息提醒;如果接入了移动端(比如微信、钉钉等),也会自动进行待办消息提醒。只是默认情况下使用的配置项如下:

{
    "task_create": {
        "description": "创建待办",
        "consumersV2": {
            "calendar": "",
            "activemq": "",
            "pmsinner": "",
            "restful": "",
            "mail": "",
            "jdbc": "",
            "mpweixin": "",
            "dingding": "",
            "qiyeweixin": "",
            "kafka": "",
            "zhengwudingding": "",
            "welink": "",
            "api": "",
            "hadoop": "",
            "ws": "",
            "table": ""
        },
        "consumers": [
            {
                "type": "ws",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "pmsinner",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "calendar",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "type": "dingding",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "welink",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "zhengwudingding",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "qiyeweixin",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "type": "mpweixin",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "bootstrapServers": "",
                "topic": "o2oa",
                "securityProtocol": "SASL_PLAINTEXT",
                "saslMechanism": "PLAIN",
                "username": "",
                "password": "",
                "type": "kafka",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "username": "",
                "password": "",
                "url": "",
                "queueName": "",
                "type": "activemq",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "url": "",
                "method": "get",
                "type": "restful",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "host": "",
                "port": 465.0,
                "sslEnable": true,
                "auth": true,
                "from": "admin@o2oa.net",
                "password": "password",
                "type": "mail",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "application": "",
                "path": "",
                "method": "get",
                "type": "api",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "driverClass": "com.mysql.cj.jdbc.Driver",
                "url": "jdbc:mysql://",
                "username": "root",
                "password": "password",
                "catalog": "",
                "schema": "",
                "table": "NEWTABLE",
                "type": "jdbc",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "table": "",
                "type": "table",
                "enable": false,
                "loader": "",
                "filter": ""
            },
            {
                "fsDefaultFS": "hdfs://",
                "username": "",
                "path": "",
                "type": "hadoop",
                "enable": false,
                "loader": "",
                "filter": ""
            }
        ]
    },
}

默认情况下,ws,pmsinner,dingding,welink,zhengwudingding,qiyeweixin,mpweixin 是启用的(enable= true),下面对配置项进行说明:

{
    "task_create": {
        "description": "创建待办",
        "consumers": [
            {
                "type": "ws",
                "enable": true,
                "loader": "",
                "filter": ""
            },
            {
                "url": "",
                "method": "get",
                "type": "restful",
                "enable": false,
                "loader": "",
                "filter": ""
            }
        ]
    },
}

messages.json 是一个 json 格式的对象类型配置文件

task_create:消息类型

description:说明

consumers:使用的消息处理器,是一个数组类型,可以使用多个消息处理器,同一类型的消息处理器也可以重复使用。

内置消息处理器说明

            {
                "type": "ws",
                "enable": true,
                "loader": "",
                "filter": ""
            }

ws 是一个内置的消息处理器,配置项比较简单。

type:类型,说明这个消息处理器的类型,ws 代表 websocket 消息。

enable:是否启用

loader:加载器,加载器是一个 javascript 脚本文件的文件名,通过加载器可以通过程序对消息体进行修改,可以实现对消息内容的修改和定制。

filter:过滤器,过滤器是一个 javascript 脚本文件的文件名,通过过滤器可以通过程序来判断是否要过滤掉消息。

外置消息处理器说明

          {
            "url": "",
            "method": "get",
            "type": "restful",
            "enable": false,
            "loader": "",
            "filter": ""
          }

restful 是一个外置消息处理器,使用该类型的消息处理器将在收到消息后调用外部的 restful 请求发送消息。

type:类型,说明这个消息处理器的类型,restful 代表调用外部的 restful 服务。

enable:是否启用

loader:加载器,加载器是一个 javascript 脚本文件的文件名,通过加载器可以通过程序对消息体进行修改,可以实现对消息内容的修改和定制。

filter:过滤器,过滤器是一个 javascript 脚本文件的文件名,通过过滤器可以通过程序来判断是否要过滤掉消息。

url:http 服务地址.

method:调用 http 请求类型,get,post,put,delete.

加载器

加载器配置的是一个 javascript 脚本文件地址,为空则不调用脚本。比如:

"loader":"message_ws_loader_taskCreate.js"

系统读到这个配置,将从 o2server 的程序目录下的 config/message_ws_loader_taskCreate.js 文件装载脚本。

下面给出一个样例,说明如何修改消息内容:秘密文件将通知消息的标题进行模糊处理。

/*
*message 对象是消息体,有脚本执行上下文环境环境自动注入,其中有四个字段
message.title: 标题
message.person: 发送对象
message.type: 消息类型,task_create
message.body: 消息体,类型是task_create的消息中消息体是json格式存储的task(待办)数据
return 返回的message对象
*/
if ((message.body.secret == '秘密') && (essage.title.length > 4)) {
  message.title = message.title.substring(0, 4) + '......';
}
return message;

过滤器

过滤器配置的是一个 javascript 脚本文件地址,为空则不调用脚本。比如:

"loader":"message_ws_filter_taskCreate.js"

系统读到这个配置,将从 o2server 的程序目录下的 config/message_ws_filter_taskCreate.js 文件装载脚本。

下面给出一个样例,说明如何过滤消息内容:如果通知人是张三,则不发送消息。

/*
*message 对象是消息体,有脚本执行上下文环境环境自动注入,其中有四个字段
message.title: 标题
message.person: 发送对象
message.type: 消息类型,task_create
message.body: 消息体,类型是task_create的消息中消息体是json格式存储的task(待办)数据
return true 标识此消息要处理,false表示忽略此消息
*/
return message.person != '张三@zhangsan@p';

外置消息处理器配置项说明

kafka

           {
                "bootstrapServers": "",
                "topic": "o2oa",
                "securityProtocol": "SASL_PLAINTEXT",
                "saslMechanism": "PLAIN",
                "username": "",
                "password": "",
                "type": "kafka",
                "enable": false,
                "loader": "",
                "filter": ""
            }

bootstrapServers:kafka 服务地址

topic:队列名称

securityProtocol:认证协议

saslMechanism:加密机制

username:用户名

password:密码

type:kafka

enable:是否启用

loader:装载器

filter:过滤器

activemq

           {
                "username": "",
                "password": "",
                "url": "",
                "queueName": "",
                "type": "activemq",
                "enable": false,
                "loader": "",
                "filter": ""
            }

url:服务地址

queueName:队列名称

username:用户名

password:密码

type:activemq

enable:是否启用

loader:装载器

filter:过滤器

restful

            {
                "url": "",
                "method": "get",
                "type": "restful",
                "enable": false,
                "loader": "",
                "filter": ""
            }

url:http 请求地址

method:http 请求方法

type:restful

enable:是否启用

loader:装载器

filter:过滤器

mail

            {
                "host": "",
                "port": 465.0,
                "sslEnable": true,
                "auth": true,
                "from": "admin@o2oa.net",
                "password": "password",
                "type": "mail",
                "enable": false,
                "loader": "",
                "filter": ""
            }

host:smtp 服务器地址

port:smtp 服务器端口

sslEnable:使用 ssl 加密

auth:启用认证

from:邮件发送者

password:邮件发送者 smtp 密码

type:mail

enable:是否启用

loader:装载器

filter:过滤器

api

            {
                "application": "",
                "path": "",
                "method": "get",
                "type": "api",
                "enable": false,
                "loader": "",
                "filter": ""
            }

application:应用标识

path:接口路径

method:restful 方法 get,post,delete,put

type:api

enable:是否启用

loader:装载器

filter:过滤器

jdbc

            {
                "driverClass": "com.mysql.cj.jdbc.Driver",
                "url": "jdbc:mysql://",
                "username": "root",
                "password": "password",
                "catalog": "",
                "schema": "",
                "table": "NEWTABLE",
                "type": "jdbc",
                "enable": false,
                "loader": "",
                "filter": ""
            }

driverClass:jdbc 驱动类

url:jdbc 服务器地址

username:数据库用户名

password:数据库密码

catalog:数据库编目

schema:数据库模式

table:数据库表

type:jdbc

enable:是否启用

loader:装载器

filter:过滤器

table

            {
                "table": "",
                "type": "table",
                "enable": false,
                "loader": "",
                "filter": ""
            }

table:自建表标识

type:table

enable:是否启用

loader:装载器

filter:过滤器

hadoop

            {
                "fsDefaultFS": "hdfs://",
                "username": "",
                "path": "",
                "type": "hadoop",
                "enable": false,
                "loader": "",
                "filter": ""
            }

fsDefaultFS:hadoop dfs 服务地址

username:链接 hadoop 系统用户名,需要事先完成 ssh 免密设置。

path:hadoop dfs 存储目录路径

type:hadoop

enable:是否启用

loader:装载器

filter:过滤器

自定义消息类型和自定义消息处理器

{
  "custom_message_type":[
    {
      "type": "custom_",
      "enable": false,
      "loader": "",
      "filter": ""
    }
  ]  
}

可以通过上面的配置样例进行自定义消息和自定义消息处理器的配置。自定义消息系统不会进行任何处理,接收到自定义消息后,系统会将消息存放在数据库中等待处理。

可以通过下面的接口进行获取:

http://127.0.0.1:20020/x_message_assemble_communicate/jaxrs/consume/list/{consume}/count/{count}

消费完成后,需要调用接口回写消费完成标志。

http://127.0.0.1:20020/x_message_assemble_communicate/jaxrs/consume/{id}/type/{type}

其他说明

失败补偿机制

消息处理器在处理消息过程中发生错误时,本次处理即告失败;消息处理器在失败的情况下会记录错误信息,并且在后续自动尝试重试。

消息清理

消息数据存储在 MSG_MESSAGE 数据库表中,由定时器定期清除过期的数据,以避免表中存储过多数据;默认情况下 message 数据的保存期限是7天。

相关问题讨论

自定义组件部署到 webServer 目录下,过一会儿文件夹 jiu'xiao'sh...

系统读到这个配置将会从 o2server 的程序目录下的 config/message_ws_loader_taskCreate.js 文件装载脚本.

查看原帖讨论 · 30,419 次浏览

关于运行 o2server 报 NoClassDefFoundError: org/apache/logging/log4j/core/Layout 的问题

系统读到这个配置将会从 o2server 的程序目录下的 config/message_ws_loader_taskCreate.js 文件装载脚本.

查看原帖讨论 · 11,173 次浏览

windows 环境下启动失败 Exception: can not define o2server base directory.

系统读到这个配置将会从 o2server 的程序目录下的 config/message_ws_loader_taskCreate.js 文件装载脚本.

查看原帖讨论 · 12,273 次浏览

相关内容

O2OA 翱途 企业应用开发平台

兰德网络O2OA平台软件

开源、自主可控的协同办公底座

研发与运营

纵横翱途(杭州)科技有限公司

企业级协同应用 · 工作流引擎 · AI 智能体

www.o2oa.net | 400-888-0545

上一篇:O2server 调用外部webservice(jaxws)服务

下一篇:安装nfs服务启用目录共享作为o2server集群环境下文件存储服务