本文主要介绍以下几个方面的内容:
一、利用pod命令行,创建一个开发sdk的工程,该工程既可以开发sdk代码,也可以同时编写测试代码,与sdk代码联调
二、将开发的sdk代码打包成静态库
三、正式使用打包好的.framework静态库
第一部分:开发并调试sdk代码
1、确定已安装cocoapods,打开命令行窗口,cd到你要创建工程的目录下,然后执行命令 pod lib create xxx(xxx是你的工程名字),过程中会有一个问题页面,可参考如下的填写:
命令执行完后,当前目录会出现如下的目录结构:
2、请打开Example目录下的.xcworkspace工程,重点关注红线标注的部分目录结构,这个是sdk开发和测试中会涉及到的文件和目录
4、上图中第3步中的文件夹,对应的物理目录是Classes目录,该目录下是开发sdk的代码。
我们在该目录下新增了两个文件,TestApiObject.h 和TestApiObject.m两个文件,其中TestApiObject.h是将来想暴漏给用户的头文件,这两个文件中任意新增一个接口测试用,如下:
-(void)testMethod{
NSLog(@"testMethod enter");
}
以上,我们sdk需要开发的代码已经完成,打包成framework后,我们可以通过TestApiObject类来访问testMethod这个接口。
5、接下来编辑huotiDetectionSdk.podspec这个文件,这个文件是关于sdk开发和打包的一些配置信息,具体每项的意义请参考下图:
在本文中的简单例子中,重点关注s.version/s.homepage/s.source/s.source_files/s.public_header_files, 并不是说其他字段不重要,而是随着项目的复杂程度的加深,慢慢再体会其它字段的用处更容易理解。接下来讲解这几个字段的值和作用(上图来自互联网,所以与本项目的名字对不上,但不影响理解)
s.version:只需要注意一点,与后面的git tag version号一样就行了,后面打包的时候会再讲解
s.homepage/s.source: 用于打包代码存放的路径,虽然这里可以是git路径,也可以是本地path路径,但是建议用git路径,这样便于代码管理和协作,因此再填写该路径之前,1)需要在git上创建一个版本库(github或者自己公司的git服务器),2)将本地的该sdk工程添加git管理(git init,git remote add origin xxx, git push origin master等,具体请搜索git相关知识),3)将该git远程库上的那个用于clone的地址拷贝出来,就可以作为s.homepage/s.source的值了。4)那么当打包静态库的时候,会自动从这个git地址上拉去代码,进行打包。
s.source_file: 该字段表示sdk的代码存放的相对路径,如这里配置的是Classes目录下,那么我们的sdk代码必须放在Classes目录下。
s.public_header_files: 是打包的静态库要暴漏出来的.h文件,需要根据自己的实际路径进行配置。
7、sdk代码写好了,打包配置也弄好了,接下来需要测试一下sdk代码有没有问题,也就是需要联调下了。这个时候就要用到Example for huotiDetectionSdk这个目录了,这个目录下面的代码是我们的测试代码。在某个ViewController中增加对sdk接口的调用,
这个时候会提示‘TestApiObject.h’这个头文件找不到,是因为我们少了一步,命令行下cd到Example目录下,执行pod install, 其中Podfile不需要做任何修改,与刚创建工程时自动生成的保持一致即可。执行完pod install之后,会发现 TestApiObject.h这个头文件可以正常引用了。
8、那么接下来,就是把测试工程跑起来了,跑起来大家都会,这里简单介绍下该workspace下的工程,1)如果是运行测试工程的话,需选中如下的target:
测试代码中需要做得相关配置,在上图的target下设置;那么如果是sdk代码里边需要做的一些相关配置呢?
2)sdk代码里需要做的相关配置,请选择如下的target:
9、测试代码跑起来之后,就可以单不调试等等,如果sdk代码已经调试无误,那么就进入到本文的第二部分,如何打包静态库吧。
第二部分:将开发的sdk代码打包成静态库
1、打包利用cocoapods-package 插件,所以需要先安装,命令行执行sudo gem install cocoapods-package,如果安装出错,请参考https://gems.ruby-china.com。
2、打包前先做一下验证,cd到工程所在的目录下,执行命令pod lib lint huotiDetectionSdk.podspec --verbose --use-libraries --allow-warnings,其中每个参数的意义不详细说了,因为别人说的更好,文章最后会给两个链接。
3、打包前先提交代码:
git add .
git commit -m '0.1.0'
git tag 0.1.0 (这里的tag号0.1.0必须与huotiDetectionSdk.podspec里边配置的s.version一致)
git push origin 0.1.0, 将本地的tag推送到远程库中
pod package huotiDetectionSdk.podspec --force --no-mangle(打包.framework的命令)
4、打包完成后在项目的Example同级目录下可以看到 huotiDetectionSdk-0.1.0的文件夹,这个里边即使打包好的Framework了,下图中只是作为目录展示,不包含打包好的sdk。
第三部分:正式使用打包好的Framework静态库
新建Xcode的single view App工程,将打包好的Framework拖到工程中,任意Viewcontroller中引用即可。
注:本文只是一个完整流程的简单入门,实际开发中情况比较复杂,但只要知道了整体的开发流程,那么其他的复杂问题,也可以通过各种调试解决的。
附上学习过程中参考的几篇文章:
https://www.jianshu.com/p/c32534076250
https://cloud.tencent.com/developer/article/1147879