iOS 组件化开发完整流程

作者: 一滴矿泉水 | 来源:发表于2021-07-19 09:26 被阅读0次

一、组件化介绍

需求来源

随着项目规模不断扩大,业务模块增多,开发过程中会有多条产品线(多人或多小组开发不同的功能);如果用传统的开发模式,会导致代码臃肿,编译速度越来越慢,开发效率低下,代码维护成本越来越高.

组件化优势

代码逻辑和项目结构清晰;代码利用率高,迭代效率高;可以快速集成,并能做单元测试;每个组件可以单独运行,组件之间的耦合度低.

组件化模块划分

基础组件: 宏定义/自定义分类/自定义工具类
功能组件: 项目中常用功能,如:定位/推送/分享
业务组件: 根据具体业务而定,如:聊天/商城
中间组件: 负责界面路由/传参/回调
宿主工程: 类似一个壳子,组合各个组件,形成一个完整的App

组件化实质

组件化其实是把每一个功能模块拆分成一个一个的Pod库;比如项目中要用到AFN,只要Pod一下,便触手可及~;现在我们制作自己的Pod库,然后把它集成到项目中。组件开发规范.

二、需要了解

Trunk账号

1.认证CocoaPods API的服务
2.用来管理公共仓库中的自己的组件

索引文件(.podspec文件)

1.记录一个组件的名称/版本/资源储存路径/维护者信息等
2.每个组件都必须有一个索引文件

索引库(Spec Repo)

1.存放索引文件的仓库
2.储存在CocoaPods服务器上,我们下载或更新Pod的时候会把这个仓库拷贝一份到本地,本地存放路径:~/.cocoapods/repos
3.CocoaPods提供一个公共索引库,储存在本地的路径为:~/.cocoapods/repos/master
4.我们可以创建私有索引库,储存在本地的路径为:~/.cocoapods/repos/自定义索引库名（本文也会带领大家去创建自己的索引库）

组件模板（pod lib create [组件名]）

1.CocoaPods提供用于快速创建组件的模板
2.里边可以制作我们的代码,可以做单元测试等,包含一个对应的索引文件
3.组件化就是以这个模板为基础,制作自己的组件

三、思路梳理(注意划重点了)

