Fluwx:让在Flutter中使用微信SDK成为可能

fluwx_logo.png

前言

之前有了解的小伙伴可能已经看过Fluwx的一篇文章，不过那个时候Fluwx还是不太成熟。现在Fluwx的主体功能已经过成了。如果你正在或想开发一个Flutter项目但苦于无法使用微信分享、登录，那么Fluwx可能正是你所要寻找的。
尽管Fluwx旨在减化工作量，但在使用Fluwx之前，我还是强烈建议先阅读微信SDK官方文档，这有助于了解一些概念，有利于调试问题。
项目地址

目前功能

• 文本分享。
• 网站分享。
• 图片分享。
• 音乐分享。
• 视频分享。
• 小程序分享。
• 发送Auth认证。

技术参数

Android部分使用到了kotlin-1.2.60。以下是Android部分所涉及到的技术:

 api 'com.tencent.mm.opensdk:wechat-sdk-android-with-mta:5.1.4'
 implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:0.24.0'
 implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:0.24.0'
 implementation 'top.zibin:Luban:1.1.8'
 implementation 'com.squareup.okhttp3:okhttp:3.11.0'

其中Luban是用来图片压缩的。
iOS部分涉及到的技术：

 s.dependency 'WechatOpenSDK','~> 1.8.2'

Flutter版本信息

Flutter 0.7.5 • channel dev • https://github.com/flutter/flutter.git

Framework • revision eab5cd9853 (4 days ago) • 2018-08-30 14:47:04 -0700

Engine • revision dc7b5eb89d

Tools • Dart 2.1.0-dev.3.0.flutter-760a9690c2

引入

在pubspec.yaml文件中添加如下代码：

dependencies:
  fluwx: ^0.1.3

添加完成后不要忘记flutter packages get。

初始化

使用Fluwx前，需要进行初始化操作：

Fluwx.registerApp(RegisterModel(appId: "your app id", doOnAndroid: true, doOnIOS: true));

• appId：在微信平台申请的appId。
• doOnAndroid:是否在android平台上执行此操作。
• doOnIOS:是否在平台上执行此操作。</br>
  每一个字段都是非必须的，但是如果不传appId或doOnAndroid: false或者doOnIOS: false，请务必手动注册WXApi以保证Fluwx正常工作。
  注册完成后，请在使用Fluwx前在对应平台添加如下代码：
  Android上：

FluwxShareHandler.setWXApi(wxapi)

iOS上：

isWeChatRegistered = YES;

注意：尽管可以通过Fluwx完成微信注册，但一些操作依然需要在对应平台进行设置，如配置iOS的URLSchema，Android上的WXEntryActivity等，否则Fluwx无法正常工作。

如何发起分享

很遗憾，Fluwx并不是支持所有的分享类型。目前仅支持文本、图片、网址
音乐、视频以及小程序的分享。其他分享将在未来版本得到支持。

注意：目前分享中涉及到图片的地方仅支持png和jpg，支持网络图片及assets图片。

使用assets图片需要添加assets://。

也可以在assets图片添加?package=package_name以读取指定包的图片。

未来可能支持file://,目前以file://图片不会做任何处理。

如果不指定schema或者schema错误,将会被处理为网络图片，请谨慎。

由于微信的限制，一般的缩略图要小于32k(小程序的缩略图要小于120k)，所以在使用缩略的时候

很有必要使用一张合格的缩略图，否则Fluwx进行压缩，其结果可能并不是你所预期的。

分享去处

绝大部分分享可以分享到会话，朋友圈，收藏（小程序目前只能分享到会话）。默认分享到会话：

    ///[WeChatScene.SESSION]会话
    ///[WeChatScene.TIMELINE]朋友圈
    ///[WeChatScene.FAVORITE]收藏
    enum WeChatScene {
      SESSION,
      TIMELINE,
      FAVORITE
      }

分享文本

  fluwx.share(WeChatShareTextModel(
      text: "text from fluwx",
      transaction: "transaction}",//仅在android上有效，下同。
      scene: scene
    ));

分享图片

 fluwx.share(WeChatShareImageModel(
        image: _imagePath,
        thumbnail: _thumbnail,
        transaction: _imagePath,
        scene: scene,
        description: "image"));

注意：如果不指定 thumbnail，那么Fluwx将尝试从image中获取缩略图。

