在纯 React Native 项目中安装并配置 Adapty SDK

本指南仅适用于纯 React Native(非 Expo)项目。 如果你使用的是 Expo,请参阅 Expo 安装指南

Adapty SDK 包含两个核心模块,可无缝集成到你的 React Native 应用中:

  • 核心 Adapty:此模块是 Adapty 在应用中正常运行的必要组件。
  • AdaptyUI:如果您使用 Adapty 付费墙编辑工具(一款无需编写代码即可轻松创建跨平台付费墙的可视化工具),则需要此模块。AdaptyUI 会随核心模块一同自动激活。

想看看 Adapty SDK 在移动应用中集成的真实案例?欢迎查看我们的示例应用,其中展示了完整的配置流程,包括展示付费墙、完成购买以及其他基础功能。

要求

Adapty React Native SDK 支持 iOS 13.0+,但使用 Adapty 付费墙编辑工具创建的付费墙需要 iOS 15.0+。

Adapty 兼容 Google Play Billing Library 8.x 及以下版本。默认情况下,Adapty 使用 Google Play Billing Library v7.0.0,但如果您希望强制使用更高版本,可以手动添加依赖项

安装 SDK 是 Adapty 配置流程的第 5 步。在您的应用内购买功能正常运行之前,您还需要将应用连接到应用商店,然后在 Adapty 控制台中创建产品、付费墙和版位。快速入门指南 将引导您完成所有必要步骤。

安装 Adapty SDK

Release

  1. 安装 Adapty SDK(此操作也会自动安装 @adapty/core):
    # using npm
    npm install react-native-adapty
    
    # or using yarn
    yarn add react-native-adapty  
  2. 对于 iOS,安装 pods:
    cd ios && pod install
对于 Android,如果你的 React Native 版本低于 0.73.0(点击展开)

更新 /android/build.gradle 文件,确保其中包含 kotlin-gradle-plugin:1.8.0 或更高版本的依赖:

...
buildscript {
  ...
  dependencies {
    ...
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.8.0"
  }
}
...

激活 Adapty SDK 的 Adapty 模块

要获取您的 Public SDK Key

  1. 前往 Adapty 控制台,导航至 App settings → General
  2. Api keys 部分,复制 Public SDK Key(不是 Secret Key)。
  3. 将代码中的 "YOUR_PUBLIC_SDK_KEY" 替换为您的密钥。
  • 请确保使用 Public SDK key 进行 Adapty 初始化,Secret key 仅应用于服务端 API
  • SDK keys 对每个应用都是唯一的,如果您有多个应用,请确保选择正确的密钥。

将以下代码复制到 App.tsx 以激活 Adapty:


adapty.activate('YOUR_PUBLIC_SDK_KEY');

在调用任何其他 Adapty SDK 方法之前,请等待 activate 执行完成。完整的调用顺序请参阅 React Native SDK 调用顺序

现在在你的应用中配置付费墙:

如需避免开发环境中的激活报错,请参考相关建议

激活 Adapty SDK 的 AdaptyUI 模块

如果您计划使用付费墙编辑工具,则需要 AdaptyUI 模块。激活核心模块时,它会自动激活,无需执行任何其他操作。

可选配置

日志记录

设置日志系统

Adapty 会记录错误和其他重要信息,帮助你了解应用的运行状况。以下是可用的日志级别:

级别描述
error仅记录错误日志
warn记录错误以及 SDK 产生的非严重但值得关注的消息
info记录错误、警告及各类信息消息
verbose记录所有可能有助于调试的额外信息,例如函数调用、API 请求等
您可以在应用中配置 Adapty 之前或配置期间设置日志级别:
// Set log level before activation
// 'verbose' is recommended for development and the first production release
adapty.setLogLevel('verbose');

// Or set it during configuration
adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  logLevel: 'verbose',
});

数据策略

Adapty 不会存储用户的个人数据,除非你明确发送这些数据。不过,你也可以实施额外的数据安全策略,以符合应用商店或所在国家/地区的合规要求。

禁用 IP 地址的收集与共享

