Magicodes.Pay已支持Volo Abp
Magicodes.Pay已支持Volo Abp
简介
Magicodes.Pay希望打造一个统一支付库,相关库均使用.NET标准库编写,支持.NET Framework以及.NET Core。目前已提供Abp及Abp VNext(Volo Abp)模块的封装,支持开箱即用。
GitHub:https://github.com/xin-lai/Magicodes.Pay
Nuget
名称 | 说明 | Nuget |
---|---|---|
Magicodes.Pay.Alipay | 支付宝支付库 |
|
Magicodes.Pay.Notify | 支付通用回调库 |
|
Magicodes.Pay.Wxpay | 微信支付库 |
|
Magicodes.Pay.Alipay.Global | 国际支付宝支付库 |
|
Magicodes.Pay.Allinpay | 通联支付库 |
|
Magicodes.Pay.Abp | ABP 支付通用封装库 |
|
Magicodes.Pay.Abp.Allinpay | ABP 通联支付模块 |
|
Magicodes.Pay.Abp.Wxpay | ABP 微信支付模块 |
|
Magicodes.Pay.Abp.Alipay.Global | ABP 国际支付宝模块 |
|
Magicodes.Pay.Abp.Alipay | ABP 支付宝模块 |
|
Magicodes.Pay.Volo.Abp | ABP VNext基础模块 |
|
Magicodes.Pay.Volo.Abp.Allinpay | ABP VNext 通联支付模块 |
|
Magicodes.Pay.Volo.Abp.Wxpay | ABP VNext 微信支付模块 |
|
Magicodes.Pay.Volo.Abp.Alipay | ABP VNext 支付宝支付模块 |
|
主要功能
目前已提供Abp(含Volo Abp)模块的封装,支持开箱即用。支持以下支付方式和功能:
- 支付宝支付
- APP支付
- Wap支付
- 支付宝国际支付
- 支持分账
- 微信支付
- 小程序支付
- APP支付
- 订单查询
- 企业付款(提现)
- 退款申请
- 普通红包
- 通联支付
- 小程序支付
- 微信JSAPI支付
- 统一支付回调处理
- 支持日志函数注入(不依赖支付库)
- 支持支付配置函数注入,以便于支持自定义配置获取逻辑,以应用于不同的场景(比如从配置文件、用户设置获取配置,或者多租户支持)
- 针对ABP提供模块封装,添加模块依赖即可立即使用。主要包括:
- 统一支付服务封装(见IPayAppService)
- 支付管理器封装(IPaymentManager),包含:
- 支付渠道注册(IPaymentRegister)
- 支付回调逻辑处理(IPaymentCallbackAction)
- 统一支付服务实现(IToPayService)
- 交易日志封装,自动记录客户端信息以及自动异常处理和记录
- 仅需编写一次回调逻辑,即可支持多个支付渠道
- 业务参数支持更大长度(500)
开始使用(Volo Abp)
当前教程仅适用于Volo Abp。主要步骤如下:
- 引用对应的Abp支付的Nuget包
如果仅需某个支付,仅需引用该支付的包。下面以通联支付为例,我们需要在工程中引用此包:
名称 | 说明 | Nuget |
---|---|---|
Magicodes.Pay.Volo.Abp.Allinpay | ABP VNext通联支付模块 |
|
- 添加模块依赖
在对应工程的Abp的模块(AbpModule)中,添加对“AbpAllinpayModule”的依赖,如:
[DependsOn(typeof(AbpAllinpayModule))]
- 在DbContext中添加名为“TransactionLogs”的DbSet
整个支付过程中(无论是支付成功还是出现异常),均会记录交易日志。交易日志会记录交易过程中的一些信息,比如客户端信息、交易参数、自定义参数以及异常信息。因此我们需要针对EF添加对TransactionLog的支持。需要在DbContext中添加的完整代码如下所示:
public DbSet<TransactionLog> TransactionLogs { get; set; }
- 注册回调逻辑
我们需要实现“IPaymentCallbackAction”接口来编写自定义的回调逻辑,一个逻辑需注册一个,通过业务关键字来匹配对应的回调逻辑,比如“缴费支付”、“充值”。如以下示例所示:
public class TestPaymentCallbackAction : IPaymentCallbackAction{/// <summary>/// 业务Key/// </summary>public string Key { get; set; } = "缴费支付";/// <summary>/// 执行回调/// </summary>/// <returns></returns>public async Task Process(IUnitOfWorkManager unitOfWork, TransactionLog transactionLog){var data = transactionLog.CustomData.FromJsonString<JObject>();//业务处理await Task.FromResult(0);}}
注意Key不要重复。
- 向容器中注册回调逻辑
如未自动注册,可以使用以下代码进行手动注册:
ontext.Services.AddTransient<IPaymentCallbackAction, TestPaymentCallbackAction>();
除了上面的方式,我们还可以通过注入IPaymentManager对象,通过其RegisterCallbackAction方法来注册自定义的回调逻辑。
- 配置支付参数
支付参数支持配置文件或SettingManager配置,下面以配置文件为例,配置如下所示:
"Allinpay": {"IsEnabled": "true","CusId": "testtest","ApiGateWay": "https://vsp.allinpay.com/apiweb/unitorder","AppKey": "testtesttesttest","AppId": "testtesttesttesttesttest","Version": "11","NotifyUrl": "{域名}/PayNotify/{tenantId?}/{支付提供程序Key}","WeChatAppId": "微信小程序支付的APPID","JsApiAppId":"JSAPI支付的APPID"}
如上述代码所示,配置节点 “Allinpay”对应提供程序的Key。相关支付提供程序的Key如下所示:
- 支付宝:Alipay
- 国际支付宝:Global.alipay
- 通联支付:Allinpay
- 微信:Wxpay
值得注意的是,默认情况,回调统一由【Magicodes.Pay.Notify】下的“PayNotifyController”控制器来处理,因此回调地址配置格式如下所示:
{域名}/PayNotify/{tenantId?}/{支付提供程序Key}
- 发起支付
配置完成后,就可以使用统一封装的IPayAppService来发起支付。仅需注入IPayAppService,然后调用Pay方法即可。也可以自行再次封装,如下述代码所示:
public async Task<object> Payment(PaymentInput input){return await _payAppService.Pay(new PayInputBase(){Body = $"{input.Name} {input.ChargeProjectName}",CustomData = input.ToJsonString(),Key = "缴费支付",OpenId = input.OpenId,Subject = input.ChargeProjectName,TotalAmount = input.Amount,PayChannel = input.PayChannel});}
通过IPayAppService统一支付有如下好处:
- 统一支付(无论支付宝还是微信各种端的支付,均可统一)
- 自动记录交易日志以及进行相关逻辑处理
- 自定义数据依赖交易日志进行存储,而不依赖支付渠道,因此支持无业务参数的支付渠道,也支持存储更多自定义数据
老Abp集成教程
如果使用Abp相关模块,则使用起来比较简单,具体您可以参考相关单元测试的编写。主要有以下步骤:
- 引用对应的Abp支付的Nuget包
如果仅需某个支付,仅需引用该支付的包。下面以通联支付为例,我们需要在工程中引用此包:
名称 | 说明 | Nuget |
---|---|---|
Magicodes.Pay.Abp.Allinpay | ABP 通联支付模块 |
|
- 添加模块依赖
在对应工程的Abp的模块(AbpModule)中,添加对“AbpAllinpayModule”的依赖,如:
[DependsOn(typeof(AbpAllinpayModule))]
- 在DbContext中添加名为“TransactionLogs”的DbSet
整个支付过程中(无论是支付成功还是出现异常),均会记录交易日志。交易日志会记录交易过程中的一些信息,比如客户端信息、交易参数、自定义参数以及异常信息。因此我们需要针对EF添加对TransactionLog的支持。需要在DbContext中添加的完整代码如下所示:
public DbSet<TransactionLog> TransactionLogs { get; set; }
- 注册回调逻辑
我们需要实现“IPaymentCallbackAction”接口来编写自定义的回调逻辑,一个逻辑需注册一个,通过业务关键字来匹配对应的回调逻辑,比如“缴费支付”、“充值”。如以下示例所示:
public class TestPaymentCallbackAction : IPaymentCallbackAction{/// <summary>/// 业务Key/// </summary>public string Key { get; set; } = "缴费支付";/// <summary>/// 执行回调/// </summary>/// <returns></returns>public async Task Process(IUnitOfWorkManager unitOfWork, TransactionLog transactionLog){var data = transactionLog.CustomData.FromJsonString<JObject>();//业务处理await Task.FromResult(0);}}
注意Key不要重复。
- 向容器中注册回调逻辑
我们可以将回调逻辑写在一个公共的程序集,然后使用以下代码进行注册:
IocManager.IocContainer.Register(//注册自定义支付回调逻辑Classes.FromAssembly(typeof(ApplicationCoreModule).GetAssembly()).BasedOn<IPaymentCallbackAction>().LifestyleTransient().Configure(component => component.Named(component.Implementation.FullName)).WithServiceFromInterface());
除了上面的方式,我们还可以通过注入IPaymentManager对象,通过其RegisterCallbackAction方法来注册自定义的回调逻辑。
- 配置支付参数
支付参数支持配置文件和SettingManager配置,下面以配置文件为例,配置如下所示:
"Allinpay": {"IsEnabled": "true","CusId": "testtest","ApiGateWay": "https://vsp.allinpay.com/apiweb/unitorder","AppKey": "testtesttesttest","AppId": "testtesttesttesttesttest","Version": "11","NotifyUrl": "{域名}/PayNotify/{tenantId?}/{支付提供程序Key}","WeChatAppId": "微信小程序支付的APPID","JsApiAppId":"JSAPI支付的APPID"}
如上述代码所示,配置节点 “Allinpay”对应提供程序的Key。相关支付提供程序的Key如下所示:
- 支付宝:Alipay
- 国际支付宝:Global.alipay
- 通联支付:Allinpay
- 微信:Wxpay
值得注意的是,默认情况,回调统一由【Magicodes.Pay.Notify】下的“PayNotifyController”控制器来处理,因此回调地址配置格式如下所示:
{域名}/PayNotify/{tenantId?}/{支付提供程序Key}
- 发起支付
配置完成后,就可以使用统一封装的IPayAppService来发起支付。仅需注入IPayAppService,然后调用Pay方法即可。也可以自行再次封装,如下述代码所示:
public async Task<object> Payment(PaymentInput input){return await _payAppService.Pay(new PayInputBase(){Body = $"{input.Name} {input.ChargeProjectName}",CustomData = input.ToJsonString(),Key = "缴费支付",OpenId = input.OpenId,Subject = input.ChargeProjectName,TotalAmount = input.Amount,PayChannel = input.PayChannel});}
通过IPayAppService统一支付有如下好处:
- 统一支付(无论支付宝还是微信各种端的支付,均可统一)
- 自动记录交易日志以及进行相关逻辑处理
- 自定义数据依赖交易日志进行存储,而不依赖支付渠道,因此支持无业务参数的支付渠道,也支持存储更多自定义数据
非ABP集成
请参考Abp相关模块的封装或者历史代码。
问题排查
检查日志,相关环节基本上均有日志输出。系统初始化时会打印已注册的支付服务以及回调逻辑,回调时会打印回调进度。如已发起支付,可以查看数据库的交易日志表的数据来辅助排查问题。
相关QQ群
编程交流群<85318032>
官方博客/文档站
- https://github.com/xin-lai/Magicodes.Pay
- http://www.cnblogs.com/codelove/
- https://docs.xin-lai.com/
Magicodes.Pay已支持Volo Abp相关推荐
- Magicodes.SwaggerUI 已支持.NET Core 3.1
Magicodes.SwaggerUI 通过配置文件简单配置即可快速完成SwaggerUI的配置,包括: SwaggerUI的文档信息 API分组 API隐藏 API JSON生成(枚举.API架构 ...
- Magicodes.IE已支持导出Word、Pdf和Html
关于Magicodes.IE 导入导出通用库,通过导入导出DTO模型来控制导入和导出,支持Excel.Word.Pdf和Html. GitHub地址:https://github.com/xin-la ...
- Magicodes.Pay,打造开箱即用的统一支付库,已提供ABP模块封装
Magicodes.Pay,打造开箱即用的统一支付库,已提供ABP模块封装 简介 Magicodes.Pay,是心莱科技团队提供的统一支付库,相关库均使用.NET标准库编写,支持.NET Framew ...
- 开源库支付库Magicodes.Pay发布
Magicodes.Pay,是心莱科技团队提供的统一支付库,相关库均使用.NET标准库编写,支持.NET Framework以及.NET Core.目前支持以下支付方式和功能: 支付宝APP支付 支付 ...
- 开源:Taurus.MVC 框架 (已支持.NET Core)
为什么要创造Taurus.MVC: 记得被上一家公司忽悠去负责公司电商平台的时候,情况是这样的: 项目原版是外包给第三方的,使用:WebForm+NHibernate,代码不堪入目,Bug无限,经常点 ...
- 加密货币交易所Gemini已支持新加坡元(SGD)
加密货币交易所Gemini已支持新加坡元(SGD).现在可以使用借记卡通过SGD购买加密货币,并使用FAST转账将SGD存入Gemini帐户. 文章链接:https://www.tuoluocaiji ...
- android语音控制歌曲播放,Amazon Music应用程序已支持Alexa语音控制歌曲播放
现在,您终于可以和Amazon Music应用程序进行语音交互了,就像和亚马逊Echo智能音箱对话一样. 虽然在去年九月Amazon Music的手机APP就已推出Alexa语音功能,但仍然需要通过点 ...
- 互联网晚报 | 1月8日 星期六 | 小米商城已支持数字人民币支付;微信视频号将上线付费直播间;苹果CEO去年薪酬近1亿美元...
今日看点 ✦ 微信直播即将上线知识专栏,微信视频号即将上线付费直播间 ✦ 淘宝直播启动"发光俱乐部"计划,为商家和主播提供全面立体扶持 ✦ 天星数科携手小米商城上线数字人民币支付服 ...
- 极客日报:恶意软件感染超1000万台安卓设备;淘宝App已支持“云闪付”付款;OpenSSH 8.8发布
一分钟速览新闻点! OPPO在德国反诉诺基亚专利侵权 抖音支持外放音量过高提醒功能 淘宝App已支持"云闪付"付款 理想汽车称玻璃存在自动开裂可能性 阿里申请"阿里元宇宙 ...
最新文章
- P2P最易遭受的DDoS***以及防御手段
- 中大李文均团队在氮循环功能基因的生物地理学分布格局研究中取得进展
- Vigenère密码
- php 按条件进行计算的方法
- Sketch vs. Figma vs. adobe xd:哪个设计工具最适合初学者?
- 红黑树插入和删除的各种情况分析
- JavaWeb——新建项目与新建servlet
- python 柱状图上显示字体_Python爬取百部电影数据,我发现了这个惊人真相!
- 荣耀play3 鸿蒙,荣耀play系列跳过2直接上3代,999元的配置还能愉快play吗?
- 方法同时使用微服务调用文件上传方法以及调用另一微服务的方法时报错failed to parse multipart servlet Request
- 【DSP开发】DSP程序优化
- 【C++】简易GIF生成器(斗图神器!必备!!!)持续更新~
- 3分钟搞懂什么是WPF。
- vscode 文件图标主题
- Dex.top“50计划”新玩法,能否让行业格局重新洗牌?
- 计算机桌面如何整理,怎么整理电脑桌面
- Vsan节点报“Power-on Reset”和“Could not open device ‘naa...‘ for probing: Busy”错误处理记录
- 认识计算机教案模板表格,word表格制作教学设计范文
- 手把手教你移植 tinyriscv 到FPGA上
- JavaScript练习--[使用js语言实现网页切换图片的效果]
热门文章
- 文章html格式排版工具,网站文章排版美化:推荐几款实用丰富的在线编辑器 | 闲一鱼博客...
- linux下测试ftp传输,linux下ftp命令使用详解---linux文件传输ftp命令
- 零基础学Linux运维,看这一篇就够了(含30G自学教程笔记)
- 常用JavaScript库
- 在Arcgis中进行拓扑检查(二)
- 【小甲鱼C语言】课后笔记第一章第四节——数据类型
- 【Matlab】开发环境介绍及学习方法
- 内测福利!百度超级链数字藏品转赠券限量发放
- cannot coerce class ‘“igraph“’ to a data.frame
- 最全事业单位计算机基础知识试题,最全的事业单位考试计算机基础知识试题