mop-flutter-sdk/README.md

530 lines
22 KiB
Dart
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<p align="center">
<a href="https://www.finclip.com?from=github">
<img width="auto" src="https://www.finclip.com/mop/document/images/logo.png">
</a>
</p>
<p align="center">
<strong>FinClip Flutter SDK</strong></br>
<p>
<p align="center">
Flutter
<p>
<p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.finclip.com/</a> 👈
</p>
<div align="center">
<a href="#"><img src="https://img.shields.io/badge/%E4%B8%93%E5%B1%9E%E5%BC%80%E5%8F%91%E8%80%85-20000%2B-brightgreen"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E4%B8%8A%E6%9E%B6%E5%B0%8F%E7%A8%8B%E5%BA%8F-6000%2B-blue"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E9%9B%86%E6%88%90%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%BA%94%E7%94%A8-75%2B-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%AE%9E%E9%99%85%E8%A6%86%E7%9B%96%E7%94%A8%E6%88%B7-2500%20%E4%B8%87%2B-orange"></a>
<a href="https://www.zhihu.com/org/finchat"><img src="https://img.shields.io/badge/FinClip--lightgrey?logo=zhihu&style=social"></a>
<a href="https://www.finclip.com/blog/"><img src="https://img.shields.io/badge/FinClip%20Blog--lightgrey?logo=ghost&style=social"></a>
</div>
<p align="center">
<div align="center">
[](https://www.finclip.com/) | [示例小程序](https://www.finclip.com/#/market) | [开发文档](https://www.finclip.com/mop/document/) | [部署指南](https://www.finclip.com/mop/document/introduce/quickStart/cloud-server-deployment-guide.html) | [SDK 集成指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html) | [API 列表](https://www.finclip.com/mop/document/develop/api/overview.html) | [组件列表](https://www.finclip.com/mop/document/develop/component/overview.html) | [隐私承诺](https://www.finclip.com/mop/document/operate/safety.html)
</div>
-----
## 🤔 FinClip ?
**** APP
**** APP SDK
FinClip
## Flutter 使
FinClip SDK APP Flutter SDK 使
## Flutter
`pubspec.yaml`
```yaml
mop: latest.version
```
## 🖥
```flutter
import 'package:flutter/material.dart';
import 'dart:async';
import 'dart:io';
import 'package:mop/mop.dart';
void main() => runApp(MyApp());
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
@override
void initState() {
super.initState();
init();
}
// Platform messages are asynchronous, so we initialize in an async method.
Future<void> init() async {
if (Platform.isiOS) {
//com.finogeeks.mopExample
final res = await Mop.instance.initialize(
'22LyZEib0gLTQdU3MUauARlLry7JL/2fRpscC9kpGZQA', '1c11d7252c53e0b6',
apiServer: 'https://api.finclip.com', apiPrefix: '/api/v1/mop');
print(res);
} else if (Platform.isAndroid) {
//com.finogeeks.mopexample
final res = await Mop.instance.initialize(
'22LyZEib0gLTQdU3MUauARjmmp6QmYgjGb3uHueys1oA', '98c49f97a031b555',
apiServer: 'https://api.finclip.com', apiPrefix: '/api/v1/mop');
print(res);
}
if (!mounted) return;
}
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
appBar: AppBar(
title: const Text('凡泰极客小程序 Flutter 插件'),
),
body: Center(
child: Container(
padding: EdgeInsets.only(
top: 20,
),
child: Column(
children: <Widget>[
Container(
decoration: BoxDecoration(
borderRadius: BorderRadius.all(Radius.circular(5)),
gradient: LinearGradient(
colors: const [Color(0xFF12767e), Color(0xFF0dabb8)],
stops: const [0.0, 1.0],
begin: Alignment.topCenter,
end: Alignment.bottomCenter,
),
),
child: FlatButton(
onPressed: () {
Mop.instance.openApplet('5e3c147a188211000141e9b1');
},
child: Text(
'打开示例小程序',
style: TextStyle(color: Colors.white),
),
),
),
SizedBox(height: 30),
Container(
decoration: BoxDecoration(
borderRadius: BorderRadius.all(Radius.circular(5)),
gradient: LinearGradient(
colors: const [Color(0xFF12767e), Color(0xFF0dabb8)],
stops: const [0.0, 1.0],
begin: Alignment.topCenter,
end: Alignment.bottomCenter,
),
),
child: FlatButton(
onPressed: () {
Mop.instance.openApplet('5e4d123647edd60001055df1',sequence: 1);
},
child: Text(
'打开官方小程序',
style: TextStyle(color: Colors.white),
),
),
),
],
),
),
),
),
);
}
}
```
## 📋
### 1.
使 SDK API SDK SDK
```
///
/// initialize mop miniprogram engine.
/// 初始化小程序
/// [appkey] is required. it can be getted from api.finclip.com
/// [secret] is required. it can be getted from api.finclip.com
/// [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
///
///
Future<Map> initialize(String appkey, String secret,
{String apiServer, String apiPrefix})
```
使
```
final res = await Mop.instance.initialize(
'22LyZEib0gLTQdU3MUauARlLry7JL/2fRpscC9kpGZQA', '1c11d7252c53e0b6',
apiServer: 'https://api.finclip.com', apiPrefix: '/api/v1/mop');
```
### 2.
```
///
/// 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
///
///
Future<Map> openApplet(final String appId,
{final String path, final String query, final int sequence})
```
### 3. 使
`appId`, `name`, `icon`, `description`, `version`, `thumbnail`
```
///
/// get current using applet
/// 获取当前正在使用的小程序信息
/// {appId,name,icon,description,version,thumbnail}
///
///
Future<Map<String, dynamic>> currentApplet()
```
### 4.
```
///
/// close all running applets
/// 关闭当前打开的所有小程序
///
Future closeAllApplets()
```
### 5.
```
///
/// clear applets cache
/// 清除缓存的小程序
///
Future clearApplets()
```
### 6.
使
```
///
/// register handler to provide custom info or behaviour
/// 注册小程序事件处理
///
void registerAppletHandler(AppletHandler handler)
```
```
abstract class AppletHandler {
///
/// 转发小程序
///
///
///
void forwardApplet(Map<String, dynamic> appletInfo);
///
///获取用户信息
/// "userId"
/// "nickName"
/// "avatarUrl"
/// "jwt"
/// "accessToken"
///
Future<Map<String, dynamic>> getUserInfo();
/// 获取自定义菜单
Future<List<CustomMenu>> getCustomMenus(String appId);
///自定义菜单点击处理
Future onCustomMenuClick(String appId, int menuId);
}
```
### 7. API
SDK API API API
```
///
/// register extension api
/// 注册拓展api
///
void registerExtensionApi(String name, ExtensionApiHandler handler)
```
iOS `FinChatConf.js`
```
module.exports = {
extApi:[
{ //普通交互API
name: 'onCustomEvent', //扩展api名 该api必须Native方实现了
params: { //扩展api 的参数格式,可以只列必须的属性
url: ''
}
}
]
}
```
##
.
CHANGELOG.md
LICENSE
README.md
android
   build.gradle
   build.gradle.tpl
   gradle
      wrapper
      gradle-wrapper.properties
   gradle.properties
   proguard-android.txt
   proguard-rules.pro
   settings.gradle
   src // Android源文件目录
   main
   AndroidManifest.xml
   java
   com
   finogeeks
   mop
   MopEventStream.java
   MopPlugin.java
   MopPluginDelegate.java
   api
      AbsApi.java
      ApisManager.java
      BaseApi.java
      EmptyApi.java
      mop
      AppletHandlerModule.java
      AppletManageModule.java
      AppletModule.java
      BaseModule.java
      ExtensionApiModule.java
      InitSDKModule.java
      SmSignModule.java
      VersionModule.java
      WXQrCodeModule.java
      util
      InitUtils.java
   constants
      Constants.java
   interfaces
      Event.java
      FlutterInterface.java
      IApi.java
      ICallback.java
      ILifecycle.java
   service
      MopPluginService.java
   utils
   AppletUtils.java
   GsonUtil.java
example // 示例工程目录
   README.md
   analysis_options.yaml
   android
      app
         build.gradle
         src
         debug
            AndroidManifest.xml
         main
            AndroidManifest.xml
            java
               com
               finogeeks
               mop_example
               CustomLoadingPage.java
               MainActivity.java
               MainApplication.java
            res
            drawable
               launch_background.xml
            drawable-v21
               launch_background.xml
            layout
               layout_custom_loading_page.xml
               layout_custom_loading_page_failure.xml
            mipmap-hdpi
               ic_launcher.png
            mipmap-mdpi
               ic_launcher.png
            mipmap-xhdpi
               ic_launcher.png
            mipmap-xxhdpi
               ic_launcher.png
            mipmap-xxxhdpi
               ic_launcher.png
            values
               styles.xml
            values-night
            styles.xml
         profile
         AndroidManifest.xml
      build.gradle
      gradle
         wrapper
         gradle-wrapper.properties
      gradle.properties
      settings.gradle
   ios // iOS示例工程
      Podfile
      Runner
         AppDelegate.swift // 示例工程原生端初始化,以及插件注册
         Assets.xcassets
         FlutterMethodChannelHandler.h // Flutter调用原生channel
         FlutterMethodChannelHandler.m
         LoadingView.h // 小程序启动页自定义UI
         LoadingView.m
         Runner-Bridging-Header.h
      Runner.xcodeproj
   lib
      main.dart // 示例工程入口
   pubspec.yaml
ios // iOS源文件目录
   Assets
   Classes
      Api // 自定义API用户可以此目录下新增自定义API
         MOPAppletDelegate.h // 小程序回调处理
         MOPAppletDelegate.m
         MOP_addWebExtentionApi.h // 添加扩展API
         MOP_addWebExtentionApi.m
         MOP_callJS.h // 调用JS方法
         MOP_callJS.m
         MOP_changeUserId.h // 设置userId
         MOP_changeUserId.m
         MOP_clearApplets.h // 清除本地所有小程序缓存
         MOP_clearApplets.m
         MOP_closeAllApplets.h // 关闭所有小程序
         MOP_closeAllApplets.m
         MOP_closeApplet.h // 关闭指定小程序
         MOP_closeApplet.m
         MOP_currentApplet.h // 获取当前小程序的信息
         MOP_currentApplet.m
         MOP_finishRunningApplet.h // 关闭小程序,并移除缓存
         MOP_finishRunningApplet.m
         MOP_initSDK.h // 小程序SDK初始化
         MOP_initSDK.m
         MOP_initialize.h // 小程序SDK初始化(跟 MOP_initSDK 参数不同)
         MOP_initialize.m
         MOP_openApplet.h // 打开小程序
         MOP_openApplet.m
         MOP_parseAppletInfoFromWXQrCode.h // 解析微信小程序二维码,得到凡泰小程序信息
         MOP_parseAppletInfoFromWXQrCode.m
         MOP_qrcodeOpenApplet.h // 二维码链接打开小程序
         MOP_qrcodeOpenApplet.m
         MOP_registerAppletHandler.h // 注册小程序回调
         MOP_registerAppletHandler.m
         MOP_registerExtensionApi.h // 注册扩展Api
         MOP_registerExtensionApi.m
         MOP_removeAllUsedApplets.h // 移除所有本地小程序缓存
         MOP_removeAllUsedApplets.m
         MOP_removeApplet.h // 删除小程序本地缓存,如果小程序正在打开则先关闭小程序
         MOP_removeApplet.m
         MOP_removeUsedApplet.h // 从本地缓存中删除小程序
         MOP_removeUsedApplet.m
         MOP_scanOpenApplet.h // 扫描二维码打开小程序
         MOP_scanOpenApplet.m
         MOP_sdkVersion.h // 获取SDK版本信息
         MOP_sdkVersion.m
         MOP_sendCustomEvent.h // 给SDK发动自定义事件
         MOP_sendCustomEvent.m
         MOP_showBotomSheetModel.h // 显示底部分享View
         MOP_showBotomSheetModel.m
         MOP_smsign.h // 获取签名
         MOP_smsign.m
         MOP_startApplet.h // 启动小程序
         MOP_startApplet.m
         MOP_webViewBounces.h // 设置 webView Bounces
         MOP_webViewBounces.m
      Model
         MopCustomMenuModel.h // 自定义菜单Model
         MopCustomMenuModel.m
      MopPlugin.h // 插件初始化以及事件处理
      MopPlugin.m
      Utils // 存放一些工具类
      MOPApiConverter.h // 将Request通过反射转换成自定义API
      MOPApiConverter.m
      MOPApiRequest.h // 将参数封装成一个Request
      MOPApiRequest.m
      MOPBaseApi.h // 自定义API基类
      MOPBaseApi.m
      MOPTools.h // 工具类
      MOPTools.m
      MopShareView.h // 分享界面UI
      MopShareView.m
      UIView+MOPFATToast.h // Toast提示分类
      UIView+MOPFATToast.m
   mop.podspec
   mop.podspec.tpl //mop.podspec 模板文件
lib
   api.dart // 小程序回调接口(抽象类)
   mop.dart // mop SDK 初始化接口
publish.sh // 发布脚本
pubspec.tpl.yaml // pubspec.yaml模板文件
pubspec.yaml
tag.sh // 打tag脚本
trigger.sh // 脚本
## 🔗
FinClip
- [FinClip ](https://www.finclip.com/#/home)
- [](https://www.finclip.com/#/market)
- [](https://www.finclip.com/mop/document/)
- [SDK ](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
- [](https://www.finclip.com/mop/document/develop/guide/structure.html)
- [iOS ](https://www.finclip.com/mop/document/runtime-sdk/ios/ios-integrate.html)
- [Android ](https://www.finclip.com/mop/document/runtime-sdk/android/android-integrate.html)
- [Flutter ](https://www.finclip.com/mop/document/runtime-sdk/flutter/flutter-integrate.html)
##
****<br>
<img width="150px" src="https://www.finclip.com/mop/document/images/ic_qr.svg">
<br>
<img width="150px" src="https://www-cdn.finclip.com/images/qrcode/qrcode_shequn_text.png">