iOS 制作Framework后上传CocoaPods

此篇文章将介绍如何制作一个依赖三方库的Framework;

制作工具:
Mac
Xcode
VSCode
Carthage (Carthage 是由swift语言编写的包管理工具)

准备工作

安装homebrew

/bin/zsh -c "$(curl -fsSL https://gitee.com/cunkai/HomebrewCN/raw/master/Homebrew.sh)"

安装Carthage:

brew update
brew install carthage

在Xcode中创建SDK

创建Framework工程

创建podfile

创建podfile文件,写入类似pod 'RxSwift'等三方库,在终端执行pod install

podfile

编辑SDK核心代码

写入核心代码 Emm.....

构建Framework

cd 到工程目录下,执行命令开始打包

carthage build --no-skip-current

完成后在工程目录下会新增一个文件夹Carthage

文件夹

到此,一个framework已经打包 好了。此时你想直接导入到其他工程中使用,那么可能会报错,如果直接使用这个framework,需要导入依赖库,当然这么做会有些不友好,所以我们可以将framework上传至Cocoapods仓库,并指定依赖库,这样在其他项目中使用我们封装好的库只需要轻轻 pod 一下即可。

下面我们将介绍下如何将framework上传至Cocoapods仓库

将framework上传至Cocoapods仓库

我们先介绍下将一个framework上传至Cocoapod仓库需要几个步骤:

  • 创建Git仓库
  • 创建podspec文件
  • 验证podspec文件
  • 上传项目并打上Tag
  • 发布至Cocoapods
创建Git仓库
  • 创建Git仓库,可以选择github,gitlab,码云等等;
  • 创建时选择License类型为MIT License的文件;
  • Clone至本地,将framework添加到本地仓库中;
创建podspec文件
  • 新建一个 podspec文件, 文件名要取好,文件名对应的就是库的名称,如果重复了是无法上传库的;(名称建议和库的名字保持一致)
// fileName 文件名 (你需要创建的名字)
pod spec create fileName
  • 编辑podspec文件,打开文件之后填入对应的信息即可;
    整个文件配置如下:
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.
  #

  spec.name         = "CHC_SDKTest"
  spec.version      = "0.0.1"
  spec.summary      = "A short description of CHC_SDKTest."

  # 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  = "测试sdk,你值得拥有"

  spec.homepage     = "https://gitee.com/caohanchao_076/sdktest"
  # 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 (example)"
  spec.license      = { :type => "MIT", :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             = { "caohanchao" => "[email protected]" }
  # Or just: spec.author    = "caohanchao"
  # spec.authors            = { "caohanchao" => "[email protected]" }
  # spec.social_media_url   = "https://twitter.com/caohanchao"

  # ――― 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, "9.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.
  #

  spec.source       = { :git => "https://gitee.com/caohanchao_076/sdktest.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.
  #

  # spec.source_files  = "Classes", "Classes/**/*.{h,m}"
  # spec.exclude_files = "Classes/Exclude"

  # spec.public_header_files = "Classes/**/*.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.
  #

  # spec.resource  = "icon.png"
  # 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.

  # spec.requires_arc = true

  # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  # spec.dependency "JSONKit", "~> 1.4"
  spec.dependency "Alamofire"
end
验证podspec文件
  • 终端cd到 podspec所在目录下,执行以下命令
// 验证方法一,  网络校验
pod spec lint 项目名.podspec

// 验证方法二,本地校验
pod lib lint --allow-warnings --verbose
上传项目并打上Tag
  • 将改动的文件和项目提交上传至远端仓库;
  • 打上tag版本,有图形化界面可以图形化界面操作,没有使用命令行执行以下命令;(由于Cocoapods需要依赖项目中的tag,所以tag版本需要和podspec文件中的version保持一致)
// 为 git 提交打上 tag
git tag "0.0.1" 
// 将 tag 推送到远程仓库
git push --tags 
发布至Cocoapods
  • 打开终端 cdpodspec 所在文件目录下,输入以下命令来发布到 CocoaPods
pod trunk push *.podspec --allow-warnings

看到这个 XXXX (0.0.1) successfully published, 就说明发布成功了。

Tips:

以上是使用Carthage包管理工具来打包,当然我们也可以使用CocoaPods的插件cocoapods-packager来完成类库的打包,或者使用手动编译打包,但是这个过程会相对繁琐。下面我会讲述下如何使用CocoaPods的插件:

安装打包插件

sudo gem install cocoapods-packager

开始打包

pod package [name].podspec --force

默认是framework文件;如果需要打成.a文件,命令后添加--library;
如果需要强制覆盖,命令后添加--force;

参考:
iOS SDK开发
iOS 安装homebrew
利用 Carthage 将项目打包 Framework 并依赖 CocoaPods 第三方库的方法
SSH公钥

你可能感兴趣的:(iOS 制作Framework后上传CocoaPods)