我的开放源代码项目的Xcode项目结构

最近,我决定将一些自定义的iOS控件开源。 因此,我启动了Xcode,选择“ Create a new Xcode project ”,然后陷入困境……我应该选择哪个项目模板? 我必须将自定义控件设置为Cocoa Touch Framework,但与此同时,我还需要一个示例应用程序进行测试,以及在发布到Github之后展示我的自定义控件。

显然,我们可以使用CocoaPods命令: pod lib create生成具有适当结构的Xcode项目,并立即开始进行处理。 但是,我希望对项目结构具有更大的灵活性和更多的控制权,因此我决定手动设置自己的项目。

经过一番研究和反复试验,我得出了一个适合任何开源项目的项目结构。 因此,我想与任何有兴趣的人分享这一点,希望这可以为计划开始其第一个开源项目的其他开发人员提供一个良好的起点。 😃

让我们开始创建所需的Xcode项目。 第一个项目将是包含所有开源项目源代码的项目。 确保选择“ Cocoa Touch Framework ”作为所需项目模板。 出于演示目的,让我们将项目命名为“ MyOpenSource ”。

为开源项目源代码完成项目创建后,您将需要为示例应用程序创建另一个项目。 这次选择“ 单一视图应用程序 ”作为项目模板,并将其命名为“ MyOpenSourceExample

现在,您应该能够看到已经创建了两个Xcode项目。

双击MyOpenSourceExample.xcodeproj以启动示例项目,然后将MyOpenSource.xcodeproj从finder中拖到示例项目中,如下面的屏幕快照所示。

Xcode将提示您将示例项目保存在新的工作区中。 什么是工作区? 根据Apple文档:

工作区是将项目和其他文档分组的Xcode文档,因此您可以一起使用它们。

点击“ 保存 ”继续。 将工作区命名为MyOpenSourceExample并将其保存在根文件夹中。

现在,您可以关闭示例项目并启动刚刚保存的工作区。 注意,Xcode现在在项目导航器中同时显示MyOpenSourceMyOpenSourceExample

为了使MyOpenSourceExample能够访问MyOpenSource的代码,您必须将MyOpenSource框架链接到示例项目。

在项目导航器中选择MyOpenSourceExample ,然后打开“ Build Phases ”选项卡。 展开“ 使用库链接二进制文件 ”部分,单击“ + ”,然后选择MyOpenSource.framework

之后,打开“ 常规 ”选项卡,展开“ 嵌入式二进制文件 ”部分,单击“ + ”, MyOpenSource.frameworkMyOpenSource项目中选择MyOpenSource.framework

最后,检查您是否正确链接了框架:

  1. 生成MyOpenSourceExample项目。
  2. import MyOpenSource添加到import MyOpenSourceAppDelegate.swift中。
  3. 再次生成MyOpenSourceExample项目。

如果项目能够正确构建,则意味着您已经正确设置了项目。 ✅

而已! 现在,工作空间已准备就绪,您可以开始将代码添加到开源项目中,并使用示例项目测试开源框架。

感谢您抽出宝贵的时间阅读本文,希望它可以帮助您开始第一个开源项目。 我对所有开放源代码项目都使用了此项目结构,如果您有兴趣,可以随时签出KSNumericTextFieldKSFacebookButtonKSImageCarousel

如果您喜欢本文,请确保单击hit按钮。 随时在下面发表您的评论或问题。

对于那些感兴趣的人,这是我的LinkedIn 推特