sqbridge v1.1.3

sqbridge

首汽约车 - 前端与移动端通讯BridgeAuthor By 首汽约车前端团队（SQYC-FE）

一、产出原因

1. 端內升级，与前端交互方法进行统一。
2. 统一数据格式，数据使用JSON进行传输。
3. 确保callback回调由前端生成，保证多次调用的灵活性。
4. 统一各渠道与端內交互模式。

二、适用版本

• 2019/8 后的新版本 IOS 及 Android

三、使用方法

• npm安装sqbridge

# 安装npm包
npm install sqbridge --save

• 引入npm包

// 引入 sqBridge
import { sqBridge } from sqbridge

• JS文件内使用方法

sqBridge('端內方法名', jsonData, (val) => { });

// Example
sqBridge('onOpenPay', {
  orderNo: 'o12345678',
  amount: 100,
  balance: 1
}, (val) => {
  console.log(`返回值为：` JSON.stringify(val));
});

• Bridge內通用方法（暂只适用于内部开发，第三方请暂时忽略）
  • 支付：pay
  • 定位：navigation

import { sqBridgeFunc } from sqbridge
sqBridgeFunc.pay(jsonData, (val) => { });

备注 & 字段解释：

• 端內方法名（String）：需要和移动端（IOS、Android）进行约定
• jsonData （JSON Object）：移动端开发者提供所需请求参数以及类型，前端进行数据输入，保证传输格式为JSON
• callback （Function）：定义前端回调函数，端內执行完毕后，会将数据返回到此处定义的回调函数中。返回数据同样为JSON格式。

四、NPM文件目录（For SQYC-FE）

• index.js 方法暴露
• main.js bridge基础方法
• util.js 封装方法暴露
• con-error.js 错误信息管理
• package.json npm包说明