1.有了以上基础知识的了解我们来梳理一下思路
2.本文会使用私有索引库(我们自己创建)来维护组件(不使用公共仓库master)
3.组件添加到公共仓库中需要注册Trunk账号: 传送门
4.在Git(或马云等其他仓库)创建一个私有的仓库,当做<私有索引文件仓库>,后边用来储存索引文件(项目名称:xxSpecs)
5.在Git(或马云等其他仓库)创建一个公开/私有的仓库,当做<组件仓库>,后边用来储存组件(项目名称:xxKit)
6.CocoaPods服务器不储存我们的代码,只储存索引文件
7.制作好组件之后,索引文件里会储存组件主页(s.homepage)的地址,组件(s.source)的地址。(这里一定要注意：这两个地址一定要与组件地址一致，虽然会自动生成地址，不过会存在不一致的情况。（我就深受其害 ~~~~）
8.使用时,先通过CocoaPods服务器更新<私有索引文件仓库>到本地;项目中Pod某个组件的时候,会在本地<私有索引文件仓库>中找到这个组件的索引文件,从索引文件里拿到<组件仓库>的地址,从这个地址把代码下载到项目中
9.总结:思路梳理介绍了组件化制作过程的主干,只要大体明白我们在干什么,下边具体操作时会有详细步骤

四、具体操作

索引库

1.创建私有索引库

在Git 上创建一个私有的仓库（xxSpecs）
打开终端cd到桌面目录下:
cd Desktop
终端输入:
pod repo add xxSpecs https://github.com/zhanghua19860221/xxSpecs.git（地址替换为你所创建仓库实际地址）
之后输入远端Git仓库的账号和密码

2.检查是否安装成功

cd 到新建索引库
cd ~/.cocoapods/repos/xxSpecs
验证索引文件仓库
pod repo lint .
至此索引库就创建完成

组件

1.下载并创建组件模板

Github创建一个远程组件仓库（xxKit）
打开终端cd到桌面目录下:
cd Desktop
下载组件模板并设置组件名（这里组件名一定要与远程仓库名称一致）
pod lib create xxKit
组件基本设置

// 使用哪种系统的模板
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? [ Quick / None ]
None
// 是否需要测试视图
Would you like to do view based testing? [ Yes / No ]
yes
// 测试Demo的类前缀
What is your class prefix?
XX

输入完成电脑桌面将自动创建一个名为 xxKit 的Git组件仓库（仓库里面会包含一个名为：xxKit.podspec 的索引文件）

通过Cocoapods (pod lib create xxKit) 创建出来的目录本身就在本地的Git管理下，我们需要做的就是给它添加远端仓库，拿到SSH地址(这一步需要配置 SSH)
使用SSH方式加密连接过程如下:(如果以前关联过一次组件，此步骤非必须可跳过，跳至 2、组件内文件与图片资源的添加介绍即可)
打开终端
$ ssh-keygen

Generating public/private rsa key pair.

Enter file in which to save the key (/Users/galahad/.ssh/id_rsa): //直接回车，不要输入

/Users/galahad/.ssh/id_rsa already exists.

Overwrite (y/n)? y

Enter passphrase (empty for no passphrase): //输入密码，待会会用到

Enter same passphrase again:

Your identification has been saved in /Users/galahad/.ssh/id_rsa.

Your public key has been saved in /Users/galahad/.ssh/id_rsa.pub.

The key fingerprint is:

省略......

The key's randomart image is:

省略......

$ cat ~/.ssh/id_rsa.pub // 查看

id_rsa.pub文件中公钥拿到以后在Github上面添加公钥

$ ssh -T github.com //连接（添加成功以后，这里进项连接）

Enter passphrase for key '/Users/galahad/.ssh/id_rsa': //输入刚才的那个密码

至此加密链接过程完成

2.组件内文件与图片资源的添加

把自己的代码(类文件)直接复制到桌面xxKit/xxKit/Classes 文件夹内（ Classes 是专门用来存放组件类文件）
把自己的图片资源直接复制到桌面xxKit/xxKit/Assets 文件夹内（ Assets 是专门用来存放组件图片资源）
cd到桌面组件xxKit的Example目录下
cd xxKit/Example
pod install

3. 把做好的组件推送到自己的组件仓库

cd 到桌面xxKit 目录下
cd /xxKit
添加代码到git缓存区
git add .
提交一个缓存区代码
git commit -m "xxKit组件初始化"
关联Github的远程组件仓库
git remote add origin git@github.com:zhanghua19860221/xxKit.git（这里需要用 SSH 地址）
推送版本到master分支(-f强制推送,覆盖掉之前的所有文件)
git push origin master -f
添加版本标签(标签号必须与索引文件里的标签号一致)
git tag 0.1.0
标签推送到组件仓库
git push --tags
验证本地索引
pod lib lint --allow-warnings（--allow-warnings 可以忽略警告）
验证远程索引文件
pod spec lint xxKit.podspec --verbose

关联CocoaPods服务器

1. 制作好的组件关联CocoaPods服务器刚才创建的私有索引库

cd 桌面组件xxKit目录下
cd /xxKit
推送组件的索引文件到服务器,并告诉服务器存在哪个私有仓库中
pod repo push xxSpecs xxKit.podspec --allow-warnings
查看本地的CocoaPods仓库(可看到公共库和自己的私有库)
pod repo

2.检查组件

更新本地CocoaPods仓库(这里也一定要注意,这一步也不可缺少)
pod repo update --verbose
搜索刚才制作的组件
pod search xxKit

五、项目中引用私有组件

1.新建一个项目工程,并添加Pod

2.配置Podfile文件

文件中导入索引库可不指定组件路径，依照索引库中最新的tag更新组件

source 'https://github.com/zhanghua19860221/xxSpecs.git'
pod 'xxxKit'（可不指定分支）

文件中不导入索引库根据配置路径更新组件

pod 'xxKit', :git => 'https://github.com/zhanghua19860221/xxKit.git', :branch => 'master_0803'（可指定分支）

六、错误收集

验证本地索引库执行命令 pod lib lint --allow-warnings 的时候终端错误提示

ERROR | [iOS] unknown: Encountered an unknown error (/usr/bin/xcrun simctl list -j devices
xcrun: error: unable to find utility "simctl", not a developer tool or in PATH

此时打开你的Xcode，点击偏好设置

截屏2022-02-10 下午7.48.22.png

然后找到这个地方：

截屏2022-02-10 下午7.47.44.png

把这个选项选好，默认应该是空的。
然后再去检验 xxx.podspec 文件，应该就没问题了。

验证本地索引库执行命令 pod lib lint --allow-warnings 的时候终端错误提示

- WARN  | url: There was a problem validating the URL https://github.com/zhanghua19860221/ZHAFNNetwork.
    - ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use `--verbose` for more information.
    - NOTE  | xcodebuild:  note: Using new build system
    - NOTE  | xcodebuild:  note: Using codesigning identity override: -
    - NOTE  | xcodebuild:  note: Build preparation complete
    - NOTE  | [iOS] xcodebuild:  note: Planning
    - NOTE  | [iOS] xcodebuild:  note: Building targets in dependency order
    - ERROR | xcodebuild:  /Users/zhanghua/Library/Developer/Xcode/DerivedData/App-chhlpkpgifojuacrcyzllabzxojz    /Build/Products/Release-iphonesimulator/ZHAFNNetwork/ZHAFNNetwork.framework/Headers    /ZHHttpBaseManager.h:9:9: error: include of non-modular header inside framework module 'ZHAFNNetwork.ZHHttpBaseManager': '/Users/zhanghua/Library/Developer/Xcode/DerivedData/App-chhlpkpgifojuacrcyzllabzxojz/Build/Products/Release-iphonesimulator/AFNetworking/AFNetworking.framework/Headers/AFNetworking.h' [-Werror,-Wnon-modular-include-in-framework-module]

问题解决
此问题是自建的私有库项目中有第三方依赖库，且在.h文件中做了#import引入三方.h 文件，改成在.m文件中#import

    #import <Foundation/Foundation.h>
    #import "ZHHttpBaseConfig.h"
    //.h 正确引入
    #import <AFNetworking/AFNetworking.h>
    //.h 中错误引入
    //#import "AFNetworking.h"
    //可在 .m 中引入
    //#import "AFNetworking.h"
    NS_ASSUME_NONNULL_BEGIN

到此问题解决

文章内容借鉴链接：https://blog.csdn.net/tfy_2425482491/article/details/101029316
文章内容借鉴链接：https://blog.csdn.net/weixin_30360497/article/details/96633222
文章内容借鉴链接：http://blog.wtlucky.com/blog/2015/02/26/create-private-podspec

文章持续更新中、希望对各位有所帮助、有问题可留言大家共同学习.

网友评论

本文标题：iOS 组件化开发完整流程

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

延伸阅读

深度阅读

您也可以注册成为美文阅读网的作者，发表您的原创作品、分享您的心情！

iOS 组件化开发完整流程

一、组件化介绍

需求来源

组件化优势

组件化模块划分

组件化实质

二、需要了解

Trunk账号

索引文件(.podspec文件)

索引库(Spec Repo)

组件模板（pod lib create [组件名]）

三、思路梳理(注意划重点了)

四、具体操作

索引库

1.创建私有索引库

2.检查是否安装成功

组件

1.下载并创建组件模板

2.组件内文件与图片资源的添加

3. 把做好的组件推送到自己的组件仓库

关联CocoaPods服务器

1. 制作好的组件关联CocoaPods服务器刚才创建的私有索引库

2.检查组件

五、项目中引用私有组件

1.新建一个项目工程,并添加Pod

2.配置Podfile文件

六、错误收集

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

iOS 组件化开发 完整流程

一、组件化介绍

需求来源

组件化优势

组件化模块划分

组件化实质

二、需要了解

Trunk账号

索引文件(.podspec文件)

索引库(Spec Repo)

组件模板 （pod lib create [组件名]）

三、思路梳理(注意划重点了)

四、具体操作

索引库

1.创建私有索引库

2.检查是否安装成功

组件

1.下载并创建组件模板

2.组件内文件与图片资源的添加

3. 把做好的组件推送到自己的组件仓库

关联CocoaPods服务器

1. 制作好的组件关联CocoaPods服务器刚才创建的私有索引库

2.检查组件

五、项目中引用私有组件

1.新建一个项目工程,并添加Pod

2.配置Podfile文件

六、错误收集

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

iOS 组件化开发完整流程

组件模板（pod lib create [组件名]）