【文末有惊喜!】利用Swift API可用性解决App Extension无法编译

  

本文字数：2832字

预计阅读时间：20分钟

目录

• 问题

• 探索
  

• 平台可用性

• API可用性

• #available

• 函数调用链

• 协议函数

• Objective-C函数API

• • 普通API

  • 重写系统方法的API

问题

从Xcode12.5开始，苹果要求所有的Extension Target必须设置APPLICATION_EXTENSION_API_ONLY为true，否则将会导致编译错误“Application extensions and any libraries they link to must be built with the APPLICATION_EXTENSION_API_ONLY build setting set to YES”；但是我们通常会在主工程和Extension之间使用Framework或其他方式共享代码，这些代码中使用了非extension-only API，所以导致问题出现，本篇文章将探讨如何解决这个问题。

探索

我们以一个具体的工程结构为例，如下图所示：

我们的主工程Host App中，创建了一个Share Extension的扩展Target做分享相关的操作；另外，为了模块化，我们有一个Library工程包含所有的基础组件和Fundation扩展方法，NetworkService工程包含网络请求相关的功能封装和处理，他们都被编译为Framework供主工程和Share Extension共同使用；

我们首先需要把Share Extension、Library、NetworkService这三个工程的Build Setting中APPLICATION_EXTENSION_API_ONLY设置为true；由于我们在Library和NetworkService中都使用了UIApplication.shared.open，UIApplication.shared.keyWindow这类非extension-only的API，所以编译这两个子工程是无法通过的。

首先想到的解决办法是代码拆分，我们可以把Library按是否使用extension-only API进行拆分，拆分成两个工程Libray和LibraryExtension，LibrayExtension中包含符合extension-only的API，提供给Share Extesnion使用；Library中包含其他不设限API，提供给主工程或其他非Extesnion工程使用；

然后NetworkService也采用相同方法进行改造，这种方式是可以解决问题的，但是除了拆分代码创建新工程的代价，也会带来很多额外的工作量；比如主工程中Host App，原来都是引用import Library，现在就需要逐个修改确认，是使用Libray还是LibraryExtension，或者添加同时引用两个，这对于一个已有的大工程来说，是一个不小的工作量；

另外，笔者在搜索这个问题的解决方式时，发现swift-cast网站作者提供了一个另外的解决方案：使用ACTION_EXTENSION；如果你的App恰好使用的是Action Extension可以采用这个方式去尝试：

#if !ACTION_EXTENSION
    //codes that don't obey extension-only API requests
#else
    //normal codes 
#endif 

显然，上面的两种方式都有各自的局限性，所以我们需要寻找更加广泛使用的解决方案，改动更小的解决方案；Swift语言提供了API可用性的标识，这个功能能够解决我们所遇到的问题，下面我们先来了解一下Swift的API可用性。

Swift的API可用性（API availability）

在Swift中使用@available可以标记API的可用性信息，比如是否API在某个版本被废弃，这个API需要的Swift版本大于5.4才能使用，等等。我们来看几个具体方面：

平台可用性

@available(iOS 13.0, OSX 10.15, *)
@available(tvOS, unavailable)
@available(watchOS, unavailable)
public struct SearchField: View{
    ...
}

在SwiftUI中我们定义一个SearchField组件，就需要对其适用的平台和系统版本进行限制，上面这段代码表明，SearchField适用于大于等于iOS13或OSX 10.15版本，同时针对tvOS和watchOS都是不可用的。

具体注释定义如下：

@available(platform version , platform version ..., *)

• platform：指定具体适用的平台，比如iOS, macCatalyst, macOS/OSX, tvOS 或者 watchOS，还可以指定适用的扩展Extension Target，比如ApplicationExtension或macOSApplicationExtension，这是解决文章开头提出的问题的重要工具，这部分稍后将详细介绍；

• version：具体的数字，可以由一位、两位或三位正整数通过点号（.）分割组成，分别代表主版本号，次版本号，补丁版本号；

• 可以有多个platform+version组成，之间用逗号分隔（,），比如@available(iOS 13.0, OSX 10.15, *)；

• 星号(*)，表示该API可用于所有其他平台。为了处理潜在的未来平台，平台可用性注释总是需要一个星号；

API可用性