可能是你用过的最优雅的支付宝和微信支付 SDK 了 —— Laravel Pay


概述

开发了多次支付宝与微信支付后,很自然产生一种反感,惰性又来了,想在网上找相关的轮子,可是一直没有找到一款自己觉得逞心如意的,要么使用起来太难理解,要么文件结构太杂乱,只有自己撸起袖子干了。

欢迎 Star,欢迎 PR!

潜水了这么久,自己学习了很多,是时候回馈社区了!

特点

  • 命名不那么乱七八糟
  • 隐藏开发者不需要关注的细节
  • 根据支付宝、微信最新 API 开发而成
  • 高度抽象的类,免去各种拼 JSON 与 XML 的痛苦
  • 符合 PSR 标准,你可以各种方便的与你的框架集成
  • 文件结构清晰易理解,可以随心所欲添加本项目中没有的支付网关
  • 方法使用更优雅,不必再去研究那些奇怪的的方法名或者类名是做啥用的

以上部分引用了 @overtrue 的部分说明,在此感谢!:satisfied:

运行环境

  • PHP 5.6+
  • Composer

支持的支付网关

由于各支付网关参差不齐,所以我们抽象了两个方法 driver()gateway()。两个方法的作用如下:

  • driver:确定支付平台,如支付宝、微信;
  • gateway():确定支付网关。通过此方法,确定支付平台下的支付网关。例如,支付宝下有 「电脑网站支付」,「手机网站支付」,「APP 支付」三种支付网关,分别通过传入 webwapapp 确定。
详细思路可以查看源代码。

支付宝

  • 电脑支付
  • 手机网站支付
  • APP 支付

SDK 中对应的 drivergateway 如下表所示:

driver gateway 描述
alipay web 电脑支付
alipay wap 手机网站支付
alipay app APP 支付

微信

  • 公众号支付
  • 小程序支付
  • H5 支付
  • 扫码支付
  • 刷卡支付

SDK 中对应的 drivergateway 如下表所示:

driver gateway 描述
wechat mp 公众号支付
wechat miniapp 小程序支付
wechat wap H5 支付
wechat scan 扫码支付
wechat pos 刷卡支付

支持的方法

所有网关均支持以下方法

  • pay(array $config_biz)

说明:支付接口

参数:数组类型,订单业务配置项,包含 订单号,订单金额等

返回:mixed 详情请看「支付网关配置说明与返回值」一节。

  • refund(array|string $config_biz, $refund_amount = null)

说明:退款接口

参数:$config_biz 为字符串类型仅对支付宝支付有效,此时代表订单号,第二个参数为退款金额。

返回:mixed 退款成功,返回 服务器返回的数组;否则返回 false

  • close(array|string $config_biz)

说明:关闭订单接口

参数:$config_biz 为字符串类型时代表订单号,如果为数组,则为关闭订单业务配置项,配置项内容请参考各个支付网关官方文档。

返回:mixed 关闭订单成功,返回 服务器返回的数组;否则返回 false;

  • find(string $out_trade_no)

说明:查找订单接口

参数:$out_trade_no 为订单号。

返回:mixed 查找订单成功,返回 服务器返回的数组;否则返回 false

  • verify($data, $sign = null)

说明:验证服务器返回消息是否合法

参数:$data 为服务器接收到的原始内容,$sign 为签名信息,当其为空时,系统将自动转化 $data 为数组,然后取 $data['sign']

返回:mixed 验证成功,返回 服务器返回的数组;否则返回 false

快速上手

通过 Composer 安装:

使用说明:

一个完整的例子

代码片段

准备配置参数

在代码中使用

错误

使用非跳转接口(如 refund 接口、close 接口)时,如果在调用相关支付网关 API 时有错误产生,会抛出 GatewayException 错误,可以通过 $e->getMessage() 查看,同时,也可通过 $e->raw 查看调用 API 后返回的原始数据,该值为数组格式。

支付网关配置说明与返回值

由于支付网关不同,每家参数参差不齐,为了方便,我们抽象定义了两个参数:$config$config_biz,分别为全局参数,业务参数。但是,所有配置参数均为官方标准参数,无任何差别。

「业务参数」为订单相关的参数,「全局参数」为除订单相关参数以外的全局性参数。

具体参数列表请查看每个支付网关的使用说明。

支付宝电脑网站支付

最小配置参数

所有配置参数

