iOS制作私有组件

作者: CharmecarWang | 来源:发表于2019-07-03 15:51 被阅读0次

1.创建私有Pod项目

建议使用Cocoapods的一个工具创建项目，加入我们创建一个私有库UserCenterModule,命令如下：

pod lib create UserCenterModule

它会问你几个问题，看着回答就行了。会自动执行pod install命令创建项目并生成依赖。查看生成的项目目录结构：

tree UserCenterModule -L 2

生成目录结构如下：

UserCenterModule
├── Example
│   ├── UserCenterModule
│   ├── UserCenterModule.xcodeproj
│   ├── UserCenterModule.xcworkspace
│   ├── Podfile
│   ├── Podfile.lock
│   ├── Pods
│   └── Tests
├── UserCenterModule
│   ├── Assets
│   └── Classes
├── UserCenterModule.podspec
├── LICENSE
├── README.md
└── _Pods.xcodeproj -> Example/Pods/Pods.xcodeproj

10 directories, 5 files

项目包含了UserCenterModule和Example目录。
UserCenterModule/Classes目录：存放组件相关的类。
UserCenterModule/Assets目录：存放资源文件。
Example目录:存放例子。

这里向UserCenterModule/Classes添加UserCenterRouter.h和UserCenterRouter.m文件，
然后执行pod update。
注：每当你向UserCenterModule中添加了新的文件或者以后更新了podspec的版本都需要重新执行一遍pod update命令。

测试后，将项目push到远程仓库：

git add .
$ git commit -s -m "Initial Commit of Library"
$ git remote add origin git@playjoy.top:wangchao/UserCenterModule.git           #添加远端仓库
$ git push origin master

因为podspec文件中获取Git版本控制的项目还需要tag号，所以我们要打上一个tag

$ git tag -m "first release" 0.1.0
$ git push --tags     #推送tag到远端仓库

接下来编辑podspec文件

Pod::Spec.new do |s|
  s.name             = 'UserCenterModule'
  s.version          = '0.1.0'
  s.summary          = 'Just Testing.'

# 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
                        Testing Private Podspec.
                       DESC

  s.homepage         = 'http://playjoy.top/wangchao/UserCenterModule'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'nickwang' => 'wdc1906231682@163.com' }
  s.source           = { :git => 'http://playjoy.top/wangchao/UserCenterModule.git', :tag => s.version.to_s }
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'

  s.ios.deployment_target = '8.0'

  s.source_files = 'UserCenterModule/Classes/**/*'
  
  # s.resource_bundles = {
  #   'UserCenterModule' => ['UserCenterModule/Assets/*.png']
  # }

  # s.public_header_files = 'Pod/Classes/**/*.h'
  s.frameworks = 'UIKit'
  s.dependency 'MGJRouter', '~> 0.10.0'
end

编辑完podspec文件后，需要验证一下这个文件是否可用:

pod lib lint

如果有以下提示就说明podspec是正确的

UserCenterModule passed validation.

本地测试podspec文件

创建一个新的项目TestModule，在这个项目的Podfile文件中直接指定刚才创建编辑好的podspec文件，看是否可用。Podfile文件：

platform :ios, '8.0'
target "TestModule" do
    pod 'UserCenterModule', :path => '~/UserCenterModule'
end

然后执行pod install命令安装依赖，打开项目工程，可以看到库文件都被加载到Pods子项目中了，不过它们并没有在Pods目录下，而是跟测试项目一样存在于Development Pods/UserCenterModule中。

创建私有Spec Repo

什么是Spec Repo？
他是所有的Pods的一个索引，就是一个容器，所有公开的Pods都在这个里面，他实际是一个Git仓库[remote端]在GitHub上，但是当你使用了Cocoapods后他会被clone到本地的~/.cocoapods/repos目录下,
看一个例子，我的~/.cocoapods/repos下面有个HomePageModuleSpecspec仓库,它的目录结构为：

➜  repos tree HomePageModuleSpec -L 3
HomePageModuleSpec
└── HomePageModule
    └── 0.1.0
        └── HomePageModule.podspec

2 directories, 1 file

因此，我们也需要创建一个这样的spec repo:
1.先去gitlab创建一个项目，名称为UserCenterModule
2.copy项目git地址为：http://playjoy.top/wangchao/UserCenterModuleSpecs.git
3.执行如下命令：

pod repo add UserCenterModuleSpecs http://playjoy.top/wangchao/UserCenterModuleSpecs.git

此时如果成功的话进入到~/.cocoapods/repos目录下就可以看到UserCenterModuleSpecs这个目录了。

向Spec Repo提交podspec

接下来向我们的私有Spec Repo提交podspec,到UserCenterModule目录下执行以下命令：

pod repo push UserCenterModuleSpecs UserCenterModule.podspec  #前面是本地Repo名字 后面是podspec名字

完成之后这个组件库就添加到我们的私有Spec Repo中了，可以进入到~/.cocoapods/repos/UserCenterModuleSpecs目录下查看：

➜  repos tree UserCenterModuleSpecs -L 3
UserCenterModuleSpecs
└── UserCenterModule
    └── 0.1.0
        └── UserCenterModule.podspec

2 directories, 1 file

再去看我们的Spec Repo远端仓库，也有了一次提交，这个podspec也已经被Push上去了。

至此，我们的这个组件库就已经制作添加完成了，使用pod search命令就可以查到我们自己的库了。如果查不到的话执行下面命令然后重新pod search：

rm ~/Library/Caches/CocoaPods/search_index.json
pod search UserCenterModule

使用制作好的Pod

在完成这一系列步骤之后，我们就可以在正式项目中使用这个私有的Pod了只需要在项目的Podfile里增加以下一行代码即可

