Carthage

晓之卫
511 阅读7分钟

1、Carthage介绍

具体使用，可以查看官网的，文档地址 github.com/Carthage/Ca…。如果看不懂英文，可以看一下官文的翻译：www.jianshu.com/p/e0c0ceee8… 。

为什么使用Carthage，具体对比CocoaPods有什么优势，还有安装过程，请都参照官网的操作

1.1、与CocoaPods的区别

  1. 去中心化：CocoaPods有一个中心库，第三方库需要收录到中心库中去管理；Carthage则是从 GitHub 或 git 库中下载
  2. 非侵入性：CocoaPods下载三方库后，会将其编译成静态链接库或动态框架文件，并同时修改Xcode项目属性配置依赖关系；Carthage不会修改Xcode项目属性

2、让你的项目支持Carthage

% brew update
% brew install carthage

2.1、配置项目

2.1.1、创建framework

在已有的工程上，新建一个Target，项目-> File -> New -> Target，选择Framework ，命名为 CarthageTest

 

他会自带一个CarthageTestSDK.h的文件,这个文件的作用是告诉其他人我们引用了哪些头文件,我们不要它自动生成的文件,删除CarthageTestSDK.h

2.1.2、配置你的framework
  1. 选择你的工程
  2. 选择framework所在的Target
  3. 选择Build Phases
  4. 点击Header左下角的+号把你要暴露的头文件添加到Public里面（默认添加到Project里面，用鼠标把它拽过去）
  5. 在Compile source里面添加实现的.m文件

2.1.3、修改framework的Deployment Target 

改为和项目工程一样的支持版本，我这边是8.0。 一定要注意这里，要不然，编译会报错，当编译不报错时，低版本的系统会安装不了。报错类似：

ERROR: Install failed. Got error "ApplicationVerificationFailed" with code 0xe8008019: Failed to verify code signature of /private/var/installd/Library/Caches/com.apple.mobile.installd.staging/temp.xY9xAg/extracted/Payload/Spec.app/Frameworks/MGLiveDetect.framework : 0xe8008019 (The application does not have a valid signature.)Build step 'Execute shell' marked build as failureFinished: FAILURE

2.1.4、更改framework的名字

不需要更改可以直接忽略，项目Target -> Build Setting -> Product Module Name / Produce Name ，改成 CarthageTestSDK

2.1.5、配置类别和支持Bitcode
  • 如果你使用了Category，那么你需要在 Build Settings 的 Linking 的 Other Linker Flags 里加上 -all_load
  • 如果你想你的工程支持bitcode，需要在 Other C Flags 里加上-fembed-bitcode

　　以上都不需要，可以忽略这一步，跳到第5步

2.1.6、分享你的工程

选择 Manager Schemes，给CarthageTestSDK勾上shared  

2.2、本地验证

到这里，基本上你已经成功了，那么我们来验证一下，我们cd到项目文件夹，运行

$ carthage build --no-skip-current

命令运行完成后，你会发现你的项目文件夹里面多了一个Carthage文件夹

1Carthage->Build->iOS->CarthageTestSDK.framework

这个就是我们需要的framework了，那么接下来，我们在本地验证一下。

2.2.1、把framework拖进工程中，点击copy

2.2.2、添加动态库

target -> Build Phases -> 左上角+号 -> New Copy Files Phase，然后在Copy Files下 Destination 选择 Frameworks -> 添加你自己的动态库

2.2.3、测试验证成功

我们首先编译一下,没报错，导入头文件，正常输出，编译成功。验证成功

2.2.4、发布并打上Tag

将代码上传到git上面，Carthage -> Build 目录是不需要上传的

git tag 0.1.0
git push --tags

至此你的库已经支持 Carthage 了，可以让其他开发者使用 Carthage 来管理你的项目依赖了

