使用CocoaPods打包静态库制作SDK步骤

制作SDK,使用.a或.framwork的方式封装SDK,然后放在github上,以及需要支持cocoapods方式.本文参考Bryce Zhang大神的文章来讲一下我的打包制作过程,以及遇到的坑,希望对正在进行SDK开发的新手一些帮助.大致先讲下流程,首先创建一个本地的库用于开发,然后打包.framwork,重新制作一个库用于上传到github上去.当然如果是个人的库,我还是不建议大家打包静态库,毕竟开源才是程序员精神.

首先需要讲下为什么需要使用CocoaPods打包静态库,因为cocoapods支持一键打包(夸张了^_),也支持解决在开发SDK过程中使用第三方库冲突的问题,不用再像传统制作方式一样修改所有第三方库的方法名了.

1.使用pod创建开发库

执行命令 pod lib create MAPalyer.再此期间需要确认下面5个问题.

   What language do you want to use?? [ Swift / ObjC ]
   ObjC
   Would you like to include a demo application with your library? [ Yes / No ]
   yes
   Which testing frameworks will you use? [ Specta / Kiwi / None ]
   Kiwi
   Would you like to do view based testing? [ Yes / No ]
   No
   What is your class prefix?// 类的前缀
   MA

此时,就会创建一个pod的标准模板工程.

创建pod库

3.添加开发代码

打开MaPlayer/Example/MAPlayer.xcworkspace,在Pods/Development Pods/MAPlayer下添加SDK代码.并提交git管理.

git add.
git commit -m "First commit"
git tag 1.0

4.打开MAPlayer.podspec文件查看类库配置信息.

    Pod::Spec.new do |s|
    s.name             = 'MAPlayer' // 库的名称
    s.version          = '1.0'  // 库的版本号
    s.summary          = 'A short description of MAPlayer.' // 库的简单描述
    s.description      = <<-DESC // 库的详细描述
    TODO: Add long description of the pod here.
    DESC

    s.homepage         = 'https://github.com//MAPlayer' // github上的地址,这个可以不管,因为咱们用的是本地的

    # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2' // 这个我没有使用
    s.license          = { :type => 'MIT', :file => 'LICENSE' } // MIT协议,已经创建好了,不用管
    s.author           = { 'fengyunjue' => '[email protected]' } // 开发者信息
    // 库的来源,可以使用git,bitbucket或本地s.source           =  { :git => 'MAPlayer/MAPlayer.git', :tag => s.version.to_s } // 本地来源的写法
   s.source          = { :git => 'https://github.com/[email protected]/MAPlayer.git', :tag => s.version.to_s } // git来源的写法
    # s.social_media_url = 'https://twitter.com/'

    s.ios.deployment_target = '8.0' // 库的版本

    s.source_files = 'MAPlayer/Classes/**/*' // 库的所有有文件
   // 这个是库的图片集合,他会将所有的图片打包成bundle使用,  #标示等同于xcode里的//功能
    # s.resource_bundles = { 
    // 这里是设置图片bundle名称为"MAPlayer.bundle" , '*.png'是匹配所有的png格式的图片,你也可以使用''MAPlayer/Assets/*',
    匹配Assets下的所有文件,也可以单独设置图片[..../1.png,..../2.jpg]
    #   'MAPlayer' => ['MAPlayer/Assets/*.png'] 
    # 'image' => ['..../*']     // 这样相当于有设置了一个bundle
    # }
    // 注意:制作framwork,公开的头文件里如果import了其他文件,比如a.h里包含了b.h,则b.h也必须加入到public_header_files里
    # s.public_header_files = 'Pod/Classes/**/*.h' 
    // 依赖项不仅要包含你自己类库的依赖，还要包括所有第三方类库的依赖,例如FMDB,就需要依赖sqlite3
    #s.frameworks = 'UIKit', 'MapKit'
    #s.libraries = 'sqlite3'
    // 支持依赖第三方静态库
    #s.vendored_library    = '**/libopencore-amrnb.a'
    // 依赖的第三方库
    #s.dependency 'AFNetworking', '~> 2.3'
    #s.dependency 'FMDB'
    end

podspec文件的详细说明可以看Podspec Syntax Reference.

• s.public_header_files很重要,需要将你要公开的头文件放进去,使用相对路径即可.如果公开的头文件里如果import了其他文件,比如a.h里包含了b.h,则b.h也必须加入到public_header_files里. 可以分开写,如'Pod/Classes/Test/*.h','Pod/Classes/Test1/Test1.h'.
• 修改SDK的版本号与你git的tag一致

5.使用CocoaPods Packager打包静态库

1.使用sudo gem install cocoapods-packager安装CocoaPods Packager,查看cocoapods-packager.

安装CocoaPods Packager

2.使用 pod lib lint MAPlayer.podspec --no-clean --verbose --allow-warnings检测创建的库是否符合pod的要求.符合要求会提示 MAPlayer passed validation.

检测pod成功

3.打包静态库
使用 pod package MAPlayer.podspec --force打包静态库.
此时会提示下图的错误.

Jietu20171115-121845.png

这是因为没有找到这个source.你可以将该项目提交到GitHub上管理.
需要处理MAPlayer.podspec里的source.

// git地址修改为正确的GitHub地址
s.source = { :git => 'https://github.com/[email protected]/MAPlayer.git', :tag => s.version.to_s }

或者将地址修改成本地的git

// 注意,这里只能使用绝对地址
s.source = { :git => '/Users/admin/Documents/WorkSpace/MAPlayer', :tag => s.version.to_s }

此时会在MAPlayer/生成MAPlayer-1.0.静态库制作完成.

注意事项

• 如果SDK的1.0版本制作完成后发现需要修改代码后重新制作1.0,需要先清除本地缓存的版本pod cache clean MAPlayer,否则,重新打包的还是旧的代码.
• CocoaPods Packager解决第三方库冲突的方式是通过给所有第三方库的方法添加前缀的方式处理,如MAPlayer添加的是步骤一里设置的MA前缀.注意尽量不要添加含有Category的开源库,因为CocoaPods Packager没有修改Category的前缀,虽然不会造成冲突,但会覆盖类的相同方法.
• 如果静态库中含有Category,在使用静态库时需要在Build Seings/Other Linker Flags里添加-ObjC,否则编译会报错.
• pod package MAPlayer.podspec --force打包成.framework静态库,--fore指强制覆盖已经制作的静态库
  pod package MAPlayer.podspec --library --force打包.a静态库.需要注意的是,打包.a只生成了.a文件,头文件需要自己添加,这应该算CocoaPods Packager的一个bug.