从零开始设计搭建ios App框架(十)
支付模块
相信做过电商App的同胞们有个功能模块是必需的,那就是线上支付。app用户通过线上支付完成商品和服务的购买。
现如今线上支付的方式有多种,ios自家的支付就有苹果内购,applePay,其他大的支付平台有支付宝、微信、银联,以及跟银联合作而衍生出来小支付平台。在这里就不一一介绍各各支付平台。
总之大部分支付平台支付流程跟下图相似
支付.jpg当然此文我重点是介绍客户端的支付模块设计。
支付场景:
- 当app用户购买商品或者服务到结算页面时,就会有下单与支付需求;
- 当用户进入自己的订单列表时,可以对没有支付的订单进行支付;
- 当用户进入未支付的订单详情页面时,也可以进行订单支付;
app线上支付模块设计:
1、不需要对原有App框架作大的改动,也就是说低偶合;
2、支付API简单明了,方便集成;
3、支付结果能正确告之支付发起者;
4、在原有模块中可以方便扩展添加新的支付平台;
经过分析会得出下图的左边部分
客户端支付模块.jpg发起支付的场景一般都会在ViewController中进行,为了方便也为了代码简洁,我们一般不会在每个支付发起的Controller中都去写创建订单、获取支付参数等这些相似的代码。有没有办法解决一下呢?
这个时候想到最快的方式就是构建个BaseViewController继承于ViewController,将上述相关代码封装好。然后支付场景的ViewController都继承这个BaseViewController。
继承的确可以做到,但不知道你有没有这样的经历,当有新功能需新建一个Demo来预演时,通过我们会拷贝现有工程中的部分文件,不想重新写,ViewController一般是包括在其中的,这个时候就你要把支付相关的模块逻辑也拷贝出来,不然编译不过。有一种拔出萝卜带出泥的感觉。
其实还有做法就是用catagory,为Controller新建一支付相关的分类,目前我采用的就是这种方法。
typedef void(^PGPayFinishBlock)(PGPayResult *resultObj);
typedef void(^PGPayParamBlock)(NSString *orderId, PGPayType payType);
@interface PGBaseController (pay)<PGPayManagerDelegate>
/*
支付完成时的block回调
*/
@property(nonatomic, copy)PGPayFinishBlock payFinishBlock;
/*
获取支付所需的支付参数
*/
@property(nonatomic, copy)PGPayParamBlock payParamBlock;
/*
订单号
*/
@property(nonatomic, copy)NSString *payOrderId;
/*
进行支付
*/
- (void)pay:(NSString *)szOrderId;
/*
用对应的支付方式进行支付
*/
- (void)startPayWithParam:(NSDictionary *)dicParam
payType:(PGPayType)payType
orderId:(NSString *)szOrderId;
@end
支付方式这么多种,我是不是可以有一个统一的管理类对这些支付逻辑进行模块化封装。用这个类统一处理第三方支付平台(支付,结果 回调处理)逻辑,处理完成后回调给支付场景。
这样分析后就会得出上图中右边部分。
定义支付方式:
/*
支付方式
*/
typedef NS_ENUM(NSInteger, PGPayType) {
PGPayType_None = 0,//不支付
PGPayType_WxPay = 1,//微信支付
PGPayType_AliPay = 2,//支付宝支付
};
支付定义结果:
/*
支付结果状态
*/
typedef NS_ENUM(NSInteger, PayErrCode) {
PaySuccess = 0, /**< 成功 */
PayErrCodeCommon = -1, /**< 失败 */
PayErrCodeUserCancel = -2, /**< 用户点击取消并返回 */
};
#pragma mark -
/**
支付结果
*/
@interface PGPayResult : NSObject
@property(nonatomic, strong)NSString *szOrder;
@property(nonatomic, assign)PayErrCode errorCode;
@property(nonatomic, strong)NSString *szDesc;
@end
支付管理类PGPayManager:
#pragma mark -
@protocol PGPayManagerDelegate <NSObject>
@required
/*
payResult: 支付结果
*/
- (void)payFinished:(PGPayResult *)payResult;
/*
平台App没有安装
*/
- (void)noInstallPlatformApp:(PGPayType)type orderId:(NSString *)orderId;
@end
#pragma mark -
@interface PGPayManager : NSObject
+ (PGPayManager *)shareInstance;
/*
支付完成后,应用间的信息传递
*/
- (void)handleOpenURL:(NSURL *)url;
/*
初始化各支付平台
*/
- (void)platformInit;
/*
开始支付
dicParam: 平台SDK支付所需的参数
type:支付方式
delegate: 支付完成后的回调
*/
- (void)startPayWithParam:(NSDictionary *)dicParam
orderId:(NSString *)orderId
payType:(PGPayType)type
delegate:(id<PGPayManagerDelegate>)delegate;
/*
获取微信支付下载地址
*/
+ (NSString *)getWXAppInstallUrl;
@end
支付场景发起支付调用示例
#pragma mark -
- (void)payOrder
{
//订单支付
[self pay:self.payOrderId];
}
#pragma mark - PGApiDelegate
- (void)dataRequestFinish:(PGResultObject *)resultObj apiType:(PGApiType)apiType
{
[self hideWaitingView];
if(apiType == API_TYPE_ORDER_PAY)
{
if(resultObj.nCode == 0)
{
//
//获取支付所需的参数进行支付
// ...
//
NSDictionary *dicParam = [[NSDictionary alloc] init];
NSInteger payType = [(NSNumber *)resultObj.extendParam integerValue];
[self startPayWithParam:dicParam payType:payType orderId:self.payOrderId];
}
else
{
[self showMsg:resultObj.szErrorDes];
}
}
}
- (void)createInitData
{
[super createInitData];
self.payOrderId = @"订单号xxxxxxx";
WEAKSELF
self.payParamBlock = ^(NSString *orderId, PGPayType payType) {
dispatch_async(dispatch_get_main_queue(), ^{
[weakSelf showWaitingView:nil];
//去服务器端通过订单号与支付方式获取支付所需的参数
[PGRequestManager startPostClient:API_TYPE_ORDER_PAY param:@{@"orderId":orderId} target:weakSelf extendParam:[NSNumber numberWithInteger:payType]];
});
};
//支付完成后回调
self.payFinishBlock = ^(PGPayResult *result) {
if(result.errorCode == PaySuccess)
{
//支付成功
}
else if(result.errorCode == PayErrCodeCommon)
{
//支付失败
}
else
{
//支付取消
}
//作相应的页面跳转
};
}
调用效果
C5EF7091-E5B9-4D77-B6BB-353753DF5ADA.png
感谢您的阅读!