通过创建公有库,可以供内部和外部通过pod的方式,来管理和依赖相应的模块,达到对iOS工程模块化,将项目代码进行解耦的目的。
本文示例公有库MagicScrollPage开源,在Podfile中添加
pod 'MagicScrollPage'
即可使用。
一、创建公开仓库
1.1 这里使用GitHub新建一个仓库,选择许可证为MIT。
1.2 将创建好的仓库,克隆到本地。
1.3 进入本地项目路径,将工程文件和公开文件拖入其中。
二、配置公有库PodSpec
2.1 在项目路径下,创建公有库.podspec文件。
# 创建.podspec文件
pod spec create 公有库名称
默认podspec内容:
#
# Be sure to run `pod spec lint MagicScrollPage.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 http://docs.cocoapods.org/specification.html
# To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#
Pod::Spec.new do |s|
# ――― 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.
#
s.name = "MagicScrollPage"
s.version = "0.0.1"
s.summary = "A short description of MagicScrollPage."
# 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
DESC
s.homepage = "http://EXAMPLE/MagicScrollPage"
# s.screenshots = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"
# ――― Spec License ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
#
# Licensing your code is important. See http://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'.
#
s.license = "MIT (example)"
# s.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.
#
s.author = { "LuisX" => "" }
# Or just: s.author = "LuisX"
# s.authors = { "LuisX" => "" }
# s.social_media_url = "http://twitter.com/LuisX"
# ――― 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.
#
# s.platform = :ios
# s.platform = :ios, "5.0"
# When using multiple platforms
# s.ios.deployment_target = "5.0"
# s.osx.deployment_target = "10.7"
# s.watchos.deployment_target = "2.0"
# s.tvos.deployment_target = "9.0"
# ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
#
# Specify the location from where the source should be retrieved.
# Supports git, hg, bzr, svn and HTTP.
#
s.source = { :git => "http://EXAMPLE/MagicScrollPage.git", :tag => "#{s.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.
#
s.source_files = "Classes", "Classes/**/*.{h,m}"
s.exclude_files = "Classes/Exclude"
# s.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.
#
# s.resource = "icon.png"
# s.resources = "Resources/*.png"
# s.preserve_paths = "FilesToSave", "MoreFilesToSave"
# ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
#
# Link your library with frameworks, or libraries. Libraries do not include
# the lib prefix of their name.
#
# s.framework = "SomeFramework"
# s.frameworks = "SomeFramework", "AnotherFramework"
# s.library = "iconv"
# s.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.
# s.requires_arc = true
# s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
# s.dependency "JSONKit", "~> 1.4"
end
podspec属性:
Spec Metadata(Spec资料) | |
---|---|
s.name | 名称 |
s.version | 版本 |
s.summary | 简介 |
s.description | 详细介绍 |
s.homepage | 主页地址 |
s.screenshots | 屏幕截图 |
Spec License(Spec执照) | |
s.license | 开源协议 |
Author Metadata(作者资料) | |
s.author | 作者、邮件地址 |
s.authors | 多个作者 |
s.social_media_url | 社交地址 |
Platform Specifics(平台特性) | |
s.platform | 平台 |
s.ios.deployment_target | ios部署目标 |
s.osx.deployment_target | osx部署目标 |
s.watchos.deployment_target | watchos部署目标 |
s.tvos.deployment_target | tvos部署目标 |
Source Location(源定位) | |
s.source | 开源地址、版本号 |
Source Code(源代码) | |
s.source_files | 开源文件夹、文件 |
s.exclude_files | 排除文件夹、文件 |
s.public_header_files | 头文件 |
Resources(资源) | |
s.resource | 资源文件 |
s.resources | 多个资源文件 |
s.preserve_paths | 保留路径 |
Project Linking(项目关联) | |
s.framework | 框架 |
s.frameworks | 多个框架 |
s.library | 库 |
s.libraries | 多个库 |
Project Settings(项目设置) | |
s.requires_arc | 需要ARC模式 |
s.xcconfig | 配置 |
s.dependency | 依赖Podspecs |
🚀更多属性请参考Podspec官方说明文档
2.2 可以使用Sublime等编译器,打开.podspec文件,配置对应的属性。
2.3 保存编辑后的.podspec的文件,验证公有库是否有效,若未通过验证可根据提示进行修改。
# 验证公有库podspec配置
pod lib lint 公有库名称.podspec
三、推送公有库到GitHub
3.1 推送所有代码到GitHub。
git add .
git commit -m "first commit"
git remote add origin https://github.com/sunjinshuai/test.git
git push -u origin master
3.2 推送标签到GitHub。
$ git tag -m "first release" 0.0.1
$ git push --tags
# 推送tag到远端仓库
四、推送公有库到CocoaPods
4.1 通过pod来注册trunk,确认发送到邮箱的邮件,然后查看注册的个人信息。
# 注册trunk
pod trunk register 邮箱 ‘用户名’ --description=‘描述’
# 查看个人信息
pod trunk me
4.2 验证上传的podspec是否有效,若未通过验证可根据提示进行修改。
# 验证公有库podspec是否有效
pod spec lint 公有库名称.podspec
4.3 将公有库推送到CocoaPods上。
# 推送公有库到CocoaPods
pod trunk push 公有库名称.podspec
五、搜索公有库
5.1 通过pod search搜索公有库
# 搜索公有库
pod search 公有库名称
遇到问题
1. 搜索不到索引库怎么办?
# 移除搜索目录
rm ~/Library/Caches/CocoaPods/search_index.json
# 更新索引
pod repo update
# 搜索公有库
pod search 公有库名称
2. 如何通过网站搜索公有库?
3. 公有库和私有库有什么区别?
创建公有库和私有库,实际上原理是相同的, 不同的是, 两者的版本索引查询方式,公有库的podspec由CocoaPods/Specs管理,私有库需要自己建立一个仓库来管理podspec