iOS开发iOSSwift开发

iOS 组件化(三) - 组件化工程

2022-11-21  本文已影响0人  顶级蜗牛

iOS 组件化(一) - CocoaPods原理理论篇
iOS 组件化(二) - 远程/本地管理私有库
iOS 组件化(三) - 组件化工程介绍

一、创建组件

在桌面创建一个名为Modules的文件夹，打开终端使用pod命令创建组件工程，取名为WJCommon

cd /Users/xxx/Desktop/Modules
pod lib create WJCommon

创建组件后会自定打开WJCommon组件工程：

二、目录介绍

LICENSE主要是对该组件的介绍，需要自己写（我这里不做演示）

Example是组件的测试用例，可以用于测试WJCommon组件里的API。可以写一些UIView相关类去测试组件代码的正确，当然像使用UIView的话需要添加约束，可以在Podfile文件中添加该测试用例所依赖的三方库。

WJCommon是真正的组件的代码相关，下面内容会详细说明。

WJCommon.podspec是用来配置组件的版本号、名称、描述、作者信息、远程仓库链接、依赖三方库、开放资源文件等等。

三、.podspec文件介绍

Pod::Spec.new do |s|
  s.name             = 'WJCommon' # 库名称
  s.version          = '0.0.1' # 版本号
  s.summary          = 'Swift 工具类组件' #对组件的简述

# 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
TODO: Add long description of the pod here.
                       DESC
  
  #此处为远程仓库地址，要去掉 /xxx.git
  s.homepage         = 'https://gitee.com/xxx'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  #作者邮箱
  s.author           = { 'Steven' => '2448305504@qq.com' }
  #远程仓库地址、当前的版本号
  s.source           = { :git => 'https://gitee.com/xxx/WJCommon.git', :tag => s.version.to_s }
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'

  s.ios.deployment_target = '10.0' # 依赖最低版本

  # 开放的库文件
  s.source_files = 'WJCommon/Classes/**/*'
  
  # 开放的库资源文件 - 有资源则需要打开这里的注释
  # s.resource_bundles = {
  #   'WJCommon' => ['WJCommon/Assets/*.png']
  # }

  # s.public_header_files = 'Pod/Classes/**/*.h'
  # s.frameworks = 'UIKit', 'MapKit' # 依赖系统库
  
  # 组件依赖多个三方库
  s.dependency 'Kingfisher'
  s.dependency 'Alamofire', '~> 5.4.4'

  # 定义子库例子
  #spec.subspec 'XXChildFramework' do |ss|
      #引入XXChildFramework中所有资源文件
      # ss.source_files = 'XXChildFramework/Classes/**/*'
      #公开XXChildFramework模块中的头文件
      # ss.public_header_files = 'XXChildFramework/Classes/publicHeader/*.h'
  # end

end

相关代码注释：

s.name： 名称
s.version： 版本号
s.ios.deployment_target: 支持的pod最低版本
s.summary: 简介
s.homepage: 项目主页地址
s.license: 开源协议(创建github库的时候选择的)
s.author: 作者信息(这里随便谢谢也可以通过)
s.social_media_url: 社交网址
s.source: 项目的地址
s.source_files: 需要包含的源文件
s.resource: 资源文件,单个
s.resources: 资源文件(含bundle)
s.vendored_frameworks: 包含的framework,也就是我们自己制作的pod
s.requires_arc: 是否支持ARC
s.dependency： 依赖库，不能依赖未发布的库.如AFNetWorking
s.description: 描述,字数要比s.summary长
s.screenshots: 截图
s.exclude_files: 隐藏的文件
s.public_header_files: 公开的头文件
s.framework: 所需的framework,单个
s.frameworks: 所需的framework,多个用逗号隔开
s.library 引用的静态库
s.libraries 引用的静态库,多个用逗号隔开
s.vendored_libraries: 引用自己生成的.a
s.vendored_frameworks: 引用自己生成的.framework,多个用逗号隔开
s.dependency: 依赖的库
s.ios.deployment_target iOS部署版本

四、组件的代码区

组件的代码应该放在名为ReplaceMe把该文件替换掉。

注意：每次修改组件的内容都需要pod install去更新一下一下，测试用例才能使用。

$ cd /Users/xxx/Desktop/Modules/WJCommon/Example 
$ pod install

五、组件依赖三方库

1.依赖远程三方库的导入

我们在编写组件的代码的时候，往往用到别的三方库，比如图片下载Kingfisher、比如网络请求Alamofire等等。

这个时候需要修改WJCommon.podspec文件给组件添加三方依赖

2.Objctive-C三方库暴露头文件

像OC的三方库（Mansonry、AFNetwoing、SDWebImage）则需要在.podspec末尾添加暴露头文件头文件

s.prefix_header_contents = '#import "Masonry.h"', '#import "UIKit+AFNetworking.h"'

再pod install一下，此时WJCommon-prefix.pch就有了引入：

ps：倘若编译工程还报错，则关闭掉Xcode重新打开项目编译或者重新pod install，别说我没告诉你，经常会出现这样奇奇怪怪的问题。这是因为不断地对pod进行修改文件，会导致读取到缓存的问题。

3.依赖本地三方库的导入

如果我有一个自己写的组件名为WJMacro并把它放在和WJCommon组件工程一个目录下（都在Modules目录）。

WJMacro主要写的一些常量，比如 kScreenWidth、kScreenHeight。
（又或者是从github上下载别的三方框架放在本地，也是可以的）

此时我想要在WJCommon中引入WJMacro，则需要在Podfile文件进行修改：
（记得pod install）

六、组件需要的资源文件

倘若WJCommon组件里需要使用到一些资源，如图片/plist/json/xib等等。

1.将资源文件导入到Assets，如下目录：
2.WJCommon.podspec文件中开放库资源文件

注意我这里开放的是.xcassets后缀的文件，因为我在Assets目录下添加的是images.xcassets。

若需要开放多种格式的文件，则在中括号内添加。也可以直接使用这个全部开放出去:

   # 开放的库资源文件 - 有资源则需要打开这里的注释
   s.resource_bundles = {
     'WJCommon' => ['WJCommon/Assets/**/*']
   }

pod install后就会在工程中见到资源

3.在工程中读取资源文件

在组件中读取资源文件：

注意每次修改组件都得pod install

在组件测试用例中读取资源文件：

运行测试结果：

let bundlePath = Bundle.init(for: ReplaceMe.self).bundlePath+"/WJCommon.bundle"
print(bundlePath)
let resoure_bundle = Bundle.init(path: bundlePath)
let image = UIImage(named: "share_wechat", in: resoure_bundle, compatibleWith: nil)
print(image as Any)

要是每次嫌麻烦，自己可以写一个宏定义即可啦。

七、组件之间的通讯

在我们构建组件模块的时候，总会出现模块之间的相互使用，导致模块之间的耦合不独立的情况，如下

模块耦合

我们构建模块的初衷是谁的事情谁去做，要是这么相互引用的话，我们的模块就会变得很凌乱。

在我们计算机中往往出现两两都无法解决耦合的问题的时候，都可以借助第三者来实现对两者的解耦。

解决模块耦合的问题市面上推出了三种方案：

后面出一节来探讨组件通讯。

上一篇下一篇

猜你喜欢

热点阅读