3、使用Carthage

  1. 先进入到项目所在的文件夹

    $ cd 项目路径

  2. 创建一个空的Carthage文件

    $ touch Cartfile

  3. 编辑cartfile文件，添加要依赖的框架

    // 路径方式
github "https://github.com/AFNetworking/AFNetworking" ~> 1.1.9

    // 库名称方式: "用户名/库名" ~> "版本号"
github "Alamofire/Alamofire"
github "onevcat/Kingfisher"
github "nixzhu/MonKeyKing"
github "SwiftyJSON/SwiftyJSON" ~> 4.0
github "SnapKit/SnapKit" ~> 5.0.0

  4. 保存并关闭cartfile文件，进行安装

    $ carthage update --no-use-binaries --platform ios

    --platform ios ：限定只有iOS平台

    安装完之后根目录会出现一个叫Carthage的文件夹，里面包含 Build 和 Checkouts 两个文件夹。

    • Build：iOS路径下的就是framework包，需要自行引用进来。

    • Checkouts：是从Github上获取来的源码，所以理论上来说你在这个文件夹里对源码进行任何的修改，再次执行 carthage build 就会根据这里的源码打包出相应的framework出来。但需要注意的是当每次执行carthage update后这里的源码又被覆盖了。所以你有特别需要修改的地方可以加例外防止覆盖!!! 重要

  5. 项目配置：因为Carthage的非侵入性特点，我们需要自己进行项目配置

    • 项目Target -> Build Setting -> Search Paths -> Framework Search Paths添加（这一步，感觉【carthage update】之后，默认会有了，有的话跳到第6步）

      $(PROJECT_DIR)/Carthage/Build/iOS

  6. 项目Target -> General 最底下的 Linked Frameworks and Libraries里手动添加【Add Other...】需要用的framework

  7. 项目Target -> Build Phases -> '+' -> New Run Script Phase，添加脚本（这一步可以不操作，直接操作第8步；第7步和第8步只需要操作其中一步就可以了）

    /usr/local/bin/Carthage copy-frameworks

  • 同时要注意，添加input Files，如：

    $(SRCROOT)/Carthage/Build/iOS/AFNetworking.framework

  • 如果不添加 input Files，会报 dyld: Library not loaded 出错

  1. (第7步操作的，这一步跳过)不想通过脚本并且 input Files 的方式添加路径的话，可以通过Copy File的方式来添加，项目Target -> Build Phases -> '+' -> New Copy File Phase，添加Copy文件

4、第三方静态库转为动态库

由于动态库不会增加ipa的包大小，因而将第三方的静态库转为动态库也是很有必要的。下面就腾讯的人脸识别SDK做验证。官网文档：cloud.tencent.com/document/pr…。

需要SDK的话，可以直接找腾讯的相关人员拿。我拿到sdk包（iOS_OCR_SDK_V2.2.0），是可以直接跑起来，相关代码结构如下：

以下的步骤，和上面【让你的项目支持Carthage】差不多，具体配图看上面。

4.1、创建Framework

在已有的工程上，新建一个Target。项目-> File -> New -> Target , 选择Framework ，命名为 WBOCRFramework ，并删除创建多出来的 WBOCRFramework.h

4.2、将SDK的头文件公布出来

将 WBOCRService.framework 的头文件拉出来，放在libs文件夹里面，注意，虽然是拉了出来，但文件的路径是和原来一样的。

      

4.3、配置你的framework

  1. 选择你的工程
  2. 选择framework所在的Target
  3. 选择Build Phases
  4. 点击Header左下角的+号把你要暴露的头文件添加到Public里面（默认添加到Project里面，用鼠标把它拽过去）
  5. 在Compile source里面添加实现的.m文件。由于没有.m文件，可以直接忽略掉
  6. 在Link Binary With Libraries 中，将libs的文件全部增加进去，同时，还需要将所有依赖的系统framework也增加进去。

4.4、修改framework的Deployment Target 