在激活 Adapty 模块时,将 ipAddressCollectionDisabled 设置为 true 即可禁止收集和共享用户 IP 地址。默认值为 false。 使用此参数可以增强用户隐私保护、遵守区域性数据保护法规(如 GDPR 或 CCPA),或在应用不需要基于 IP 的功能时减少不必要的数据收集。

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  ipAddressCollectionDisabled: true,
});

禁用广告 ID 的收集与共享

激活 Adapty 模块时,将 ios.idfaCollectionDisabled(iOS)或 android.adIdCollectionDisabled(Android)设置为 true,即可禁用广告标识符的收集。默认值为 false

如需遵守 App Store/Play Store 政策、避免触发应用跟踪透明度提示,或者您的应用不需要基于广告 ID 的广告归因或分析功能,请使用此参数。

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  ios: {
    idfaCollectionDisabled: true,      
  },
  android: {
    adIdCollectionDisabled: true,      
  },
});

为 AdaptyUI 配置媒体缓存

默认情况下,AdaptyUI 会缓存媒体文件(如图片和视频)以提升性能并减少网络流量。你可以通过提供自定义配置来调整缓存设置。

使用 mediaCache 可以覆盖默认的缓存配置:

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  mediaCache: {
    memoryStorageTotalCostLimit: 200 * 1024 * 1024, // 可选:内存缓存大小(字节)
    memoryStorageCountLimit: 2147483647,            // 可选:内存中最大条目数
    diskStorageSizeLimit: 200 * 1024 * 1024,       // 可选:磁盘缓存大小(字节)
  },
});
参数是否必填描述
memoryStorageTotalCostLimit可选内存缓存总大小,单位为字节。默认值因平台而异。
memoryStorageCountLimit可选内存存储的条目数量上限。默认值因平台而异。
diskStorageSizeLimit可选磁盘文件大小上限,单位为字节。默认值因平台而异。

启用本地访问等级(Android)

默认情况下,本地访问等级在 iOS 上已启用,在 Android 上已禁用。要在 Android 上也启用它们,请将 localAccessLevelAllowed 设置为 true

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  android: {
     localAccessLevelAllowed: true,      
  },
});

备份恢复时清除数据

clearDataOnBackup 设置为 true 时,SDK 会检测应用从 iCloud 备份恢复的情况,并删除所有本地存储的 SDK 数据,包括缓存的用户画像信息、产品详情和付费墙。SDK 随后会以干净状态初始化。默认值为 false

仅删除本地 SDK 缓存。与 Apple 的交易记录及 Adapty 服务器上的用户数据保持不变。

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
   ios: {
      clearDataOnBackup: true
   },
});

开发环境使用技巧

在开发阶段延迟 SDK 激活

Adapty 在 SDK 激活时会预先拉取所有必要的用户数据,从而更快地获取最新数据。

然而,这在 iOS 模拟器中可能会带来问题——开发过程中模拟器会频繁弹出身份验证提示。Adapty 虽然无法控制 StoreKit 的身份验证流程,但可以延迟 SDK 发起的数据刷新请求。 通过启用 __debugDeferActivation 属性,激活调用将被延迟,直到您发起下一次 Adapty SDK 调用。这样可以避免在不需要时弹出不必要的身份验证数据提示。

需要注意的是,此功能仅供开发阶段使用,因为它并不能覆盖所有潜在的用户场景。在生产环境中,不应延迟激活,因为真实设备通常会记住身份验证数据,不会反复提示输入凭据。

以下是推荐的使用方式:

try {
  adapty.activate('PUBLIC_SDK_KEY', {
    __debugDeferActivation: isSimulator(), // 'isSimulator' from any 3rd party library
  });
} catch (error) {
  console.error('Failed to activate Adapty SDK:', error);
  // Handle the error appropriately for your app
}

排查 React Native Fast Refresh 下的 SDK 激活错误

