制作自己的带有Example工程的CocoaPods

作者: Shaw1211 | 来源:发表于2019-04-08 15:56 被阅读4次

    一、创建github仓库

    步骤1 创建新仓库

    15547098780565.jpg

    这里我们设置仓库为公开的。

    步骤2 新建一个文件夹,将我们刚才在github上创建的库clone下来

    git clone https://github.com/Shaw003/PrivatePodDemo.git
    

    可以看到如下的目录结构


    15546889925231.jpg

    步骤3 创建Pod本地库。

    #该命令会从github上CocoaPods的库中下载一个pod模版
    #这里笔者创建了一个名为PrivatePodDemo的Pod库
    pod lib create PrivatePodDemo
    #之后终端会询问你几个问题,默认左侧选项,选择默认可直接回车
    #选择运行平台,笔者这里选择了iOS
    What platform do you want to use?? [ iOS / macOS ]
     > 
    ios
    #选择语言,笔者这里选择了Swift
    What language do you want to use?? [ Swift / ObjC ]
     > 
    swift
    #你希望创建一个带有示例工程的库么?笔者这里选择是
    Would you like to include a demo application with your library? [ Yes / No ]
     > 
    yes
    #使用测试框架么?笔者这里选择否
    Which testing frameworks will you use? [ Quick / None ]
     > none
    #是否要进行基于视图的测试,其实具体含义我也不太清楚,笔者这里选择否
    Would you like to do view based testing? [ Yes / No ]
     > no
    

    之后终端会自动打开你的Example工程,可以看到文件目录结构如下所示:


    15546892403075.jpg

    最外层的<PrivatePodDemo>就是步骤2从github上clone下来的文件夹,<PrivatePodDemo/PrivatePodDemo>是步骤3输入的名称

    步骤4 编辑PrivatePodDemo.podspec文件

    内容如下所示:

    Pod::Spec.new do |s|
      s.name             = 'PrivatePodDemo'
      s.version          = '0.1.0'
      s.summary          = 'A short description of PrivatePodDemo.'
    
    # This description is used to generate tags and improve search results.
    #   * Think: What does it do? Why did you write it? What is the focus?
    #   * Try to keep it short, snappy and to the point.
    #   * Write the description between the DESC delimiters below.
    #   * Finally, don't worry about the indent, CocoaPods strips it!
    
      s.description      = <<-DESC
    TODO: Add long description of the pod here.
                           DESC
    
      s.homepage         = 'https://github.com/Shaw003/PrivatePodDemo'
      # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
      s.license          = { :type => 'MIT', :file => 'LICENSE' }
      s.author           = { 'Shaw' => 'shawtun1211@163.com' }
      s.source           = { :git => 'https://github.com/Shaw003/PrivatePodDemo.git', :tag => s.version.to_s }
      # s.social_media_url = 'https://www.jianshu.com/u/596fa2382f62'
      # 如果需要设置语言版本的话可以这样做
      s.swift_version = '4.2'
      s.ios.deployment_target = '8.0'
    
      s.source_files = 'PrivatePodDemo/Classes/**/*'
      
      # s.resource_bundles = {
      #   'PrivatePodDemo' => ['PrivatePodDemo/Assets/*.png']
      # }
    
      # s.public_header_files = 'Pod/Classes/**/*.h'
      # s.frameworks = 'UIKit', 'MapKit'
      s.dependency 'Alamofire'
      s.dependency 'WCDB.swift', '1.0.7.5'
    end
    

    以上按照自己的情况修改即可,值得注意的是两个地方,

    关注点1: s.dependency

    如果你开发的库引用到了别的第三方库,可以使用s.dependency字段来写你引用了哪些三方库,值得注意的是,如果引用了多个,需要写多个s.dependency,举例:

      s.dependency 'Alamofire'
      s.dependency 'WCDB.swift'
    

    关注点2: s.source_files

    这里它默认写的路径是PrivatePodDemo/Classes/**/*,我们可以打开对应的文件夹,发现默认有一个Replace.swift的文件,这样给人的理解是,我们可以将希望通过Pod分享出去的源代码放到<PrivatePodDemo/PrivatePodDemo/PrivatePodDemo/Classes>文件夹下,当我们对这里的源代码有任何修改的时候,都需要先设置工作路径为包含Podfile文件的目录,然后执行pod install命令。

    首先我们找到并删除掉Classes文件夹中的Replace.swift,以我们自己的代码对其进行替换,替换后的目录结构如下所示,

    15546902220665.jpg

    这里我们尝试删除掉Replace.swift文件,并将你的工程代码文件拖入到这里,这时候我们可以执行pod install

    // 这里我们发现`Podfile`文件在`Example`文件夹中
    cd PrivatePodDemo/PrivatePodDemo/Example
    文件
    pod install
    

    执行完毕后,我们可以看到,在Xcode中,目录结构已变成如下所示,


    15546904522536.jpg

    我们对工程进行编译一下,发现没有报错,编译通过。

    步骤5 提交git

    操作1 提交到本地仓库
    git add -A
    git commit -m "commit code"
    

    在尝试提交git时时会报一个错误,


    15546906498061.jpg

    原因是因为创建pod lib时已经包括了.git文件了,此时需要终端切换工作路径到<PrivatePodDemo/PrivatePodDemo>

    cd PrivatePodDemo/
    ls -a
    
    15546907455017.jpg
    操作2 删除.git文件

    此时只需要删除.git文件即可,执行如下命令:

    rm -rf .git
    

    删除后,我们再尝试添加到本地仓库,执行命令

    操作3 提交到远端
    git commit -m "commit code"
    git push
    

    提交后我们发现只提交了一个PrivatePodDemo的空文件夹,里面什么都没有,这时候我们可以删除远端刚才的提交,重新提交一次

    操作4 删除远端提交
    git rm -r --cached PrivatePodDemo
    git commit -m "删除错误提交"
    git push
    

    删除完成后我们重复操作1,再次提交就可以了。

    步骤6 创建git tag

    此处创建的tag需要和podspec文件中s.version字段保持一致,这里我们写0.1.0

    git tag 0.1.0
    git push --tags
    

    二、 上传Pod

    步骤1 验证pod

    执行如下命令进行验证

    pod spec lint
    

    等了一会,发现验证不通过,原因有一个错误和几个警告,我们看下错误信息

    - ERROR | [iOS] file patterns: The `source_files` pattern did not match any file.
    

    这时,我们可以对PrivatePodDemo.podspec文件进行如下修改

    s.source_files = 'PrivatePodDemo/PrivatePodDemo/Classes/**/*'
    

    再次执行验证,我们可以忽略警告

    pod spec lint --allow-warnings
    

    这次验证结果

    PrivatePodDemo.podspec passed validation.
    

    验证通过了,这时你可能会问,那刚才第一次在编辑s.source_files字段时为什么不直接写成最后一次修改这样呢?具体原因我还不太清楚,不过经过我测试发现,source_files两种写法,
    写法1:PrivatePodDemo/Classes/**/*
    写法2:PrivatePodDemo/PrivatePodDemo/Classes/**/*

    如果采用 写法1 在执行pod install命令时,可以正常获取保存在Classes文件夹中的代码;当执行pod spec lint命令时却由于没找打源码文件而未能验证通过。
    如果采用 写法2 则在执行pod install命令时,无法正常获取到保存在Classes文件夹中的代码,而执行pod spec lint命令时却能验证通过。
    因此,笔者采用了先用 写法1 提交到github的仓库,再修改为 写法2 去进行验证的方式。

    步骤2 上传Pod

    由于之前我们创建的这个示例工程的名字不太好,和线上的有冲突了,我们这里修改.podspec文件名为PrivatePodDemo001.podspec,同时,调整文件内的s.name = 'PrivatePodDemo001'
    接下来执行命令

    pod trunk push PrivatePodDemo001.podspec --allow-warnings
    

    等待一会,出现如下内容,说明上传成功了


    15547083693595.jpg

    步骤3 搜索Pod

    直接输入如下指令

    pod search PrivatePodDemo001
    

    报错了,提示如下:

    [!] Unable to find a pod with name, author, summary, or description matching `PrivatePodDemo001`
    

    这时我们可以尝试重新设置一下pod的索引

    rm ~/Library/Caches/CocoaPods/search_index.json
    pod setup
    

    之后再执行一下搜索就可以搜到了。


    15547088234370.jpg

    三、 示例工程验证

    步骤1 新建一个工程

    使用pod 'PrivatePodDemo001'可以将需要的源码下载下来。

    15547092987659.jpg

    相关文章

      网友评论

        本文标题:制作自己的带有Example工程的CocoaPods

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