所有参数均为官方标准参数,无任何差别(点击这里查看官方文档):

返回值

  • pay()

类型:string

说明:该接口返回跳转到支付宝支付的 HTML 代码。

支付宝手机网站支付

最小配置参数

所有配置参数

该网关大部分参数和 「电脑支付」 相同,具体请参考官方文档

返回值

  • pay()

类型:string

说明:该接口返回跳转到支付宝支付的 HTML 代码。

支付宝 APP 支付

最小配置参数

所有配置参数

该网关大部分参数和 「电脑支付」 相同,具体请参考官方文档

返回值

  • pay()

类型:string

说明:该接口返回用于客户端调用的 orderString 字符串,可直接供 APP 客户端调用,客户端调用方法不在此文档讨论范围内,Android 用户请看这里,iOS 用户请看这里

支付宝刷卡支付

最小配置参数

所有配置参数

该网关大部分参数和 「电脑支付」 相同,具体请参考官方文档

返回值

  • pay()

类型:array|bool

说明:该接口成功时返回服务器响应的数组;验签失败返回 false。

支付宝扫码支付

最小配置参数

所有配置参数

该网关大部分参数和 「电脑支付」 相同,具体请参考官方文档

返回值

  • pay()

类型:string

说明:该接口返回二维码链接,可以通过其他库转换为二维码供用户扫描。

支付宝帐户转账

最小配置参数

所有配置参数

官方文档:https://doc.open.alipay.com/docs/api.htm?apiId=1321&docType=4

返回值

  • pay()

类型:array|bool

说明:该接口成功时返回服务器响应的数组;验签失败返回 false。

微信公众号支付

最小配置参数

所有配置参数

所有参数均为官方标准参数,无任何差别(点击查看官方文档):

返回值

  • pay()

类型:array

说明:返回用于 微信内H5调起支付 的所需参数数组。后续调用不在本文档讨论范围内,具体请参考这里

后续调用举例:

微信小程序支付

最小配置参数

所有配置参数

由于「小程序支付」和「公众号支付」都使用的是 JSAPI,所以,除了 APPID 一个使用的是公众号的 APPID 一个使用的是 小程序的 APPID 以外,该网关所有参数和 「公众号支付」 相同,具体请参考这里

返回值

  • pay()

类型:array

说明:返回用于 小程序调起支付API 的所需参数数组。后续调用不在本文档讨论范围内,具体请参考这里

微信 H5 支付

最小配置参数

所有配置参数

所有配置项和前面支付网关相差不大,请点击这里查看。

返回值

  • pay()

类型:string

说明:返回微信支付中间页网址,可直接 302 跳转。

微信扫码支付

这里使用「模式二」进行扫码支付,具体请参考这里:https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=6_5

最小配置参数

所有配置参数

所有配置项和前面支付网关相差不大,请点击这里查看:https://pay.weixin.qq.com/wiki/doc/api/native.php?chapter=9_1

返回值

  • pay()

类型:string

说明:返回微信支付二维码 URL 地址,可直接将此 url 生成二维码,展示给用户进行扫码支付。

微信刷卡支付

最小配置参数

所有配置参数

该网关所有参数和其它支付网关基本相同,具体请参考这里:https://pay.weixin.qq.com/wiki/doc/api/micropay.php?chapter=9_10&index=1

返回值

  • pay()

类型:array

说明:返回用于服务器返回的数组。返回参数请参考这里

微信 APP 支付

最小配置参数

所有配置参数

该网关所有参数和其它支付网关相同相同,具体请参考这里

返回值

  • pay()

类型:array

说明:返回用于小程序调起支付API 的所需参数数组。后续调用不在本文档讨论范围内,具体请参考这里

在 Laravel 中使用

安装配置

还是通过 Composer 安装:

注册 service provider:

添加 alias:

将配置文件发布到 config 目录:

随后,请在 config 目录下完善配置信息。

使用方法

代码贡献

由于测试及使用环境的限制,本项目中只开发了「支付宝」和「微信支付」的相关支付网关。

如果您有其它支付网关的需求,或者发现本项目中需要改进的代码,欢迎 Fork 并提交 PR!

感谢大家支持!

LICENSE

MIT


<< 上一篇: laravel-amount —— Model 中自动转换金额的 Trait

>> 下一篇: 一个 GitHub 上的 Laravel 以太坊扩展包 —— Laravel-ethereum