改为和项目工程一样的支持版本，我这边是8.0。 一定要注意这里，要不然，编译会报错，当编译不报错时，低版本的系统会安装不了。报错类似：

ERROR: Install failed. Got error "ApplicationVerificationFailed" with code 0xe8008019: Failed to verify code signature of /private/var/installd/Library/Caches/com.apple.mobile.installd.staging/temp.xY9xAg/extracted/Payload/Spec.app/Frameworks/MGLiveDetect.framework : 0xe8008019 (The application does not have a valid signature.)Build step 'Execute shell' marked build as failureFinished: FAILURE

4.5、更改framework的名字

不需要更改可以直接忽略。项目Target -> Build Setting -> Product Module Name/Produce Name ，改成 WBOCR

4.6、配置类别和支持Bitcode

  • 在Build Settings的Linking的Other Linker Flags里加上 -all_load
  • 工程需要支持bitcode，需要在Other C Flags 里加上 -fembed-bitcode

4.7、分享你的工程

选择 Manager Schemes，给WBOCRFrame勾上shared

4.8、生成framework并验证 

到这里，基本上你已经成功了，那么我们来验证一下，我们cd到项目文件夹，运行

$ carthage build --no-skip-current

但是，我们发现，报错了。在终端上，会告诉我们，报错的日志输出在哪里

接下来，我们前往报错的日志，通过查看日志，是因为librecdetect.a文件需要支持Bitcode。

最简单的解决方法，就是开启BitCode，如下图：

命令运行完成后，你会发现你的项目文件夹里面多了一个Carthage文件夹，这个就是我们需要的framework了，那么接下来，我们在本地验证一下。参照上面【让你的项目支持Carthage】的步骤。

4.9、存在的问题

Bundle图片资源不见了

使用动态库跑起来之后，我们发现，界面的图片资源不见了，我们在打动态库的时候，明明已经加了WBOCRService.bundle。通过代码验证分析，原来是SDK加载图片，写死了是从根目录读取，写法如：

但我们打包成动态库之后，Bundle文件已经不在根目录了，根本就找不到。

通过查资料，参照一下github上的开源库MJRefresh（github.com/CoderMJLee/…）的写法，先读取存在类的Bundle路径，再找到图片的路径。这样，不管封装多少层，bundle图片资源都不会丢失。

我们可以写在一个NSBundle的分类里，写法如下：

 目前，通过和腾讯的人沟通，资源包的问题已经解决，解决方案如下：

SDK里面对资源bundle加了一个判断：

  1. main bundle 下是否存在WBOCRService.bundle，存在就直接使用

  2. 如果1找不到，就会到SDK可执行文件对应的目录下面去找WBOCRService.bundle

如果是动态库集成，资源就会位于第二个位置，但是要注意的是，在做动态库的时候，一定要把资源bundle加进去

碰到的问题

dyld: Library not loaded 出错

dyld: Library not loaded: @rpath/CarthageTestSDK.framework/CarthageTestSDK

Referenced from: /Users/vipshop/Library/Developer/CoreSimulator/Devices/948C970C-2338-4BCB-A62D-E28A71C7A47B/data/Containers/Bundle/Application/AB8C53FC-9779-44EA-8E23-23E1E63C6E89/PodTest.app/PodTest

Reason: image not found

注意，Copy File 默认是Resources，需要改为framework

avatar
文章
阅读
粉丝
相关推荐
通过 Carthage 和 CocoaPods 为 iOS、watchOS 和 tvOS 创建跨平台
1.4k阅读
 · 
0点赞
iOS - Carthage
1.9k阅读
 · 
0点赞
Carthage安装、使用及常见问题解决教程
3.8k阅读
 · 
4点赞
解决Carthage疑难问题的思考过程
1.5k阅读
 · 
4点赞
使用Carthage发布自己创建的Framework并使用
1.1k阅读
 · 
1点赞
[译] 在 iOS 上使用 Carthage 建立依赖
8.3k阅读
 · 
5点赞