在 React Native 中使用 Adapty SDK 开发时,你可能会遇到以下错误:Adapty can only be activated once. Ensure that the SDK activation call is not made more than once. 这是因为 React Native 的快速刷新功能在开发过程中会触发多次激活调用。为避免此问题,请将 __ignoreActivationOnFastRefresh 选项设置为 __DEV__(React Native 的开发模式标志)。

try {
  adapty.activate('PUBLIC_SDK_KEY', {
    __ignoreActivationOnFastRefresh: __DEV__, 
  });
} catch (error) {
  console.error('Failed to activate Adapty SDK:', error);
  // Handle the error appropriately for your app
}

为本地测试设置模拟模式

在本地开发和测试时,你可以启用模拟模式,从而无需沙盒 App Store/Google Play 账号,加快迭代速度。模拟模式会完全绕过 Adapty 的原生模块,返回模拟数据。

模拟模式不是用于测试真实购买的工具:

  • 不会打开 App Store / Google Play 购买流程,也不会创建真实交易。
  • 不会渲染使用 Adapty 付费墙编辑工具 (AdaptyUI) 创建的付费墙/用户引导。
  • Adapty 的原生模块会被完全绕过——即使 Xcode/Android 构建中缺少原生 SDK 文件或 API 密钥无效,也不会触发错误。
  • 不会向 Adapty 服务器发送任何数据。

如需测试真实购买和付费墙编辑工具中的付费墙,请禁用模拟模式并使用沙盒账户。

要启用模拟模式,请将 enableMock 设置为 true

adapty.activate('YOUR_PUBLIC_SDK_KEY', {
  enableMock: true,
});

当模拟模式激活时:

  • 所有 Adapty 方法返回模拟数据,不会向 Adapty 服务器发送网络请求。
  • 默认情况下,初始模拟用户画像没有活跃的订阅。
  • 默认情况下,makePurchase(...) 会模拟一次成功购买并授予高级访问等级。

你可以在激活时通过 mockConfig 自定义模拟数据。配置格式和支持的参数详见这里


try {
   await adapty.activate('YOUR_PUBLIC_SDK_KEY', {
      mockConfig: {
         // Customize the initial mock profile (optional)
      },
   });
} catch (error) {
   console.error('Failed to activate Adapty SDK:', error);
}

如果你需要在激活之前调用 SDK 方法(例如 isActivated()setLogLevel()),请在 activate() 之前使用 enableMock()。如果 bridge 已经初始化,该方法不会执行任何操作。

adapty.enableMock(); // 可选:传入 mockConfig 以自定义模拟数据

// 现在可以在激活前调用方法

await adapty.activate('YOUR_PUBLIC_SDK_KEY');

故障排查

iOS 最低版本错误

如果遇到 iOS 最低版本错误,请更新 Podfile:

-platform :ios, min_ios_version_supported
+platform :ios, '13.0'  # For core features only
# OR
+platform :ios, '15.0'  # If using paywalls created in the paywall builder

Android 自动备份清单冲突

部分 SDK(包括 Adapty)会附带自己的 Android Auto Backup 配置。如果您使用了多个定义备份规则的 SDK,Android 清单合并工具可能会失败,并出现提及 android:fullBackupContentandroid:dataExtractionRulesandroid:allowBackup 的错误。

典型错误症状:Manifest merger failed: Attribute application@dataExtractionRules value=(@xml/your_data_extraction_rules) is also present at [com.other.sdk:library:1.0.0] value=(@xml/other_sdk_data_extraction_rules)

这些更改应在您的 Android 平台目录中进行(通常位于项目的 android/ 文件夹中)。

要解决此问题,您需要:

  • 告知清单合并工具使用您应用的备份相关属性值。

  • 创建备份规则文件,将 Adapty 的规则与其他 SDK 的规则合并。

1. 在清单中添加 tools 命名空间

在您的 AndroidManifest.xml 文件中,确保根 <manifest> 标签包含 tools:

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
package="com.example.app">

    ...
</manifest>

2. 在 <application> 中覆盖备份属性

在同一个 AndroidManifest.xml 文件中,更新 <application> 标签,使您的应用提供最终值,并告知清单合并工具替换库中的值:

