进阶-私有库创建

作者: coderPoo | 来源:发表于2018-09-04 16:59 被阅读23次

    4.私有库创建

    创建私有 Spec Repo

    Spec Repo介绍

    Spec Repo是所有的Pods的一个索引,就是一个容器,所有公开的Pods都在这个里面,它实际是一个远端的Git仓库,当你使用了Cocoapods后它会被clone到本地的~/.cocoapods/repos目录下,可以进入到这个目录看到master文件夹就是这个官方的Spec Repo了。这个master目录的结构是这个样子的

    .
    ├── Specs
        └── [SPEC_NAME]
            └── [VERSION]
                └── [SPEC_NAME].podspec
    

    创建Sepc Repo

    在GitLab上创建一个名称叫<font color=red>ios_specs</font>的仓库,然后执行命令,在本地~/.cocoapods/repos目录下会创建一个<font color=red>ios_specs</font>的文件夹,如下:

    $ pod repo add ios_specs http://git@github.com:coderPoo/XBMarsSDK.git
    

    创建Pod项目工程

    当我们需要自定义一个组件的时候,可以用CocoaPods提供的一个命令来创建,相应的命令如下:

    $ pod lib create <项目名称>
    

    命令执行后会有一些问题,需要你操作,如下

    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 ]
     > None
    
    Would you like to do view based testing? [ Yes / No ]
     > No
    
    What is your class prefix?
     > XB
    

    当你回答完问题后,项目工程就自动创建好并且打开了。

    问题

    有时,当我们创建工程会报如下错误:

    /Users/targetcloud/.rvm/rubies/ruby-2.3.0/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:120:in `require': cannot load such file -- colored2 (LoadError)
    from /Users/targetcloud/.rvm/rubies/ruby-2.3.0/lib/ruby/site_ruby/2.3.0/rubygems/core_ext/kernel_require.rb:120:in `require'
    

    解决方法:重新安装colored2,命令如下:

    $ gem uninstall colored2
    $ gem install colored2
    

    编辑Pod项目工程

    Classes目录

    我们编写代码的类文件都放在Classes目录下,并且在podspec文件中有相应的配置片段:

    s.source_files = 'XBPodSDK/Classes/**/*'   //工程源文件
    

    Resources目录

    需要往工程中添加资源的话,请按照如下步骤:

    1. 配置podspec文件中有关资源的片段,去掉注释,如下:

       s.resource_bundles = {       //工程资源文件
       'XBPodSDK' => ['XBPodSDK/Assets/**/*']
       }
      
    2. 在工程目录->Assets目录下创建一个文件夹,比如放图片的文件夹images

    3. 执行pod install命令

    4. 代码中获取资源的Bundle,可以写一个NSBundle的Category,如下:

       @implementation NSBundle (MyLibrary)
       + (NSBundle *)my_myLibraryBundle {
           return [self bundleWithPath:[self my_myLibraryBundleURL]];
       }
       + (NSURL *)my_myLibraryBundleURL {
           return [[NSBundle mainBundle] pathForResource:@"XBPodSDK" ofType:@"bundle"]
       }
       @end
      

    头文件的暴露和隐藏

    在Classes目录下的Header文件,我们尽可能少的暴露给用户,所以header文件就需要分别配置成public和private两种,这个需要在podspec文件中配置,如下:

    s.public_header_files = 'CHLib/Classes/**/*.h'
    s.private_header_files = 'CHLib/Classes/Internal/*.h'
    

    其中Internal目录是在Classes文件夹下,用于存在private的头文件

    库添加子分支

    库可以根据不同的模块创建不同的子分支,使用时Podfile文件中可以指定只需要加载哪些模块,具体操作步骤如下:

    1. 在Classes目录下创建对应模块的子目录

    2. 在podspec文件中使用subsepc特性,如下:

       s.subspec 'NetWorkEngine' do |networkEngine|
         networkEngine.source_files = 'Pod/Classes/NetworkEngine/**/*'
         networkEngine.public_header_files = 'Pod/Classes/NetworkEngine/**/*.h'
         networkEngine.dependency 'AFNetworking', '~> 2.3'
       end
      
       s.subspec 'DataModel' do |dataModel|
         dataModel.source_files = 'Pod/Classes/DataModel/**/*'
         dataModel.public_header_files = 'Pod/Classes/DataModel/**/*.h'
       end
      
    3. 在Podfile文件中指定要加载哪些模块,如下:

       pod 'YOUR_SPEC', :subspecs => ['IDFA', 'IDFB']
      

    Demo工程

    当我们写好了组件,需要测试的时候,可以在Demo工程中根据测试用例写几个Demo,重要的是还需要编辑Podfile文件(编辑Podfile)。

    提交Pod项目工程

    remote 源文件

    通过Cocoapods创建出来的目录本身就在本地的Git管理下,我们需要做的就是给它添加远端仓库,进入工程目录下,执行如下命令:

    $ git add .
    $ git commit -m "Initial Commit of Library"
    $ git remote add origin git@github.com:coderPoo/XBPodSDK.git
    $ git push origin master
    

    <font color=red>注意:需要提交的文件包括:Classes目录、Resources目录和Demo工程目录下的文件、Podfile文件、Podfile.lock文件。不需要提交Pods/下的文件(技巧:可以修改.gitignore文件,打开Pods/的注释)</font>

    打tag

    因为podspec文件中获取Git版本控制的项目还需要tag号,所以我们要打上一个tag,如下:

    $ git tag -m "first release" -a 1.0.0
    $ git push origin 1.0.0
    

    配置podspec文件

    在创建好的Pod项目工程下,存在一个以工程名命名的podspec文件,podspec文件格式如下:

    Pod::Spec.new do |s|
      s.name             = 'XBPodSDK'    //工程名
      s.version          = '1.0.3'         //工程version
      s.summary          = 'Login SDK'     //工程摘要
      s.description      = "登录组件"       //工程描述
      s.homepage         = 'https://github.com/coderPoo'      
      s.license          = { :type => 'MIT', :file => 'LICENSE' }
      s.author           = { 'coderPoo' => 'email.@qq.con' }
      s.source           = { :git => 'https://github.com/coderPoo/XBPodSDK.git', :tag => s.version.to_s }  //tag的version要与工程version一致
    
      s.ios.deployment_target = '7.0'    //工程target支持的最低系统版本
    
      s.source_files = 'XBPodSDK/Classes/**/*'   //工程源文件
      
      s.resource_bundles = {       //工程资源文件
        'XBPodSDK' => ['XBPodSDK/Assets/*.*']
      }
    
      s.public_header_files = 'XBPodSDK/Classes/**/*.h'   //工程公有头文件
      s.frameworks = 'UIKit'        //工程依赖的frameworks
      s.dependency 'AFNetwork'        //工程依赖的第三方库
    end
    

    以上是podspec文件的部分格式,详细的配置请参考:podspec参考

    验证podspec文件

    编辑完podspec文件后,需要验证一下这个文件是否可用,如果有任何Warning或者error都是不可以的,它就不能被添加到Spec Repo中,不过Xcode的warning是可以存在的,验证需要执行一下命令:

    $ pod lib lint
    

    当看到

    -> XBPodSDK (1.0.3)
    XBPodSDK passed validation.
    

    时,说明验证通过了,不过这只是这个podspec文件是合格的,不一定说明这个Pod是可以用的,我们需要再本地做一下验证

    本地测试podspec文件

    我们可以创建一个新的项目,在这个项目的Podfile文件中直接指定刚才创建编辑好的podspec文件,看是否可用。在Podfile中我们可以这样编辑,有两种方式

    platform :ios, '7.0'
    

    然后执行pod install命令安装依赖,打开项目工程,可以看到库文件都被加载到Pods子项目中了,不过它们并没有在Pods目录下,而是跟测试项目一样存在于Development Pods/XBPodSDK中,这是因为我们是在本地测试,而没有把podspec文件添加到Spec Repo中的缘故。

    在项目中编写代码,测试库文件无误后就可以开始下一步了,提交podspec到Spec Repo中

    提交podspec到Spec Repo

    向Spec Repo提交podspec文件需要完成两点,一个是podspec必须通过验证无误,再一个就是删除无用的注释(为了规范),提交podspec文件需要一个命令:

    $ pod repo push ios_specs XBPodSDK --allow-warnings --verbose --use-libraries --sources=https://github.com/CocoaPods/Specs
    

    完成之后这个组件库就添加到我们私有的Spec Repo中了,可以进入到~/.cocoapods/repos/ios_specs目录下查看,在我们的Spec Repo远端仓库也有了一次提交。至此,我们整个组件库就已经制作完成了。
    上面命令中的XBPodSDK是你具体需要提交的podspec文件

    备注

    为了解决每次提交podspec文件都需要输入很长命令的问题,本人写了一个shell脚本名字叫pod.sh:

    #!/bin/bash
    
    pod repo push ios_specs $1 --allow-warnings --verbose --use-libraries --sources=https://github.com/CocoaPods/Specs
    
    1. 在自己的电脑中创建一个bin文件夹(一般放到Home目录下),把pod.sh放到bin文件夹下

    2. 修改pod.sh权限,添加执行权限

       $ chmod 755 pod.sh
      
    3. 修改环境变量,在打开~/.bash_profile文件,添加

       export PATH=$HOME/bin/:$PATH
      
    4. 使得环境变量生效,输入命令:

       $ source ~/.bash_profile
      
    5. 脚本使用:

       $ pod.sh xxxx.podspec
      

    说明

    1. 工程中podfile文件第三方库指定版本号不要用“~>”,而是要指定明确版本,例如:

       pod 'XBPodSDK', '1.4'
      
    2. 自定义的组件要保证demo可用

    3. pod update 要明确指定库的名称,例如:

       pod update XBPodSDK
      
    4. 某个版本代码出错了,需要把这个tag给删除了,废弃这个版本,新的代码版本+1,并通知大家

    相关文章

      网友评论

        本文标题:进阶-私有库创建

        本文链接:https://www.haomeiwen.com/subject/rtlgwftx.html