mirror of
https://github.com/OpenFlutter/fluwx.git
synced 2025-08-06 14:50:30 +08:00
165 lines
6.4 KiB
Markdown
165 lines
6.4 KiB
Markdown
# Fluwx
|
||
|
||
[](https://pub.dartlang.org/packages/fluwx)
|
||
|
||
[](https://github.com/OpenFlutter/fluwx/stargazers)
|
||
[](https://github.com/OpenFlutter/fluwx/network)
|
||
[](https://github.com/OpenFlutter/fluwx/blob/master/LICENSE)
|
||
[](https://github.com/OpenFlutter/fluwx/issues)
|
||
<a target="_blank" href="https://qm.qq.com/q/TJ29rkzywM"><img border="0" src="https://pub.idqqimg.com/wpa/images/group.png" alt="OpenFlutter" title="OpenFlutter"></a>
|
||
|
||
---
|
||
|
||
|
||
|
||
## 什么是Fluwx
|
||
|
||
`Fluwx` 是一个[微信SDK](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html)插件，它允许开发者调用
|
||
[微信原生SDK](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html).
|
||
|
||
> 加入我们的QQ群: 1003811176
|
||
|
||
|
||
|
||
## 能力
|
||
|
||
- 分享图片，文本，音乐，视频等。支持分享到会话，朋友圈以及收藏.
|
||
- 微信支付.
|
||
- 在微信登录时，获取Auth Code.
|
||
- 拉起小程序.
|
||
- 订阅消息.
|
||
- 打开微信.
|
||
- 从微信标签打开应用
|
||
- APP拉起客服微信
|
||
|
||
## 准备
|
||
|
||
[迁移到V4指南](./doc/MIGRATE_TO_V4_CN.md)
|
||
|
||
> 破坏性更新 ：从4.5.0起，当分享图片到微信时，如果不支持FileProvider方式分享，Fluwx不再尝试申请WRITE_EXTERNAL_STORAGE权限，这意味着你需要自己处理权限问题。
|
||
|
||
`Fluwx` 可以做很多工作但不是所有. 在集成之前，最好读一下[官方文档](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Resource_Center_Homepage.html).
|
||
然后你才知道怎么生成签名，怎么使用universal link以及怎么添加URL schema等.
|
||
|
||
## 安装
|
||
|
||
在`pubspec.yaml` 文件中添加`fluwx`依赖:
|
||
|
||
`Fluwx`，带支付:
|
||
|
||
```yaml
|
||
dependencies:
|
||
fluwx: ^${latestVersion}
|
||
```
|
||
|
||
|
||
|
||
> [!NOTE]
|
||
> 不带支付的`Fluwx`:<br/>
|
||
> 一些开发者并不需要在iOS端使用支付能力，此时您可以通过在 pubspec.yaml 中设置 `no_pay: true` 来去除支付能力。<br/>
|
||
> 参考文件：[example/pubspec.yaml](./example/pubspec.yaml#L19)<br/>
|
||
|
||
> [!WARNING]
|
||
> 别忘记替换 ^${latestVersion} ！！！！
|
||
|
||
## 配置
|
||
|
||
`Fluwx` 从v4开始可以在`pubspec.yaml`的`fluwx`进行一些配置。具体可以参考[pubspec.yaml](./example/pubspec.yaml#L10)。
|
||
|
||
> V4开始，iOS中的url_scheme，universal_link, LSApplicationQueriesSchemes可以不必开发者手动配动。只需在`pubspec.yaml`
|
||
> 中填写即可。
|
||
|
||
- app_id. 推荐. 它将用于生成iOS的url_scheme。这并不会替你初始化微信SDK，所以你还是自己调用`fluwx.registerApi`。
|
||
- debug_logging. 可选. 把它设置成`true`可以开启日志。
|
||
- flutter_activity. 可选. 这个通常是用于Android的冷启动。如果不设置任何值，`Fluwx`将尝试启动launcher activity.
|
||
- universal_link. iOS 推荐. 它将用自动配置universal_link。
|
||
- scene_delegate. iOS 可选. 使用 `AppDelegate` 还是使用 `SceneDelegate`. 查阅[官方文档](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Access_Guide/iOS.html)了解更多.
|
||
|
||
- For iOS
|
||
如果你在iOS上遇到了 `cannot load such file -- plist`, 请按照以下步骤进行操作：
|
||
|
||
```shell
|
||
# step.1 安装必要依赖
|
||
sudo gem install plist
|
||
# step.2 进行iOS文件夹(example/ios/,ios/)
|
||
cd example/ios/
|
||
# step.3 执行脚本
|
||
pod install
|
||
```
|
||
|
||
- 在 OpenHarmony 上，要检查微信是否已安装，请在项目的 module.json5 中添加以下内容
|
||
|
||
```json5
|
||
{
|
||
"module": {
|
||
"querySchemes": [
|
||
"weixin"
|
||
],
|
||
}
|
||
}
|
||
```
|
||
|
||
## 注册 WxAPI
|
||
|
||
通过 `fluwx` 注册WxApi.
|
||
|
||
```dart
|
||
Fluwx fluwx = Fluwx();
|
||
fluwx.registerApi(appId: "wxd930ea5d5a228f5f",universalLink: "https://your.univerallink.com/link/");
|
||
```
|
||
|
||
参数 `universalLink` 只在iOS上有用. 查看[文档](https://developers.weixin.qq.com/doc/oplatform/Mobile_App/Access_Guide/iOS.html) 以便了解如何生成通用链接.
|
||
你也可以学习到怎么在iOS工程中添加URL schema，怎么添加`LSApplicationQueriesSchemes`。这很重要。
|
||
|
||
对于Android, 可以查看[本文](https://developers.weixin.qq.com/doc/oplatform/Downloads/Android_Resource.html)以便了解怎么获取app签名.
|
||
然后你需要知道release和debug时，app签名有什么区别。如果签名不对，你会得一个错误 `errCode = -1`.
|
||
|
||
建议越早注册越好。
|
||
|
||
## 能力文档
|
||
|
||
- [基础知识](./doc/BASIC_KNOWLEDGE_CN.md)
|
||
- [分享](./doc/SHARE_CN.md)
|
||
- [支付](./doc/PAYMENT_CN.md)
|
||
- [登录](./doc/AUTH_CN.md)
|
||
- [从微信标签打开应用](./doc/LAUNCH_APP_FROM_H5_CN.md)
|
||
- [APP拉起客服微信](/doc/Customer_Service_CN.md)
|
||
对于更多功能，可以查看源码。
|
||
|
||
## QA
|
||
|
||
[这些问题可能对你有帮助](./doc/QA_CN.md)
|
||
|
||
## 捐助
|
||
|
||
开源不易，请作者喝杯咖啡。
|
||
|
||
<img src="https://gitee.com/OpenFlutter/resoures-repository/raw/master/common/wx.jpeg" height="300"> <img src="https://gitee.com/OpenFlutter/resoures-repository/raw/master/common/ali.jpeg" height="300">
|
||
|
||
## 关注公众号
|
||
|
||
|
||
|
||
## 关注趋势
|
||
|
||
|
||
|
||
## LICENSE
|
||
|
||
Copyright 2018 OpenFlutter Project
|
||
|
||
Licensed to the Apache Software Foundation (ASF) under one or more contributor
|
||
license agreements. See the NOTICE file distributed with this work for
|
||
additional information regarding copyright ownership. The ASF licenses this
|
||
file to you under the Apache License, Version 2.0 (the "License"); you may not
|
||
use this file except in compliance with the License. You may obtain a copy of
|
||
the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing, software
|
||
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
||
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
||
License for the specific language governing permissions and limitations under
|
||
the License.
|