减小 App 体积

  • React Native

更新时间

了解实时互动 RTC 在不同平台上的减小 App 体积方式,包括接入流程、关键配置和平台差异。

App 体积是影响用户体验的重要因素之一,更小的包体积意味着用户可以消耗更少的带宽和时间下载 App。 在以下场景中,减小 App 体积对提升用户体验具有重要意义:

  • App 的应用场景对 App 体积有严格要求。例如运行在储存空间有限的智能穿戴设备上。
  • App 的目标用户群体位于欠发达地区,网络环境较差,导致 App 下载时间过长。

本文介绍如何减少集成声网实时互动 SDK 的 App 体积。

删除不需要的插件

SDK 提供了可选的插件动态库,插件的命名以 extension 为后缀,插件功能和大小等信息详见插件列表。你可以参考如下方式不集成这些插件,以减小 App 体积。

Android 平台

当你的目标开发平台为 Android 时,你可以使用 Gradle 的 packagingOptions.exclude 属性在打包过程中将不需要的插件动态库排除在最终的 APK 或 AAR 文件中,从而减小 App 体积并提高 App 性能。

在项目根目录下的 build.gradle 文件中,找到 android 模块下的 packagingOptions 配置块,并在其中添加 exclude 属性,指定要排除的插件动态库。参考以下示例排除指定插件:

groovy
android {
    ...
    packagingOptions {
      // 排除 armeabi-v7a 架构的 AI 降噪插件
      exclude 'lib/armeabi-v7a/libagora_ai_denoise_extension.so'
      // 排除 arm64-v8a 架构的 AI 降噪插件
      exclude 'lib/arm64-v8a/libagora_ai_denoise_extension.so'
      // 排除 armeabi-v7a 架构的空间音频插件
      exclude 'lib/armeabi-v7a/libagora_spatial_audio_extension.so'
      // 排除 arm64-v8a 架构的空间音频插件
      exclude 'lib/arm64-v8a/libagora_spatial_audio_extension.so'
    }
}

iOS/macOS 平台

如果你的目标开发平台为 iOS 或 macOS,请参考以下步骤减小 App 体积:

  1. 在项目的 Podfile 文件中添加以下脚本,将 agora_rtc_engine 里不需要的插件标记为 weak_frameworks。

    Ruby
    # 在已有的 post_install 中添加以下内容
    # 如果你的 Podfile 已经有 post_install,请将此内容整合到现有块中,而不是创建新的
    post_install do |installer|
      installer.pods_project.targets.each do |target|
        # 保留原有的 build 设置
        additional_ios_build_settings(target)
        
        # 需要标记弱链接的目标,请根据你的项目名称修改
        # 如果你的项目名不是"Runner",请将"Pods-Runner"改为"Pods-你的项目名"
        targets_to_weaklink=['Pods-Runner', "agora_rtc_engine"]
        
        # 将 frameworks_to_weaklink 中列出的插件按需替换为你想标记为弱链接的插件
        # 你可以根据自己的需求删除不需要的插件
        frameworks_to_weaklink=["AgoraAiEchoCancellationExtension", "AgoraAiNoiseSuppressionExtension", 
                              "AgoraAudioBeautyExtension", "AgoraClearVisionExtension", 
                              "AgoraContentInspectExtension", "AgoraDrmLoaderExtension", 
                              "AgoraReplayKitExtension", "AgoraSpatialAudioExtension", 
                              "AgoraSuperResolutionExtension", "AgoraVideoQualityAnalyzerExtension", 
                              "AgoraVideoSegmentationExtension"]
    
        # 仅对指定目标应用更改
        next unless targets_to_weaklink.include?(target.name)
    
        # 执行弱链接设置
        target.build_configurations.each do |config|
          base_config_reference = config.base_configuration_reference
          unless base_config_reference.nil?
            xcconfig_path = base_config_reference.real_path
            xcconfig = File.read(xcconfig_path)
            frameworks_to_weaklink.each do |framework|
              xcconfig = xcconfig.gsub(/-framework "#{framework}"/, "-weak_framework \"#{framework}\"")
            end
            File.open(xcconfig_path, "w") { |file| file << xcconfig }
          end
        end
      end
    end
  2. 如下图所示,使用 Xcode 打开项目,在 Build Phases 页签中添加一个 New Run Script Phase 用于移除不需要的插件。

参考上图进行到第 5 步时,将 Shell 指定为 /usr/bin/ruby,代码部分替换为以下脚本:

Shell
$stderr.puts "Removing Unnecessary Frameworks"
# 此处 frameworks_to_weaklink 中列出的插件应与步骤 1 中相同
frameworks_to_weaklink=["AgoraAiEchoCancellationExtension", "AgoraAiNoiseSuppressionExtension", "AgoraAudioBeautyExtension", "AgoraClearVisionExtension", "AgoraContentInspectExtension", "AgoraDrmLoaderExtension", "AgoraReplayKitExtension", "AgoraSpatialAudioExtension", "AgoraSuperResolutionExtension", "AgoraVideoQualityAnalyzerExtension", "AgoraVideoSegmentationExtension"]
for framework in frameworks_to_weaklink
    framework_path = "#{ENV['BUILT_PRODUCTS_DIR']}/#{ENV['FRAMEWORKS_FOLDER_PATH']}/#{framework}.framework"
    `rm -Rf "#{framework_path}"`
end

注意

移除指定插件的 Run Script 需放在 Build Phases 的最后一步。

参考信息

插件列表

本节提供实时互动 SDK 各插件简介和集成后 App 增加的体积参考。

信息

  • 本节数据基于实时互动 v4.6.0 SDK。
  • 自 v4.6.2 起,iOS 平台不再提供 armv7 架构的插件。

常见问题