mop-flutter-sdk/lib/mop.dart

537 lines
17 KiB
Dart
Raw Normal View History

2020-02-27 17:21:45 +08:00
import 'dart:async';
import 'dart:ffi';
2020-02-27 17:21:45 +08:00
import 'package:flutter/foundation.dart';
2020-02-27 17:21:45 +08:00
import 'package:flutter/services.dart';
2020-04-26 14:57:08 +08:00
import 'package:mop/api.dart';
2020-02-27 17:21:45 +08:00
typedef MopEventCallback = void Function(dynamic event);
typedef MopEventErrorCallback = void Function(dynamic event);
2020-04-26 14:57:08 +08:00
typedef ExtensionApiHandler = Future Function(dynamic params);
class FinStoreConfig {
2021-12-22 14:38:24 +08:00
///创建应用时生成的SDK Key
String sdkKey;
///创建应用时生成的SDK secret
String sdkSecret;
///服务器地址,客户部署的后台地址
String apiServer;
///apm统计服务器的地址,如果不填则默认与apiServer一致
String apmServer;
///网络接口加密类型默认为MD5 国密SM
String cryptType;
///SDK指纹 证联环境(https://open.fdep.cn/) 时必填,其他环境的不用填
String? fingerprint;
///是否需要接口加密验证初始化多服务器时使用默认为不开启当设置为YES时开启接口返回加密数据并处理
bool encryptServerData;
2021-12-22 14:35:51 +08:00
FinStoreConfig(this.sdkKey, this.sdkSecret, this.apiServer, this.apmServer,
{this.cryptType = "MD5",
this.fingerprint,
this.encryptServerData = false});
Map<String, dynamic> toMap() {
return {
"sdkkey": sdkKey,
"sdkSecret": sdkSecret,
"apiServer": apiServer,
"apmServer": apmServer,
"cryptType": cryptType,
"fingerprint": fingerprint,
"encryptServerData": encryptServerData
};
}
}
class UIConfig {
Map<String, dynamic>? navigationTitleTextAttributes; //导航栏的标题样式目前支持了font
///当导航栏为默认导航栏时,是否始终显示返回按钮
bool isAlwaysShowBackInDefaultNavigationBar = false;
///是否清除导航栏导航按钮的背景
bool isClearNavigationBarNavButtonBackground = false;
///是否隐藏"更多"菜单中的"反馈与投诉"菜单入口
bool isHideFeedbackAndComplaints = false;
///是否隐藏"更多"菜单中的"返回首页"菜单入口
bool isHideBackHome = false;
2021-12-22 14:35:51 +08:00
///是否隐藏"更多"菜单中的"转发"按钮
bool isHideForwardMenu = false;
/// 加载小程序过程中小程序Service层还未加载成功基础库还没有向SDK传递小程序配置信息是否隐藏导航栏的关闭按钮
bool hideTransitionCloseButton = false;
/// 禁用侧滑关闭小程序手势
bool disableSlideCloseAppletGesture = false;
/// 胶囊按钮配置
CapsuleConfig? capsuleConfig;
FloatWindowConfig? floatWindowConfig;
2021-12-22 17:32:18 +08:00
//iOS中独有的设置属性
//小程序里加载H5页面时进度条的颜色 格式 0xFFFFAA00
int? progressBarColor;
//是否自适应暗黑模式。如果设置为true则更多页面、关于等原生页面会随着手机切换暗黑也自动调整为暗黑模式
bool autoAdaptDarkMode = true;
//注入小程序统称appletText字符串默认为“小程序”。
String? appletText;
2021-12-22 14:35:51 +08:00
Map<String, dynamic> toMap() {
return {
"navigationTitleTextAttributes": navigationTitleTextAttributes,
"isAlwaysShowBackInDefaultNavigationBar":
isAlwaysShowBackInDefaultNavigationBar,
"isClearNavigationBarNavButtonBackground":
isClearNavigationBarNavButtonBackground,
"isHideFeedbackAndComplaints": isHideFeedbackAndComplaints,
"isHideBackHome": isHideBackHome,
"isHideForwardMenu": isHideForwardMenu,
"hideTransitionCloseButton": hideTransitionCloseButton,
"disableSlideCloseAppletGesture": disableSlideCloseAppletGesture,
"capsuleConfig": capsuleConfig?.toMap(),
"floatWindowConfig": floatWindowConfig?.toMap(),
2021-12-22 17:32:18 +08:00
"progressBarColor": progressBarColor,
"autoAdaptDarkMode": autoAdaptDarkMode,
"appletText": appletText
2021-12-22 14:35:51 +08:00
};
}
}
2021-12-22 14:35:51 +08:00
/// 胶囊按钮配置
class CapsuleConfig {
/// 上角胶囊视图的宽度默认值为88
double capsuleWidth = 88;
///上角胶囊视图的高度默认值为32
double capsuleHeight = 32;
///右上角胶囊视图的右边距
double capsuleRightMargin = 7;
///右上角胶囊视图的圆角半径默认值为5
double capsuleCornerRadius = 5;
///右上角胶囊视图的边框宽度默认值为0.8
double capsuleBorderWidth = 1;
///胶囊背景颜色浅色
int capsuleBgLightColor = 0x33000000;
///胶囊背景颜色深色
int capsuleBgDarkColor = 0x80ffffff;
/// 右上角胶囊视图的边框浅色颜色
int capsuleBorderLightColor = 0x80ffffff;
///右上角胶囊视图的边框深色颜色
int capsuleBorderDarkColor = 0x26000000;
///胶囊分割线浅色颜色
int capsuleDividerLightColor = 0x80ffffff;
///胶囊分割线深色颜色
int capsuleDividerDarkColor = 0x26000000;
///胶囊里的浅色更多按钮的图片对象,如果不传,会使用默认图标
int? moreLightImage;
///胶囊里的深色更多按钮的图片对象,如果不传,会使用默认图标
int? moreDarkImage;
2021-12-22 14:35:51 +08:00
///胶囊里的更多按钮的宽度,高度与宽度相等
double moreBtnWidth = 32;
///胶囊里的更多按钮的左边距
double moreBtnLeftMargin = 6;
///胶囊里的浅色更多按钮的图片对象,如果不传,会使用默认图标
int? closeLightImage;
///胶囊里的深色更多按钮的图片对象,如果不传,会使用默认图标
int? closeDarkImage;
///胶囊里的关闭按钮的宽度,高度与宽度相等
double closeBtnWidth = 32;
///胶囊里的关闭按钮的左边距
double closeBtnLeftMargin = 6;
Map<String, dynamic> toMap() {
return {
"capsuleWidth": capsuleWidth,
"capsuleHeight": capsuleHeight,
"capsuleRightMargin": capsuleRightMargin,
"capsuleCornerRadius": capsuleCornerRadius,
"capsuleBorderWidth": capsuleBorderWidth,
"capsuleBgLightColor": capsuleBgLightColor,
"capsuleBgDarkColor": capsuleBgDarkColor,
"capsuleBorderLightColor": capsuleBorderLightColor,
"capsuleBorderDarkColor": capsuleBorderDarkColor,
"capsuleDividerLightColor": capsuleDividerLightColor,
"capsuleDividerDarkColor": capsuleDividerDarkColor,
"moreLightImage": moreLightImage,
"moreDarkImage": moreDarkImage,
"moreBtnWidth": moreBtnWidth,
"moreBtnLeftMargin": moreBtnLeftMargin,
"closeLightImage": closeLightImage,
"closeDarkImage": closeDarkImage,
"closeBtnWidth": closeBtnWidth,
"closeBtnLeftMargin": closeBtnLeftMargin,
};
}
}
class FloatWindowConfig {
bool floatMode = false;
int x;
int y;
int width;
int height;
FloatWindowConfig(this.floatMode, this.x, this.y, this.width, this.height);
Map<String, dynamic> toMap() {
return {
"floatMode": floatMode,
"x": x,
"y": y,
"width": width,
"height": height
};
}
}
enum Anim {
SlideFromLeftToRightAnim,
SlideFromRightToLeftAnim,
SlideFromTopToBottomAnim,
SlideFromBottomToTopAnim,
FadeInAnim,
NoneAnim
}
2020-02-27 17:21:45 +08:00
class Mop {
static final Mop _instance = new Mop._internal();
2021-08-18 22:10:15 +08:00
late MethodChannel _channel;
late EventChannel _mopEventChannel;
late int eventId = 0;
2021-10-10 23:50:23 +08:00
final List<Map<String, dynamic>> _mopEventQueye = <Map<String, dynamic>>[];
2020-04-01 14:44:01 +08:00
2021-10-10 23:50:23 +08:00
final Map<String, ExtensionApiHandler> _extensionApis = {};
2020-04-26 14:57:08 +08:00
Map<String, ExtensionApiHandler> _webExtensionApis = {};
2020-02-27 17:21:45 +08:00
factory Mop() {
return _instance;
}
2020-04-01 14:44:01 +08:00
2020-02-27 17:21:45 +08:00
Mop._internal() {
2021-10-10 23:50:23 +08:00
debugPrint('mop: _internal');
2020-02-27 17:21:45 +08:00
// init
2021-10-10 23:50:23 +08:00
_channel = const MethodChannel('mop');
2020-04-26 14:57:08 +08:00
_channel.setMethodCallHandler(_handlePlatformMethodCall);
2021-12-22 14:35:51 +08:00
_mopEventChannel =
const EventChannel('plugins.mop.finogeeks.com/mop_event');
2020-02-27 17:21:45 +08:00
_mopEventChannel.receiveBroadcastStream().listen((dynamic value) {
2021-10-10 23:50:23 +08:00
debugPrint('matrix: receiveBroadcastStream $value');
2020-02-27 17:21:45 +08:00
for (Map m in _mopEventQueye) {
if (m['event'] == value['event']) {
m['MopEventCallback'](value['body']);
}
}
}, onError: (dynamic value) {
// failure(value);
});
}
2020-04-01 14:44:01 +08:00
2020-02-27 17:21:45 +08:00
static Mop get instance => _instance;
Future<String> get platformVersion async {
final String version = await _channel.invokeMethod('getPlatformVersion');
return version;
}
2020-04-26 14:57:08 +08:00
Future<dynamic> _handlePlatformMethodCall(MethodCall call) async {
2021-10-10 23:50:23 +08:00
debugPrint("_handlePlatformMethodCall: method:${call.method}");
2020-04-26 14:57:08 +08:00
if (call.method.startsWith("extensionApi:")) {
final name = call.method.substring("extensionApi:".length);
final handler = _extensionApis[name];
if (handler != null) {
return await handler(call.arguments);
}
} else if (call.method.startsWith("webExtentionApi:")) {
final name = call.method.substring("webExtentionApi:".length);
final handler = _webExtensionApis[name];
if (handler != null) {
return await handler(call.arguments);
}
}
2020-04-26 14:57:08 +08:00
}
2020-02-27 17:21:45 +08:00
///
///
/// initialize mop miniprogram engine.
/// 初始化小程序
2021-12-22 14:35:51 +08:00
/// [sdkkey] is required. it can be getted from api.finclip.com
2021-01-12 15:24:37 +08:00
/// [secret] is required. it can be getted from api.finclip.com
2020-02-27 17:21:45 +08:00
/// [apiServer] is optional. the mop server address. default is https://mp.finogeek.com
/// [apiPrefix] is optional. the mop server prefix. default is /api/v1/mop
2020-05-19 16:42:10 +08:00
/// [cryptType] is optional. cryptType, should be MD5/SM
2020-07-27 09:13:55 +08:00
/// [disablePermission] is optional.
2021-12-22 14:35:51 +08:00
/// [encryptServerData] 是否对服务器数据进行加密,需要服务器支持
/// [userId] 用户id
/// [finStoreConfigs] 多服务配置
/// [uiConfig] UI配置
/// [debug] 设置debug模式影响调试和日志
/// [customWebViewUserAgent] 设置自定义webview ua
/// [appletIntervalUpdateLimit] 设置小程序批量更新周期
/// [maxRunningApplet] 设置最大同时运行小程序个数
2020-02-27 17:21:45 +08:00
///
2021-12-22 14:35:51 +08:00
Future<Map> initialize(
String sdkkey,
String secret, {
String? apiServer,
String? apiPrefix,
String? cryptType,
bool encryptServerData = false,
bool disablePermission = false,
String? userId,
bool debug = false,
bool bindAppletWithMainProcess = false,
List<FinStoreConfig>? finStoreConfigs,
UIConfig? uiConfig,
String? customWebViewUserAgent,
int appletIntervalUpdateLimit = 0,
int maxRunningApplet = 5,
}) async {
2020-02-27 17:21:45 +08:00
final Map ret = await _channel.invokeMethod('initialize', {
2021-12-22 14:35:51 +08:00
'appkey': sdkkey,
2020-02-27 17:21:45 +08:00
'secret': secret,
'apiServer': apiServer,
2020-05-19 16:42:10 +08:00
'apiPrefix': apiPrefix,
2020-07-27 09:13:55 +08:00
'cryptType': cryptType,
2021-12-22 14:35:51 +08:00
"encryptServerData": encryptServerData,
2021-06-02 11:33:07 +08:00
'disablePermission': disablePermission,
'userId': userId,
2021-08-25 22:03:04 +08:00
"debug": debug,
2021-12-22 14:35:51 +08:00
"bindAppletWithMainProcess": bindAppletWithMainProcess,
"finStoreConfigs": finStoreConfigs?.map((e) => e.toMap()),
"uiConfig": uiConfig?.toMap(),
"customWebViewUserAgent": customWebViewUserAgent,
"appletIntervalUpdateLimit": appletIntervalUpdateLimit,
"maxRunningApplet": maxRunningApplet
2020-02-27 17:21:45 +08:00
});
return ret;
}
/// open the miniprogram [appId] from the mop server.
/// 打开小程序
/// [appId] is required.
/// [path] is miniprogram open path. example /pages/index/index
/// [query] is miniprogram query parameters. example key1=value1&key2=value2
2020-12-04 09:09:53 +08:00
/// [sequence] is miniprogram sequence. example 0,1.2.3,4,5...
/// [apiServer] is optional. the mop server address. default is https://mp.finogeek.com
/// [apiPrefix] is optional. the mop server prefix. default is /api/v1/mop
/// [fingerprint] is optional. the mop sdk fingerprint. is nullable
/// [cryptType] is optional. cryptType, should be MD5/SM
Future<Map> openApplet(
final String appId, {
2021-12-22 14:35:51 +08:00
final String? path,
final String? query,
final int? sequence,
final String? apiServer,
final String? scene,
}) async {
2020-04-26 14:57:08 +08:00
Map<String, Object> params = {'appId': appId};
Map param = {};
if (path != null) param["path"] = path;
if (query != null) param["query"] = query;
if (param.length > 0) params["params"] = param;
2020-04-01 14:44:01 +08:00
if (sequence != null) params["sequence"] = sequence;
if (apiServer != null) params["apiServer"] = apiServer;
2021-07-27 10:39:26 +08:00
if (scene != null) param["scene"] = scene;
2020-02-27 17:21:45 +08:00
final Map ret = await _channel.invokeMethod('openApplet', params);
return ret;
}
2020-04-26 14:57:08 +08:00
///
/// get current using applet
/// 获取当前正在使用的小程序信息
/// {appId,name,icon,description,version,thumbnail}
///
///
Future<Map<String, dynamic>> currentApplet() async {
final ret = await _channel.invokeMapMethod("currentApplet");
2021-08-18 22:10:15 +08:00
return Map<String, dynamic>.from(ret!);
2020-04-26 14:57:08 +08:00
}
///
/// close all running applets
/// 关闭当前打开的所有小程序
///
Future closeAllApplets() async {
return await _channel.invokeMethod("closeAllApplets");
}
///
/// clear applets cache
/// 清除缓存的小程序
///
Future clearApplets() async {
return await _channel.invokeMethod("clearApplets");
}
/// 清除指定的小程序本体缓存
Future removeUsedApplet(String appId) async {
Map<String, Object> params = {'appId': appId};
return await _channel.invokeMethod("removeUsedApplet", params);
}
2020-07-22 15:30:54 +08:00
///
/// 获取运行时版本号
///
Future<String> sdkVersion() async {
return await _channel
.invokeMapMethod("sdkVersion")
2021-08-18 22:10:15 +08:00
.then((value) => value?["data"]);
2020-07-22 15:30:54 +08:00
}
2021-06-07 18:53:00 +08:00
///
/// (扫码后)解密-鉴权-打开小程序
///
Future scanOpenApplet(String info) async {
Map<String, Object> params = {'info': info};
return await _channel.invokeMapMethod("scanOpenApplet", params);
2021-06-07 18:53:00 +08:00
}
///
/// 根据微信QrCode信息解析小程序信息
///
Future<Map<String, dynamic>> parseAppletInfoFromWXQrCode(
String qrCode, String apiServer) async {
final ret = await _channel.invokeMapMethod("parseAppletInfoFromWXQrCode",
{"qrCode": qrCode, "apiServer": apiServer});
2021-08-18 22:10:15 +08:00
return Map<String, dynamic>.from(ret!);
}
2021-06-07 18:53:00 +08:00
2020-04-26 14:57:08 +08:00
///
/// register handler to provide custom info or behaviour
/// 注册小程序事件处理
///
void registerAppletHandler(AppletHandler handler) {
_extensionApis["forwardApplet"] = (params) async {
2020-11-27 17:15:32 +08:00
handler.forwardApplet(Map<String, dynamic>.from(params));
2020-04-26 14:57:08 +08:00
};
_extensionApis["getUserInfo"] = (params) {
return handler.getUserInfo();
};
_extensionApis["getCustomMenus"] = (params) async {
2021-12-22 14:35:51 +08:00
final res = await handler.getCustomMenus(params["appId"]);
2021-03-02 14:04:51 +08:00
List<Map<String, dynamic>> list = [];
2021-08-18 22:19:26 +08:00
res.forEach((element) {
2021-03-02 14:04:51 +08:00
Map<String, dynamic> map = Map();
map["menuId"] = element.menuId;
map["image"] = element.image;
map["title"] = element.title;
map["type"] = element.type;
list.add(map);
});
2021-10-10 23:50:23 +08:00
debugPrint("registerAppletHandler getCustomMenus list $list");
2021-03-02 14:04:51 +08:00
return list;
2020-04-26 14:57:08 +08:00
};
_extensionApis["onCustomMenuClick"] = (params) async {
2021-12-22 14:35:51 +08:00
return handler.onCustomMenuClick(
params["appId"], params["path"], params["menuId"], params["appInfo"]);
2020-04-26 14:57:08 +08:00
};
_extensionApis["appletDidOpen"] = (params) async {
return handler.appletDidOpen(params["appId"]);
};
2020-04-26 14:57:08 +08:00
_channel.invokeMethod("registerAppletHandler");
}
///
/// register extension api
/// 注册拓展api
///
void registerExtensionApi(String name, ExtensionApiHandler handler) {
_extensionApis[name] = handler;
_channel.invokeMethod("registerExtensionApi", {"name": name});
}
2021-04-21 21:19:48 +08:00
/// 获取国密加密
Future<String> getSMSign(String plainText) async {
var result =
await _channel.invokeMapMethod("smsign", {'plainText': plainText});
2021-08-18 22:10:15 +08:00
var data = result?['data']['data'];
2021-10-10 23:50:23 +08:00
debugPrint(data);
2021-04-21 21:19:48 +08:00
return data;
}
/// WKWebView的弹性设置
void webViewBounces(bool bounces) async {
await _channel.invokeMapMethod("webViewBounces", {'bounces': bounces});
return;
}
//关闭小程序
Future<void> closeApplet(String appletId, bool animated) async {
await _channel.invokeMethod(
"closeApplet", {"appletId": appletId, "animated": animated});
return;
}
//结束小程序 关闭小程序
Future<void> finishRunningApplet(String appletId, bool animated) async {
await _channel.invokeMethod(
"finishRunningApplet", {"appletId": appletId, "animated": animated});
return;
}
2021-12-22 14:35:51 +08:00
//设置小程序切换动画 安卓
Future setActivityTransitionAnim(Anim anim) async {
await _channel
.invokeMethod("setActivityTransitionAnim", {"anim": anim.name});
return;
}
//发送事件给小程序
2021-12-22 14:35:51 +08:00
Future<void> sendCustomEvent(
String appId, Map<String, dynamic> eventData) async {
await _channel.invokeMethod(
"sendCustomEvent", {"appId": appId, "eventData": eventData});
return;
}
//原生调用js
2021-12-22 14:35:51 +08:00
Future<void> callJS(String appId, String eventName, String nativeViewId,
Map<String, dynamic> eventData) async {
await _channel.invokeMethod("callJS", {
2021-12-22 14:35:51 +08:00
"appId": appId,
"eventName": eventName,
"nativeViewId": nativeViewId,
"eventData": eventData
});
return;
}
//注册h5的拓展接口
void addWebExtentionApi(String name, ExtensionApiHandler handler) {
_webExtensionApis[name] = handler;
_channel.invokeMethod("addWebExtentionApi", {"name": name});
}
2020-02-27 17:21:45 +08:00
}