分享音乐

  var model = WeChatShareMusicModel(
      title: _title,
      description: _description,
      transaction: "music",
      musicUrl: _musicUrl,
      musicLowBandUrl: _musicLowBandUrl
    );

    fluwx.share(model);

音乐的分享有两种：musicUrl和musicLowBandUrl。这两种形式是不共存的，如果
都二者都进行了赋值，那么只会读取musicUrl。

分享视频

   var model = new WeChatShareVideoModel(
     videoUrl: _videoUrl,
     transaction: "video",
     videoLowBandUrl: _videoLowBandUrl,
     thumbnail: _thumnail,
     description: _description,
     title: _title
   );
   fluwx.share(model);

视频的分享有两种：videoUrl和videoLowBandUrl。这两种形式是不共存的，如果
都二者都进行了赋值，那么只会读取videoUrl。

分享小程序

 var model =new WeChatShareMiniProgramModel(
      webPageUrl: _webPageUrl,
      miniProgramType: WeChatShareMiniProgramModel.MINI_PROGRAM_TYPE_RELEASE,
      userName: _userName,
      title: _title,
      description: _description,
      thumbnail: _thumbnail
    );
    fluwx.share(model);

miniProgramType仅支持三种:

• MINI_PROGRAM_TYPE_RELEASE
• MINI_PROGRAM_TYPE_TEST
• MINI_PROGRAM_TYPE_PREVIEW

发送Auth认证

对于微信登录，Fluwx只实现了第一步，即获取code，若要获取access_token请在服务器端完成。

   fluwx.sendAuth(WeChatSendAuthModel(
      scope: "snsapi_userinfo",
      state:"wechat_sdk_demo_test",
    ));

发起支付

每个参数的意义请参考官方文档：

Fluwx fluwx = new Fluwx();
fluwx.pay(WeChatPayModel(
                  appId: 'wxd930ea5d5a258f4f', 
                  partnerId: '1900000109',
                  prepayId: '1101000000140415649af9fc314aa427',
                  packageValue: 'Sign=WXPay',
                  nonceStr: '1101000000140429eb40476f8896f4c9',
                  timeStamp: '1398746574',
                  sign: '7FFECB600D7157C5AA49810D2D8F28BC2811827B',
                  signType: '选填',
                  extData: '选填'
                ));

微信回调

当fluwx发起分享、支付或登录请求都会有返回值，但这并不是微信回调的值：

    {
      "platform":"Android",//或者iOS
       result:true //或者false，取决于WXApi.sendRequest()的结果
     }

由于微信的回调是异步的，我们需要从response中监听：

    _fluwx.response.listen((response){
      //do something
    });

从微信回调的值为WeChatResponse，其实type字段为枚举：

enum WeChatResponseType {
    SHARE,
    AUTH,
    PAYMENT }

result为微信回传的值，其类型为Map，具体返回值请参阅微信官方文档，但均额外包含一个
platform字段，其值为android或者iOS，以便开发者作差异化处理。
但微信的回调也要根据平台的不同进行差异化处理(如果你不需要回调，请忽略)。

Android

由于机制问题，Android端需要在WXEntryActivity或WXPayEntryActivity中添加如下代码：

   override fun onResp(resp: BaseResp) {
        FluwxResponseHandler.handleResponse(resp)
   }

你也可以直接继承FluwxWXEntryActivity。
WXEntryActivity和WXPayEntryActivity创建规则请参阅官方文档。具体可以参考example wxapi
，也不要忘记在AndroidManifest.mxl中注册：

     <activity
            android:name="your.package.name.registered.on.wechat.wxapi.WXEntryActivity"
            android:theme="@style/DisablePreviewTheme"
            android:exported="true"
            android:launchMode="singleTop"/>
     <activity
            android:name="your.package.name.registered.on.wechat.wxapi.WXPayEntryActivity"
            android:theme="@style/DisablePreviewTheme"
            android:exported="true"
            android:launchMode="singleTop"/>

iOS

在你的AppDelegate.m中重写下面方法：

- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url {
    return [WXApi handleOpenURL:url delegate:[FluwxResponseHandler responseHandler]];
}

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString*, id> *)options{
  return [WXApi handleOpenURL:url delegate:[FluwxResponseHandler responseHandler]];
}

结束

以上就是Fluwx的使用方法，希望对大伙有所帮助。
项目地址,多多star。
另外还有一个支付宝支付项目tobias正在开发当中。
希望大家可以关注JarvanMo和OpenFlutter。