注:需要读者有一定CocoaPods基础,并且设备中CocoaPods已经更新到最新版!
一.组件化介绍
需求来源
随着项目规模不断扩大,业务模块增多,开发过程中会有多条产品线(多人或多小组开发不同的功能);如果用传统的开发模式,会导致代码臃肿,编译速度越来越慢,开发效率低下,代码维护成本越来越高.
组件化优势
代码逻辑和项目结构清晰;代码利用率高,迭代效率高;可以快速集成,并能做单元测试;每个组件可以单独运行,组件之间的耦合度低.
组件化模块划分
基础组件: 宏定义/自定义分类/自定义工具类
功能组件: 项目中常用功能,如:定位/推送/分享
业务组件: 根据具体业务而定,如:聊天/商城
中间组件: 负责界面路由/传参/回调
宿主工程: 类似一个壳子,组合各个组件,形成一个完整的App
组件化实质
组件化其实是把每一个功能模块拆分成一个一个的Pod库;比如项目中要用到AFN,只要Pod一下,便触手可及~;现在我们制作自己的Pod库,然后把它集成到项目中.
二.需要了解
Trunk账号
- 认证CocoaPods API的服务
- 用来管理公共仓库中的自己的组件
索引文件(.podspec文件)
- 记录一个组件的名称/版本/资源储存路径/维护者信息等
- 每个组件都必须有一个索引文件
索引文件库(Spec Repo)
- 存放索引文件的仓库
- 储存在CocoaPods服务器上,我们下载或更新Pod的时候会把这个仓库拷贝一份到本地,本地存放路径:~/.cocoapods/repos/
- CocoaPods提供一个公共库,储存在本地的路径为:~/.cocoapods/repos/master/
- 我们可以创建私有仓库,储存在本地的路径为:~/.cocoapods/repos/自定义仓库名/
组件模板
- CocoaPods提供用于快速创建组件的模板
- 里边可以制作我们的代码,可以做单元测试等,包含一个对应的索引文件
- 组件化就是以这个模板为基础,制作自己的组件
三.思路梳理(注意划重点了)
- 有了以上基础知识的了解我们来梳理一下思路
- 本文会使用私有索引仓库来维护组件(不使用公共仓库master)
- 组件添加到公共仓库中需要注册Trunk账号: 传送门
- 在码云(或者其他Git仓库)创建一个私有的仓库,当做<私有索引文件仓库>,后边用来储存索引文件(项目名称:xxSpecs)
- 在码云(或者其他Git仓库)创建一个公开的仓库,当做<组件仓库>,后边用来储存组件(项目名称:xxKit)
- CocoaPods服务器不储存我们的代码,只储存索引文件
- 制作好组件之后,索引文件里会储存<组件仓库>的地址,把索引文件传给CocoaPods服务器,告诉它储存在指定的<私有索引文件仓库>
- 使用时,先通过CocoaPods服务器更新<私有索引文件仓库>到本地;项目中Pod某个组件的时候,会在本地<私有索引文件仓库>中找到这个组件的索引文件,从索引文件里拿到<组件仓库>的地址,从这个地址把代码下载到项目中
- 总结:思路梳理介绍了组件化制作过程的主干,只要大体明白我们在干什么,下边具体操作时会有详细步骤
四.具体操作
索引文件仓库
- 关联索引文件仓库
- 把码云上创建的索引文件仓库关联拷贝到本地
pod repo add [仓库名] [仓库URL地址]
- 之后输入远端Git仓库的账号和密码
- 检查是否安装成功
- cd 到索引文件仓库
cd ~/.cocoapods/repos/[仓库名]
- 验证索引文件仓库
pod repo lint .
组件
- 本地新建一个文件夹,用于存放管理组件(起名:xxPod)
- 下载组件模板到xxPod文件夹
- cd 到xxPod文件夹
cd [文件夹全路径]/xxPod
- 下载组件模板并设置组件名
[组件名] : xxKit (跟码云上组件仓库的名字一致)
pod lib create [组件名]
- 组件基本设置
// 使用哪种系统的模板
What platform do you want to use?? [ iOS / macOS ]
> ios
// 使用哪种语言
What language do you want to use?? [ Swift / ObjC ]
> objc
// 是否创建测试Demo
Would you like to include a demo application with your library? [ Yes / No ]
> yes
// 使用哪种测试框架
Which testing frameworks will you use? [ Specta / Kiwi / None ]
> specta
// 是否需要测试视图
Would you like to do view based testing? [ Yes / No ]
> yes
// 测试Demo的类前缀
What is your class prefix?
> XX
- 代码制作
- 把自己的代码(类文件)直接复制到xxPod/xxKit/xxKit/Classes里
- 配置组件索引文件: 传送门
- 检查索引文件格式是否规范
- cd 到组件根目录
cd [文件夹全路径]/xxPod/xxKit
- 检查本地索引文件(passed validation 表示通过验证;--allow-warnings可忽略警告)
pod lib lint
如果提示标签类错误可暂时不用管,往下继续
- 制作好的代码Pod到组件测试工程中(可进行编译,运行,发现代码问题)
- cd 到组件的Example文件夹
cd [文件夹全路径]/xxPod/xxKit/Example
- Pod集成
pod install
- 把做好的组件推送到自己的组件仓库
- cd 到组件根目录
cd [文件夹全路径]/xxPod/xxKit/
- 初始化git
git init
git add .
- 提交一个Git版本
git commit -m "xxKit组件初始化"
- 关联码云上的组件仓库
git remote add origin [组件仓库URL]
- 推送版本到master分支(-f强制推送,覆盖掉之前的所有文件)
git push origin master -f
- 添加版本标签(标签号必须与索引文件里的标签号一致)
git tag 0.1.0
- 标签推送到组件仓库
git push --tags
- 检查远程索引文件(passed validation 表示通过验证)
pod spec lint
关联CocoaPods服务器
- 制作好的组件关联CocoaPods服务器
- cd 到xxKit组件根目录
cd [文件夹全路径]/xxPod/xxKit
- 推送组件的索引文件到服务器,并告诉服务器存在哪个私有仓库中
[私有仓库名] : xxSpecs
[组件名] : xxKit
pod repo push [私有仓库名] [组件名].podspec --allow-warnings
- 查看本地的CocoaPods仓库(可看到公共库和自己的私有库)
pod repo
- 检查组件
- 更新本地CocoaPods仓库
pod repo update
- 搜索刚才制作的组件
[组件名] : xxKit
pod search [组件名]
项目中引用私有组件
- 新建一个项目工程,并添加Pod
- 配置Podfile文件
- 全局添加(<私有索引文件仓库>地址)
source 'https://gitee.com/xxSpecs.git'
- 单独添加(<组件仓库>地址)
pod 'xxKit', :git => 'https://gitee.com/xxKit.git'