组件化之路---通过cocoapods进行动态库的发布及维护(2)

最近在了解组件化方面的知识点,在整个落地的环节当中遇到了很多的问题,也希望通过记录的形式避免之后再去走弯路

前篇 组件化之路---Swift如何创建Framework

主要内容

  • 准备工作
  • Podspace空间创建及配置
  • 校验及上传Tag版本
  • 搜索及使用库
  • 如何进行维护
  • 错误问题

准备工作

创建cocoapods仓库

创建仓库并没有什么特殊的地方,输入仓库的名字和简单的描述,注意选择一个许可证,证书可以根据实际情况进行选择,以MIT为例

截屏2021-10-29 上午9.46.53.png
克隆到本地

在终端进入指定的目录,将仓库克隆到本地

git clone xxxxx
将动态库放入本地仓库中

将做好的Framework动态库放入到本地仓库中,如图所示


截屏2021-10-29 上午9.53.53.png

Podspace空间创建及配置

注册trunk账号
pod trunk register 自己的邮箱 '自己的用户名' --description='imac' --verbose

如果未注册trunk账号,会发送一封邮件到邮箱;去邮箱注册即可。可通过pod trunk me 查询注册信息

创建podspace文件
pod spec create JJXSDKFrameworkSpec(此处自己进行命名)
配置podspace文件

创建完成podspace文件后,文件当中的内容会自动生成一部分,建议不要删除,根据注释去理解配置对应参数的作用,然后再根据自己的需求进行相关的配置,以下是本例当中的配置信息

#
#  Be sure to run `pod spec lint JJXSDKFrameworkSpec.podspec' to ensure this is a
#  valid spec and to remove all comments including this before submitting the spec.
#
#  To learn more about Podspec attributes see https://guides.cocoapods.org/syntax/podspec.html
#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#

Pod::Spec.new do |spec|

  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  These will help people to find your library, and whilst it
  #  can feel like a chore to fill in it's definitely to your advantage. The
  #  summary should be tweet-length, and the description more in depth.
  #
  #  The name of the spec should match the name of the file
  spec.name         = "JJXSDKFrameworkSpec"
  spec.version      = "0.3.1"
  spec.summary      = "dynamic framework to learn"

  # 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!
  spec.description  = "it is one demo to learn dynamic framework for me"

  # 项目主页
  spec.homepage     = "https://github.com/ranzhuang/JJXSDKFramework"
  # spec.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"


  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Licensing your code is important. See https://choosealicense.com for more info.
  #  CocoaPods will detect a license file if there is a named LICENSE*
  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  #

  #  许可证
  spec.license      = "MIT"
  # spec.license      = { :type => "MIT", :file => "FILE_LICENSE" }


  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the authors of the library, with email addresses. Email addresses
  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  #  accepts just a name if you'd rather not provide an email address.
  #
  #  Specify a social_media_url where others can refer to, for example a twitter
  #  profile URL.
  #

  spec.author             = { "huangju6" => "[email protected]" }
  # Or just: spec.author    = "huangju6"

  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If this Pod runs only on iOS or OS X, then specify the platform and
  #  the deployment target. You can optionally include the target after the platform.
  #

  spec.platform     = :ios
  # 支持的平台
  spec.platform     = :ios, "11.0"

  #  When using multiple platforms
  # spec.ios.deployment_target = "5.0"
  # spec.osx.deployment_target = "10.7"
  # spec.watchos.deployment_target = "2.0"
  # spec.tvos.deployment_target = "9.0"


  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the location from where the source should be retrieved.
  #  Supports git, hg, bzr, svn and HTTP.
  #
  #  库的git地址以及版本号
  spec.source = { :git => "https://github.com/ranzhuang/JJXSDKFramework.git", :tag => "#{spec.version}" }


  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  CocoaPods is smart about how it includes source code. For source files
  #  giving a folder will include any swift, h, m, mm, c & cpp files.
  #  For header files it will include any header in the folder.
  #  Not including the public_header_files will make all headers public.
  #

  #  资源文件 001号 坑
  spec.source_files  ="JJXSDKDemo.framework/Headers/*.{h,m,swift}"
  #  SDK资源地址
  #spec.vendored_frameworks = "JJXSDKDemo.framework"
  # spec.exclude_files = "Classes/Exclude"
  #  sdk头文件路径
  spec.public_header_files = "JJXSDKDemo.framework/Headers/JJXSDKDemo.h"

  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  A list of resources included with the Pod. These are copied into the
  #  target bundle with a build phase script. Anything else will be cleaned.
  #  You can preserve files from being cleaned, please don't preserve
  #  non-essential files like tests, examples and documentation.
  #

  # bundle路径 
  spec.resource  = "JJXSDKDemo.framework/JJXSDKSource.bundle"
  # spec.resources = "Resources/*.png"

  # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"


  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Link your library with frameworks, or libraries. Libraries do not include
  #  the lib prefix of their name.
  #

  # spec.framework  = "SomeFramework"
  # spec.frameworks = "SomeFramework", "AnotherFramework"

  # spec.library   = "iconv"
  # spec.libraries = "iconv", "xml2"


  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If your library depends on compiler flags you can set them in the xcconfig hash
  #  where they will only apply to your library. If you depend on other Podspecs
  #  you can include multiple dependencies to ensure it works.

  # 是否支持ARC
  spec.requires_arc = true

  # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  # spec.dependency "JSONKit", "~> 1.4"
  spec.swift_version = '5.0'

