插件中使用 npm 包
在插件目录下直接运行npm i 包名方式安装即可使用。
示例
如原本插件目录如下：
Extensions/
cn.apifox.ApifoxExtensions.SocketISO8538Unpacker/
SocketISO8538Unpacker.js
在cn.apifox.ApifoxExtensions.SocketISO8538Unpacker目录下运行如下命令即可安装 iso_8583 包：
npm i iso_8583
运行后的目录如下：
Extensions/
cn.apifox.ApifoxExtensions.SocketISO8538Unpacker/
SocketISO8538Unpacker.js
node_modules/
iso_8583/
date-fns/
jxon/
xmldom/
安装完成后，插件代码里直接require('iso_8583')即可使用：
const ISO8583 = require('iso_8583')
/**
* Apifox Socket 解包插件示例
* 解析 JSON 格式包数据
*
* @class SocketISO8538Unpacker
*/
class SocketISO8538Unpacker {
// 插件 ID，取 ID 要避免和其他插件冲突
static id = 'cn.apifox.ApifoxExtensions.SocketISO8538Unpacker'
// 插件展示名称
static title = 'ISO 8538 解包'
// 插件使用帮助链接，可选
static help = 'https://apifox.com/help/app/extensions/socket-unpacker/'
// 插件类型 Socket 解包插件：'socketUnpacker'
static type = 'socketUnpacker'
// 插件版本号
static version = '1.0.0'
// 前端用户输入项设置
static inputs = []
// 解包后的 message 数据类型，可选 'json' 和 'string'
static dataType = 'json'
// 等待处理的数据
_bufferedData = null
/**
* 当接收到数据时触发该事件。
* 触发时机同 node.js 里 net.Socket 的 'data' 事件，参考：http://nodejs.cn/api/net.html#net_event_data
*
* @param {*} chunk Buffer 或 String。建议使用 Buffer.from(chunk) 封装后使用
* @param {*} options 对象。options.inputs 可读取用户输入项
* @param {*} context 对象。context.executeJar 可调用 jar 文件
* @returns
*/
onData(chunk, options, context) {
/**
* 解包后返回的数据，注意：一次可以返回多个包，所以使用数组
*/
let packets = []
// 解包后的信息：人性化展示的内容，方便理解内容，一般为 JSON 格式
let message
// 解包异常错误
let error
try {
message = new ISO8583().getIsoJSON(chunk)
} catch (e) {
error = new Error(`ISO 8583 解包出错: ${e.message}`)
}
/**
* 注意 packet 格式，packet 为数组。
* 格式： [原始报文, 解包后的信息(用来前端展示，String 或 JSON，可选), 解包异常错误(可选)]
*/
const packet = [Buffer.from(chunk), message, error]
packets.push(packet)
this._bufferedData = null
/**
* 注意返回的格式：[packets, 等待处理的数据]，packets 为数组，可包含多个包
* packets 为 packet 数组
* this._bufferedData 为剩余还未解包的 Buffer 数据
*/
return [packets, this._bufferedData]
}
}
module.exports = SocketISO8538Unpacker