使自己的iOS开源项目支持Carthage

CarthageCocoaPods是目前业界广泛使用的两个依赖管理工具,几乎所有的知名开源项目,都会选择同时支持这两种工具。这两天在将自己的一个开源项目支持Carthage的过程中,对此工具有了更深的理解,在此记录一下过程和遇到的一些小坑。

原理

Carthage的工作原理和步骤如下:

  • 通过Cartfile的内容,去指定的源码仓库,拉取指定的版本的代码。
    拉取指定版本是通过Tag这一功能,所以需要对源码仓库打上Tag。除非在Cartfile里指定版本为"master",这时会取最新代码。
  • 代码拉取后存放在Carthage/Checkouts目录。遍历仓库中的xcodeproj文件,查找出类型为Cocoa Touch Framework(动态库),且scheme为Shared的target,进行编译。
  • 生成动态库,位置在Carthage/Build/iOS目录。

由于iOS是从8.0才开始支持动态库,所以如果要在项目中使用Carthage管理第三方库的依赖,那么要求你的项目的deployment target必须大于等于8.0。

对自己的开源项目添加Carthage支持

明白了上述原理,那么要想使我们自己的开源项目支持Carthage,那么其实也很简单,步骤如下:

1. 创建framework target

在已有的Xcode工程里,添加一个target,创建的时候选择类型为Cocoa Touch Framework,在弹出的界面中填写Product Name, Embed in Application选None。
Product Name应该填开源项目的名字,例如AFNetworking, SDWebImage这样的。target创建以后,会产生一个umbrella header file,名字和Product Name完全一样。


WechatIMG3.jpeg

2.编辑umbrella header file

在这个文件里,import所有public的头文件。

3.配置framework target

选择 framework target,选中Build Phases,将所有的.m文件拖拽到Compile sources 里面。
注意:
如果使用了Category,那么你需要在Build Settings的Linking的Other Linker Flags里加上-all_load
如果工程支持bitcode,需要在Other C Flags 里加上-fembed-bitcode

4.设置framework target的scheme为Shared

进入到Manage Schemes...里面,勾选Shared复选框。


WechatIMG4.jpeg

5.本地验证framework target

在终端里,键入carthage build --no-skip-current,对framework target进行build,此过程能够验证配置是否有误。
执行结果会保存在工程的 Carthage/Build 文件夹下。
如果没有任何错误信息,那么说明配置是正确的。

6.对仓库打tag

第5步中,验证完没有问题,就可以提交代码,然后打tag,例如1.0.0。

至此,你的开源项目就完美支持Carthage了。可以新建一个测试工程,再次验证。

遇到的一些问题

在配置的过程中,可能遇到如下问题,附解决办法。

  • Dependency "xxx" has no shared framework schemes for any of the platforms: iOS
    在carthage update 时,如遇到错误提示Dependency "xxx" has no shared framework schemes 说明工程的scheme没有被标记为shared,原因可能是git忽略了对应的工程文件。检查gitignore
    确保此文件未被忽略 xxx.xcodeproj/xcshareddata/xcschemes/xxx.xcscheme

  • Failed to read file or folder
    如果遇到如下的错误:
    Failed to read file or folder at /Users/sulirong/Library/Developer/Xcode/DerivedData/xxx-bcpyggvdymcfpsfaqhmhaddmjptp/Build/Products/Release-iphoneos/xxx.framework,是因为framework target的Info.plist文件中,缺少了CFBundleExecutable这一项,添加上,设为$(EXECUTABLE_NAME)。

  • 使用@import导入三方库时,有警告,说umbrella header file中没有import某些头文件
    这是因为在制作framework target时不太规范,没有使用umbrella header file来导入所有public的头文件。
    但如果使用普通的import方式,则也不会有此警告。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,362评论 5 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,330评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,247评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,560评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,580评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,569评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,929评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,587评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,840评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,596评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,678评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,366评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,945评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,929评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,165评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,271评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,403评论 2 342

推荐阅读更多精彩内容