end

校验及上传Tag版本

校验文件是否正确
 pod lib lint --verbose --allow-warnings

通过执行上面的命令可以对podspace文件进行校验,在校验的过程当中可能会出现问题,提示是比较清晰的,根据对应的错误信息去修改podspace信息就可以了

提交代码到main分支

通过校验之后依次执行以下命令提交代码到主分支

git status
git add .
git commit -m "版本信息修改"
git push
打上Tag版本号并上传

本地初始化0.3.1 Tag

git tag -m "update" 0.3.1

推送0.3.1 Tag版本到远程仓库

git push origin 0.3.1

通过 trunk 推送podspace文件

pud trunk push JJXSDKFrameworkSpec.podspec

到此便完成了库的发布工作!!!

搜索及使用库

执行搜索命令进行pod库的搜索,搜索时间一般会比较长

pod search JJXSDKFrameworkSpec

如果出现一下错误:[!] Unable to find a pod with name, author, summary, or description matching ’JJXSDKFrameworkSpec‘

方法一:

pod setup

方法二:

$ rm ~/Library/Caches/CocoaPods/search_index.json

最后重新执行 pod search JJXSDKFrameworkSpec

使用库

首先新建测试工程,在工程目录中执行pod init 生成podfile文件
其次在podfile文件中加入如下代码

pod 'JJXSDKFrameworkSpec'

最后执行 pod install操作

如何进行维护

更新动态库

将修改的API打包成Framework,并将之前的Framework进行替换

修改podspace版本号

修改 podspace 配置文件,修改version字段,例如:0.3.2

提交到main分支并打上Tag版本号上传

执行以下命令,将修改的内容推送到远程主分支

git status
git add .
git commit -m "版本信息修改"
git push

本地初始化0.3.2 Tag

git tag -m "update" 0.3.2

推送0.3.2 Tag版本到远程仓库

git push origin 0.3.2

通过 trunk 推送podspace文件

pod trunk push JJXSDKFrameworkSpec.podspec
测试工程更新库

在测试工程目录中执行 pod update命令,更新库
也可通过 pod update 库名 --verbose --no-repo-update命令 更新指定的库

错误问题

问题一:配置文件配置错误

执行 pod lib lint JJXSDKFrameworkSpec.podspec --allow-warnings 成功,但是在执行pod trunk push JJXSDKFrameworkSpec.podspec --allow-warnings时候提示错误:

 -> JJXSDKFrameworkSpec (0.0.1)
    - ERROR | [iOS] file patterns: The `source_files` pattern did not match any file.
    - NOTE  | xcodebuild:  note: Using new build system
    - NOTE  | xcodebuild:  note: Building targets in parallel
    - NOTE  | xcodebuild:  note: Using codesigning identity override: -
    - NOTE  | xcodebuild:  note: Build preparation complete
    - NOTE  | [iOS] xcodebuild:  note: Planning build
    - NOTE  | [iOS] xcodebuild:  note: Analyzing workspace
    - NOTE  | [iOS] xcodebuild:  note: Constructing build description

[!] The spec did not pass validation, due to 1 error.

原因分析:spec.source_files 设置错误
解决方法:spec.source_files = "JJXSDKDemo.framework/Headers/*.{h,m,swift}",注意路径,Headers不能使用” * “来代替

你可能感兴趣的:(组件化之路---通过cocoapods进行动态库的发布及维护(2))