<application
android:name=".App"
android:allowBackup="true"
android:fullBackupContent="@xml/sample_backup_rules"           
android:dataExtractionRules="@xml/sample_data_extraction_rules"
tools:replace="android:fullBackupContent,android:dataExtractionRules">

    ...
</application>

如果某个 SDK 也设置了 android:allowBackup,请将其同样加入 tools:replace

tools:replace="android:allowBackup,android:fullBackupContent,android:dataExtractionRules"

3. 创建合并后的备份规则文件

在您 Android 项目的 res/xml/ 目录中创建 XML 文件,将 Adapty 的规则与其他 SDK 的规则合并。Android 根据操作系统版本使用不同的备份规则格式,因此同时创建这两个文件可确保您的应用在所有支持的 Android 版本上的兼容性。

以下示例使用 AppsFlyer 作为第三方 SDK 的示例。请替换或添加您应用中实际使用的其他 SDK 的规则。

适用于 Android 12 及更高版本(使用新的数据提取规则格式):

<?xml version="1.0" encoding="utf-8"?>
<data-extraction-rules>
    <cloud-backup>
        
        <exclude domain="sharedpref" path="appsflyer-data"/>
        <exclude domain="sharedpref" path="appsflyer-purchase-data"/>
        <exclude domain="database" path="afpurchases.db"/>
        
        <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
    </cloud-backup>

    <device-transfer>
        
        <exclude domain="sharedpref" path="appsflyer-data"/>
        <exclude domain="sharedpref" path="appsflyer-purchase-data"/>
        <exclude domain="database" path="afpurchases.db"/>
        <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>
    </device-transfer>
</data-extraction-rules>

适用于 Android 11 及更低版本(使用旧版完整备份内容格式):

<?xml version="1.0" encoding="utf-8"?>
<full-backup-content>
    
    <exclude domain="sharedpref" path="appsflyer-data"/>

    
    <exclude domain="sharedpref" path="AdaptySDKPrefs.xml"/>

    

在 Android 上从其他应用返回后购买失败

如果发起购买流程的 Activity 使用了非默认的 launchMode,当用户从 Google Play、银行应用或浏览器返回时,Android 可能会错误地重建或复用该 Activity,导致购买结果丢失或被视为已取消。

为确保购买流程正常运行,发起购买流程的 Activity 只能使用 standardsingleTop 启动模式,避免使用其他模式。

AndroidManifest.xml 中,确保发起购买流程的 Activity 设置为 standardsingleTop

<activity
    android:name=".MainActivity"
    android:launchMode="standard" />

由 Podfile 中 SWIFT_VERSION 覆盖引起的 Swift 6 构建错误

在为 iOS 构建 React Native 应用时,你可能会在 Adapty pod 目标上看到 Swift 6 编译错误。常见症状包括:AdaptyUIBuilderLogic 中出现 @Sendable 不匹配、Adapty 类型缺少 Sendable 一致性,或 actor 隔离错误。 Adapty 的 pods 声明了 s.swift_version = '6.0',需要使用 Swift 6 进行构建。你自己的应用代码可以继续使用 Swift 5——只有 Adapty 相关的 pod 目标(AdaptyAdaptyUIAdaptyUIBuilderAdaptyLoggerAdaptyPlugin)需要使用 Swift 6 构建。

最常见的原因是 ios/Podfile 中存在 post_install 钩子,它会覆盖所有 pod 目标的 SWIFT_VERSION

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['SWIFT_VERSION'] = '5.9'
    end
  end
end

修复方法:在覆盖时排除 Adapty pod 目标:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    next if %w[Adapty AdaptyUI AdaptyUIBuilder AdaptyLogger AdaptyPlugin].include?(target.name)
    target.build_configurations.each do |config|
      config.build_settings['SWIFT_VERSION'] = '5.9'
    end
  end
end

然后在 ios/ 目录下运行 pod install 并重新构建。

要验证配置,请打开 ios/Pods/Pods.xcodeproj,选择 Adapty pod 目标 → Build SettingsSwift Language Version,确认显示为 Swift 6