pod 'UserCenterModule', '~> 0.1.0'

然后执行pod update，更新库依赖，然后打卡项目可以看到，我们自己的库文件已经出现在Pods子项目中的Pods子目录下了，而不再是Development Pods。

更新维护podspec

我已经制作好了UserCenterModule的0.1.0版本，现在我对他进行升级工作，这次我添加了更多的模块到UserCenterModule之中，包括工具类，底层Model及UIKit扩展等，这里又尝试了一下subspec功能，给UserCenterModule创建了多个子分支。

具体做法是先将源文件添加到Pod/Classes中，然后按照不同的模块对文件目录进行整理，因为我有三个模块，所以在Pod/Classes下有创建了三个子目录，完成之后继续编辑之前的UserCenterModule.podspec，这次增加了subspec特性：

Pod::Spec.new do |s|
  s.name             = 'HomePageModule'
  s.version          = '0.2.0'
  s.summary          = 'Just Testing.'

# 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
                        Testing Private Podspec.
                       DESC

  s.homepage         = 'http://playjoy.top/wangchao/HomePageModule'
  # s.screenshots     = 'www.example.com/screenshots_1', 'www.example.com/screenshots_2'
  s.license          = { :type => 'MIT', :file => 'LICENSE' }
  s.author           = { 'nickwang' => 'wdc1906231682@163.com' }
  s.source           = { :git => 'http://playjoy.top/wangchao/HomePageModule.git', :tag => s.version.to_s }
  # s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'

  s.ios.deployment_target = '8.0'

  # s.source_files = 'HomePageModule/Classes/**/*'
  
  s.subspec 'Router' do |router|
      router.source_files = 'HomePageModule/Classes/Router/**/*'
      router.public_header_files = 'HomePageModule/Classes/Router/**/*.h'
      router.dependency 'MGJRouter', '~> 0.10.0'
  end

  s.subspec 'DataModel' do |dataModel|
      dataModel.source_files = 'HomePageModule/Classes/DataModel/**/*'
      dataModel.public_header_files = 'HomePageModule/Classes/DataModel/**/*.h'
  end

  s.subspec 'CommonTools' do |commonTools|
      commonTools.source_files = 'HomePageModule/Classes/CommonTools/**/*'
      commonTools.public_header_files = 'HomePageModule/Classes/CommonTools/**/*.h'
  end

  # s.resource_bundles = {
  #   'HomePageModule' => ['HomePageModule/Assets/*.png']
  # }

  # s.public_header_files = 'Pod/Classes/**/*.h'
  s.frameworks = 'UIKit'
  # s.dependency 'MGJRouter', '~> 0.10.0'
end

修改完成后，验证UserCenterModule.podspec

pod lib lint

验证成功后，提交到远端,打上tag：

git add .
git commit -am "update podspec"
git push origin master
git tag -m "second release" 0.2.0
git push --tags

提交成功后，将UserCenterModule.podspec提交到spec repo

pod repo push UserCenterModuleSpecs UserCenterModule.podspec

之后再次到~/.cocoapods/repos/UserCenterModuleSpecs目录下查看,已经有两个版本了。

删除私有Spec Repo

pod repo remove UserCenterModuleSpecs

将删除的Spec Repo添加回来

pod repo add UserCenterModuleSpecs http://playjoy.top/wangchao/UserCenterModuleSpecs.git

删除私有Spec Repo下的某一个podspec

rm -rf  UserCenterModuleSpecs/ UserCenterModule

然后在将Git的变动push到远端仓库即可

git add .
git commit -am "remove unuseful pods"
git push origin master

遇到问题

1.pod lib lint 失败

➜  NWTestModule git:(master) ✗ pod lib lint

 -> NWTestModule (0.1.0)
    - WARN  | description: The description is shorter than the summary.
    - ERROR | [iOS] xcodebuild: Returned an unsuccessful exit code. You can use `--verbose` for more information.
    - NOTE  | xcodebuild:  note: Using new build system
    - NOTE  | [iOS] xcodebuild:  note: Planning build
    - NOTE  | [iOS] xcodebuild:  note: Constructing build description
    - NOTE  | [iOS] xcodebuild:  warning: Skipping code signing because the target does not have an Info.plist file. (in target 'App')
    - NOTE  | [iOS] xcodebuild:  error:
    - ERROR | [iOS] xcodebuild:  /Users/nickwang/NWTestModule/NWTestModule/Classes/TestModule.m:10:9: error: 'MBProgressHUD.h' file not found with <angled> include; use "quotes" instead

这是因为在引入第三方库的时候，使用"<>"引入的，换成双引号就可以了，比如：

#import <MBProgressHUD.h>

换成

#import "MBProgressHUD.h"

2.使用pod lib lint本地已经验证podspec文件通过，但是当push到远端的时候老是报这个奇怪的错误：

pod repo push NWSpes NWTestModule.podspec

报错：

[!] The `NWTestModule.podspec` specification does not validate.

这个错误可以忽略：

pod repo push NWSpes NWTestModule.podspec --allow-warnings

哎，这个奇葩错误折腾了很久。。。
2.pod search UserCenterModule 搜不到，解决办法：

rm ~/Library/Caches/CocoaPods/search_index.json
pod search UserCenterModule

3.pod search能搜到，但是pod install出错，报以下错误：

[!] Unable to find a specification for `UserCenterModule (~> 0.2.0)`

解决办法：

参考链接

iOS制作私有组件

1.创建私有Pod项目

本地测试podspec文件

创建私有Spec Repo

向Spec Repo提交podspec

使用制作好的Pod

更新维护podspec

删除私有Spec Repo

将删除的Spec Repo添加回来

删除私有Spec Repo下的某一个podspec

遇到问题

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读