中文版 | English Version
一个轻量级且易于使用的iOS应用内购库(Swift Version)。
DYFStoreKit使用代码块和通知包装StoreKit，提供收据验证和交易持久化。
- DYFRuntimeProvider
- DYFKeychain
- DYFStoreReceiptVerifier
- Unity-iOS-InAppPurchase
- in-app-purchase-complete-programming-guide-for-iOS
- how-to-easily-complete-in-app-purchase-configuration-for-iOS
- 超级简单的应用内购买
- 内置支持记住您的购买
- 内置收据验证（远程）
- 内置托管内容下载和通知
使用 CocoaPods:
pod 'DYFStoreKit'
Or
pod 'DYFStoreKit', '~> 2.2.0'
查看 wiki 以获取更多选项。
接下来我会教你如何使用 DYFStoreKit.
初始化如下所示。
- 添加交易的观察者，监听交易的变化。
- 实例化数据持久，存储交易的相关信息。
- 遵守协议
DYFStoreAppStorePaymentDelegate，处理从 App Store 购买产品的付款。
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
[self initIAPSDK];
return YES;
}
- (void)initIAPSDK
{
[SKIAPManager.shared addStoreObserver];
// Adds an observer that responds to updated transactions to the payment queue.
// If an application quits when transactions are still being processed, those transactions are not lost. The next time the application launches, the payment queue will resume processing the transactions. Your application should always expect to be notified of completed transactions.
// If more than one transaction observer is attached to the payment queue, no guarantees are made as to the order they will be called in. It is recommended that you use a single observer to process and finish the transaction.
[DYFStore.defaultStore addPaymentTransactionObserver];
// Sets the delegate processes the purchase which was initiated by user from the App Store.
DYFStore.defaultStore.delegate = self;
}
你可以处理用户从应用商店发起的购买，并使用 DYFStoreAppStorePaymentDelegate 协议提供自己的实现：
// Processes the purchase which was initiated by user from the App Store.
- (void)didReceiveAppStorePurchaseRequest:(SKPaymentQueue *)queue payment:(SKPayment *)payment forProduct:(SKProduct *)product
{
if (![DYFStore canMakePayments]) {
[self showTipsMessage:@"Your device is not able or allowed to make payments!"];
return;
}
// Get account name from your own user system.
NSString *accountName = @"Handsome Jon";
// This algorithm is negotiated with server developer.
NSString *userIdentifier = DYFCryptoSHA256(accountName);
DYFStoreLog(@"userIdentifier: %@", userIdentifier);
[SKIAPManager.shared addPayment:product.productIdentifier userIdentifier:userIdentifier];
}
在创建商品查询的请求前，你需要检查设备是否能够或者被允许付款。
if (![DYFStore canMakePayments]) {
[self showTipsMessage:@"Your device is not able or allowed to make payments!"];
return;
}
在开始购买过程，首先必须清楚有哪些产品标识符。有两种策略可用于从应用程序商店获取有关产品的信息。
策略1： App 可以使用其中一个产品标识符来获取应用程序商店中可供销售的产品的信息，并直接提交付款请求。
- (IBAction)fetchesProductAndSubmitsPayment:(id)sender
{
// You need to check whether the device is not able or allowed to make payments before requesting product.
if (![DYFStore canMakePayments]) {
[self showTipsMessage:@"Your device is not able or allowed to make payments!"];
return;
}
[self showLoading:@"Loading..."];
NSString *productId = @"com.hncs.szj.coin48";
[DYFStore.defaultStore requestProductWithIdentifier:productId success:^(NSArray *products, NSArray *invalidIdentifiers) {
[self hideLoading];
if (products.count == 1) {
NSString *productId = ((SKProduct *)products[0]).productIdentifier;
[self addPayment:productId];
} else {
[self showTipsMessage:@"There is no this product for sale!"];
}
} failure:^(NSError *error) {
[self hideLoading];
NSString *value = error.userInfo[NSLocalizedDescriptionKey];
NSString *msg = value ?: error.localizedDescription;
// This indicates that the product cannot be fetched, because an error was reported.
[self sendNotice:[NSString stringWithFormat:@"An error occurs, %zi, %@", error.code, msg]];
}];
}
- (void)addPayment:(NSString *)productId
{
// Get account name from your own user system.
NSString *accountName = @"Handsome Jon";
// This algorithm is negotiated with server developer.
NSString *userIdentifier = DYFCryptoSHA256(accountName);
DYFStoreLog(@"userIdentifier: %@", userIdentifier);
[SKIAPManager.shared addPayment:productId userIdentifier:userIdentifier];
}
策略2： App 从应用程序商店获取有关产品的信息，并向用户显示其商店用户界面。App 中销售的每个产品都有唯一的产品标识符。App 使用这些产品标识符获取有关应用程序商店中可供销售的产品的信息，例如定价，并在用户购买这些产品时提交付款请求。
- (NSArray *)fetchProductIdentifiersFromServer
{
NSArray *productIds = @[@"com.hncs.szj.coin42", // 42 gold coins for ￥6.
@"com.hncs.szj.coin210", // 210 gold coins for ￥30.
@"com.hncs.szj.coin686", // 686 gold coins for ￥98.
@"com.hncs.szj.coin1386", // 1386 gold coins for ￥198.
@"com.hncs.szj.coin2086", // 2086 gold coins for ￥298.
@"com.hncs.szj.coin4886", // 4886 gold coins for ￥698.
@"com.hncs.szj.vip1", // non-renewable vip subscription for a month.
@"com.hncs.szj.vip2" // Auto-renewable vip subscription for three months.
];
return productIds;
}
- (IBAction)fetchesProductsFromAppStore:(id)sender
{
// You need to check whether the device is not able or allowed to make payments before requesting products.
if (![DYFStore canMakePayments]) {
[self showTipsMessage:@"Your device is not able or allowed to make payments!"];
return;
}
[self showLoading:@"Loading..."];
NSArray *productIds = [self fetchProductIdentifiersFromServer];
[DYFStore.defaultStore requestProductWithIdentifiers:productIds success:^(NSArray *products, NSArray *invalidIdentifiers) {
[self hideLoading];
if (products.count > 0) {
[self processData:products];
} else if (products.count == 0 && invalidIdentifiers.count > 0) {
// Please check the product information you set up.
[self showTipsMessage:@"There are no products for sale!"];
}
} failure:^(NSError *error) {
[self hideLoading];
NSString *value = error.userInfo[NSLocalizedDescriptionKey];
NSString *msg = value ?: error.localizedDescription;
// This indicates that the products cannot be fetched, because an error was reported.
[self sendNotice:[NSString stringWithFormat:@"An error occurs, %zi, %@", error.code, msg]];
}];
}
- (void)processData:(NSArray *)products
{
NSMutableArray *modelArray = [NSMutableArray arrayWithCapacity:0];
for (SKProduct *product in products) {
SKStoreProduct *p = [[SKStoreProduct alloc] init];
p.identifier = product.productIdentifier;
p.name = product.localizedTitle;
p.price = [product.price stringValue];
p.localePrice = [DYFStore.defaultStore localizedPriceOfProduct:product];
p.localizedDescription = product.localizedDescription;
[modelArray addObject:p];
}
[self displayStoreUI:modelArray];
}
- (void)displayStoreUI:(NSMutableArray *)dataArray
{
SKStoreViewController *storeVC = [[SKStoreViewController alloc] init];
storeVC.dataArray = dataArray;
[self.navigationController pushViewController:storeVC animated:YES];
}
使用给定的产品标识符请求产品付款。
[DYFStore.defaultStore purchaseProduct:@"com.hncs.szj.coin210"];
如果需要系统上用户帐户的不透明标识符来添加付款，可以使用用户帐户名的单向哈希来计算此属性的值。
计算 SHA256 哈希值函数：
CG_INLINE NSString *DYFCryptoSHA256(NSString *string)
{
const int digestLength = CC_SHA256_DIGEST_LENGTH; // 32
unsigned char md[digestLength];
const char *cStr = [string UTF8String];
size_t cStrLen = strlen(cStr);
// Confirm that the length of C string is small enough
// to be recast when calling the hash function.
if (cStrLen > UINT32_MAX) {
NSLog(@"C string too long to hash: %@", string);
return nil;
}
CC_SHA256(cStr, (CC_LONG)cStrLen, md);
// Convert the array of bytes into a string showing its hex represention.
NSMutableString *hash = [NSMutableString string];
for (int i = 0; i < digestLength; i++) {
// Add a dash every four bytes, for readability.
if (i != 0 && i%4 == 0) {
//[hash appendString:@"-"];
}
[hash appendFormat:@"%02x", md[i]];
}
return hash;
}
使用给定的产品标识符和系统中用户帐户的不透明标识符请求产品付款。
[DYFStore.defaultStore purchaseProduct:@"com.hncs.szj.coin210" userIdentifier:@"A43512564ACBEF687924646CAFEFBDCAEDF4155125657"];
在某些场景（如切换设备），App 需要提供恢复购买按钮，用来恢复之前购买的非消耗型的产品。
- 无绑定用户帐户 ID 的恢复
[DYFStore.defaultStore restoreTransactions];
- 绑定用户帐户 ID 的恢复
[DYFStore.defaultStore restoreTransactions:@"A43512564ACBEF687924646CAFEFBDCAEDF4155125657"];
如果 Bundle.main.appStoreReceiptURL 为空，就需要创建刷新收据请求，获取付款交易的收据。
[DYFStore.defaultStore refreshReceiptOnSuccess:^{
[self storeReceipt];
} failure:^(NSError *error) {
[self failToRefreshReceipt];
}];
DYFStore发送与StoreKit相关事件的通知，并扩展NSNotification以提供相关信息。要接收它们，请将观察者添加到DYFStore管理员。
- (void)addStoreObserver
{
[NSNotificationCenter.defaultCenter addObserver:self selector:@selector(processPurchaseNotification:) name:DYFStorePurchasedNotification object:nil];
[NSNotificationCenter.defaultCenter addObserver:self selector:@selector(processDownloadNotification:) name:DYFStoreDownloadedNotification object:nil];
}
- (void)removeStoreObserver
{
[NSNotificationCenter.defaultCenter removeObserver:self name:DYFStorePurchasedNotification object:nil];
[NSNotificationCenter.defaultCenter removeObserver:self name:DYFStoreDownloadedNotification object:nil];
}
付款交易的通知是在请求付款后发送的，或是为每个恢复的交易发送的。
- (void)processPurchaseNotification:(NSNotification *)notification
{
[self hideLoading];
self.purchaseInfo = notification.object;
switch (self.purchaseInfo.state) {
case DYFStorePurchaseStatePurchasing:
[self showLoading:@"Purchasing..."];
break;
case DYFStorePurchaseStateCancelled:
[self sendNotice:@"You cancel the purchase"];
break;
case DYFStorePurchaseStateFailed:
[self sendNotice:[NSString stringWithFormat:@"An error occurred, %zi", self.purchaseInfo.error.code]];
break;
case DYFStorePurchaseStateSucceeded:
case DYFStorePurchaseStateRestored:
[self completePayment];
break;
case DYFStorePurchaseStateRestoreFailed:
[self sendNotice:[NSString stringWithFormat:@"An error occurred, %zi", self.purchaseInfo.error.code]];
break;
case DYFStorePurchaseStateDeferred:
DYFStoreLog(@"Deferred");
break;
default:
break;
}
}
- (void)processDownloadNotification:(NSNotification *)notification
{
self.downloadInfo = notification.object;
switch (self.downloadInfo.downloadState) {
case DYFStoreDownloadStateStarted:
DYFStoreLog(@"The download started");
break;
case DYFStoreDownloadStateInProgress:
DYFStoreLog(@"The download progress: %.2f%%", self.downloadInfo.downloadProgress);
break;
case DYFStoreDownloadStateCancelled:
DYFStoreLog(@"The download cancelled");
break;
case DYFStoreDownloadStateFailed:
DYFStoreLog(@"The download failed");
break;
case DYFStoreDownloadStateSucceeded:
DYFStoreLog(@"The download succeeded: 100%%");
break;
default:
break;
}
}
DYFStoreKit默认情况下不执行收据验证，但提供引用实现。您可以实现自己的自定义验证或使用库提供的引用验证程序。
引用验证程序概述如下。有关更多信息，请查看 wiki.
通过使用延迟加载（懒加载）创建并返回收据验证器（DYFStoreReceiptVerifier）。
- (DYFStoreReceiptVerifier *)receiptVerifier
{
if (!_receiptVerifier) {
_receiptVerifier = [[DYFStoreReceiptVerifier alloc] init];
_receiptVerifier.delegate = self;
}
return _receiptVerifier;
}
收据验证程序委托收据验证，使您能够使用DYFStoreReceiptVerifierDelegate协议提供自己的实现：
- (void)verifyReceiptDidFinish:(nonnull DYFStoreReceiptVerifier *)verifier didReceiveData:(nullable NSDictionary *)data {}
- (void)verifyReceipt:(nonnull DYFStoreReceiptVerifier *)verifier didFailWithError:(nonnull NSError *)error {}
你可以开始验证应用内购买收据。
// Fetches the data of the bundle’s App Store receipt.
NSData *data = receiptData ?: [NSData dataWithContentsOfURL:DYFStore.receiptURL];
DYFStoreLog(@"data: %@", data);
[_receiptVerifier verifyReceipt:data];
// Only used for receipts that contain auto-renewable subscriptions.
//[_receiptVerifier verifyReceipt:data sharedSecret:@"A43512564ACBEF687924646CAFEFBDCAEDF4155125657"];
如果担心安全性，你可能希望避免使用开源验证逻辑，提供自己的自定义验证程序。
最好使用你自己的服务器获取从客户端上传的参数，以验证来自App Store服务器的收据的响应信息（C -> 上传的参数 -> S -> App Store S -> S -> 接收并解析数据 -> C，C:客户端，S:服务器）。
只有客户端与服务器采用安全通信和数据加密并且收据验证通过后，才能完成交易。这样，我们可以避免刷新订单和破解应用内购买。如果我们无法完成验证，我们希望StoreKit不断提醒我们还有未完成的交易。
[DYFStore.defaultStore finishTransaction:transaction];
DYFStoreKit提供了一个可选的引用实现，用于将交易信息存储在 NSUserDefaults（DYFStoreUserDefaultsPersistence）中。
当客户端在付款过程中发生崩溃，导致 App 闪退，这时存储交易信息尤为重要。当 StoreKit 再次通知未完成的付款时，直接从文件中取出数据，进行收据验证，直至完成交易。
- (void)storeReceipt
{
DYFStoreLog();
NSURL *receiptURL = DYFStore.receiptURL;
NSData *data = [NSData dataWithContentsOfURL:receiptURL];
if (!data || data.length == 0) {
[self refreshReceipt];
return;
}
DYFStoreNotificationInfo *info = self.purchaseInfo;
DYFStoreUserDefaultsPersistence *persister = [[DYFStoreUserDefaultsPersistence alloc] init];
DYFStoreTransaction *transaction = [[DYFStoreTransaction alloc] init];
if (info.state == DYFStorePurchaseStateSucceeded) {
transaction.state = DYFStoreTransactionStatePurchased;
} else if (info.state == DYFStorePurchaseStateRestored) {
transaction.state = DYFStoreTransactionStateRestored;
}
transaction.productIdentifier = info.productIdentifier;
transaction.userIdentifier = info.userIdentifier;
transaction.transactionIdentifier = info.transactionIdentifier;
transaction.transactionTimestamp = info.transactionDate.timestamp;
transaction.originalTransactionTimestamp = info.originalTransactionDate.timestamp;
transaction.originalTransactionIdentifier = info.originalTransactionIdentifier;
transaction.transactionReceipt = data.base64EncodedString;
[persister storeTransaction:transaction];
[self verifyReceipt:data];
}
DYFStoreNotificationInfo *info = self.purchaseInfo;
DYFStore *store = DYFStore.defaultStore;
DYFStoreUserDefaultsPersistence *persister = [[DYFStoreUserDefaultsPersistence alloc] init];
if (info.state == DYFStorePurchaseStateRestored) {
SKPaymentTransaction *transaction = [store extractRestoredTransaction:info.transactionIdentifier];
[store finishTransaction:transaction];
} else {
SKPaymentTransaction *transaction = [store extractPurchasedTransaction:info.transactionIdentifier];
// The transaction can be finished only after the client and server adopt secure communication and data encryption and the receipt verification is passed. In this way, we can avoid refreshing orders and cracking in-app purchase. If we were unable to complete the verification, we want `StoreKit` to keep reminding us that there are still outstanding transactions.
[store finishTransaction:transaction];
}
[persister removeTransaction:info.transactionIdentifier];
if (info.originalTransactionIdentifier) {
[persister removeTransaction:info.originalTransactionIdentifier];
}
DYFStoreKit需要iOS 7.0或更高版本和ARC。
如需了解更多，请克隆此项目（git clone https://github.com/itenfay/DYFStoreKit.git）到本地目录。
如果您发现任何问题，请创建问题。我很乐意帮助你。