如何在iOS WidgetKit中嵌入Mapbox并解决APPLICATION_EXTENSION_API_ONLY报错

核心原因 #

你遇到的报错是因为iOS应用扩展不允许使用仅主应用能调用的私有API，所有被扩展链接的库都需要开启APPLICATION_EXTENSION_API_ONLY配置，手动修改Pod的构建设置会在下次执行pod install后被重置，所以需要通过CocoaPods的原生能力实现持久化配置，或者调整实现逻辑规避依赖。 #

方案1：通过Podfile的post_install钩子自动配置（推荐） #

直接在你的项目Podfile末尾添加以下代码，执行pod install后会自动给指定Pod设置对应的构建设置，不会因为后续更新Pod丢失配置：

post_install do |installer|
  installer.pods_project.targets.each do |target|
    # 仅针对需要在小组件中引用的Pod设置配置
    if target.name == 'Mapbox'
      target.build_configurations.each do |config|
        config.build_settings['APPLICATION_EXTENSION_API_ONLY'] = 'YES'
      end
    end
    # 如果小组件依赖的Pod较多，可以注释上面的判断，全局开启所有Pod的扩展API限制
    # target.build_configurations.each do |config|
    #   config.build_settings['APPLICATION_EXTENSION_API_ONLY'] = 'YES'
    # end
  end
end

注意事项 #

• 配置后请先确认你使用的Mapbox版本已经适配应用扩展场景，如果Mapbox内部调用了仅主应用可用的API，运行时会触发崩溃
• 建议升级到Mapbox最新稳定版，新版本已经官方适配应用扩展使用场景

方案2：小组件改用Mapbox静态快照（无配置冲突） #

如果Mapbox版本无法升级或者存在运行时兼容问题，可以完全规避在小组件中链接Mapbox库：

• 主应用侧或者小组件内部直接调用Mapbox的静态快照API生成指定区域、样式的地图图片
• 小组件直接渲染生成的静态图片即可，不需要引入Mapbox依赖

该方案优势：

• 完全不需要修改任何Pod配置，不会和主应用的Mapbox使用产生冲突
• 小组件加载性能更好，静态图片的资源消耗远低于实时渲染的地图视图
• 不会出现扩展API不兼容导致的运行时崩溃问题

内容的提问来源于stack exchange，提问作者pennyowe