如何创建私有的Pod

archives, ios development

公司的框架代码大多数时候是需要保密的，而手动的复制导入比较麻烦，这时候我们可以创建私有 Pod 来方便我们的日常开发工作，本文是我创建私有 Pod 的笔记。

Cocoapods 提供了 pod lib create [pod name] 来创建私有库工程，但是有个 embedded dylibs/frameworks are only supported on iOS 8.0 and later 的问题。 意思是只有部署 iOS 8 以上的应用才能使用它，所以要支持 iOS 8 以下的应用的 Pod 我们还是得手动创建，详细步骤如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

$ mkdir AJFrame

// Create static library
Xcode > File > New > Project... > Framework & Library > Cocoa Touch Static Libray 

// Create dev app
Xcode > File > New > Project... > Single View Application

// Result 
AJFrame
├── AJFrame
│   ├── AJFrame.xcodeproj
│   ├── AJFrameTests
│   ├── Classes
├── AJFrame.podspec
├── AJFrameDevApp
│   ├── AJFrameDevApp
│   ├── AJFrameDevApp.xcodeproj
│   ├── AJFrameDevApp.xcworkspace
│   ├── AJFrameDevAppTests
│   ├── Podfile
│   ├── Podfile.lock
│   └── Pods
└── LICENSE

Cocoapods 工作依赖于两个文件：

  1. podspec:一个pod的配置是什么，pod的代码放在哪里
  2. Podfile:项目依赖哪个pod，以何种方式依赖，它的podspec放在哪里

创建podspec文件

1

pod spec create [NAME|https://github.com/USER/REPO] --verbose

然后编辑podspecs文件，具体可以参考它的详细语法，这里有几个地方需要注意：

1
2
3
4
5
6
7
8

// s.source指定工程的源码地址,这里路径有些怪异是因为我的git server是布署在Windows上的。
s.source  = { :git => "ssh://dongmeiliang@192.168.1.100:/git/ICW/Git/AJFrame.git", :tag => s.version.to_s }

// s.source_files指定哪些源文件需要包含在pod中
s.source_files  = "AJFrame/classes/*.{h,m}"

// pod的依赖
s.dependency "JSONKit", "~> 1.4"

可以使用命令 pod lib lint --verbose 来验证 podspecs 文件。

开发静态库

编辑辅助开发静态库应用工程的 Podfile，具体可以参考它的详细语法 ,让它使用安装链接静态库.

1
2
3
4
5
6

target 'AJFrameDevApp' do
    pod 'AJFrame', :path => '../'
end

$ cd ~/Documents/AJFrame/AJFrameDevApp/
$ pod install --no-repo-update --verbose

测试

开发完成以后，可以创建一个测试工程来测试私有 Pod 是否能正常工作，具体而言,通常是在创建一个远程仓库，把私有 Pod 的代码推送上去，然后创建一个新的工程，让它安装这个私有 Pod ，然后写些测试代码，测试它能否正常工作。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

// Remote 
$ cd /Git
$ git init --bare AJFrame.git

// Local
$ cd ~/Documents/AJFrame
$ git init 
$ git add .
$ git commit
$ git tag <tagname>
$ git remote add origin <url>
$ git push -u origin master --tags --verbose

// Edit dependency project's Podfile, add a similary line
pod 'AJFrame', :git => 'ssh://192.168.1.100:/git/ICW/Git/AJFrame.git', :tag => '2.0.0'
$ pod install --no-repo-update --verbose
$ write code and test

发布

发布是可选的，但是当我们有其他的 Pod 想依赖开发的这个私有 Pod 时就变成必须的，所以我们还是得会发布一个私有 Pod。具体步骤如下：

1
2
3
4
5
6
7
8
9
10
11
12
13

// Create a Private Spec Repo  
$ cd /Git  
$ git init --bare Specs.git

// Add your Private Repo to your CocoaPods installation
$ pod repo add aijian-specs ssh://192.168.1.105:/git/ICW/Git/Specs.git --verbose

// Check your installation is successful and ready to go
$ cd ~/.cocoapods/repos/aijian-specs
$ pod repo lint .

// Add your Podspec to your repo
pod repo push aijian-specs AJFrame.podspec

在工程中使用它时，编辑 Podfile， 加入如下内容：

1
2
3

source ssh://192.168.1.105:/git/ICW/Git/Specs.git

pod 'AJFrame', '~> 2.0.0'

定期更新 master repo

使用过 pod 的同学应该都知道如果在安装的时候去更新 master repo 的话安装过程比较久，那我们能不能定时去预先更新 master repo 呢？当然可以。我们可以写个更新脚本让 launchd 定时去执行，详细步骤如下：

  1. 编写更新 master repo 脚本
    • 脚本我放在 /usr/local/bin
    • chmod a+x update-pod-repo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

#!/bin/bash
# This script used for update pod repo!
# View log with command: syslog -C
# Reference:http://stackoverflow.com/questions/16818427/write-to-mac-os-x-console-logs-from-shell-script-or-command-line

syslog -s -k Facility com.apple.console \
             Level Error \
             Sender update-pod-repo \
             Message "Starting update master pod repo..."

pod repo update master

syslog -s -k Facility com.apple.console \
             Level Error \
             Sender update-pod-repo\
             Message "Ending update master pod repo."
  1. 定时执行脚本
    Mac 下推荐的定时执行脚本的方法是 launchd，所以这里我们使用 launchd 来定时执行我们的脚本。
  2. 编写 launchd.plist
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
        <dict>
                <key>Label</key>
                <string>com.dongmeiliang.update-pod-repo</string>
                <key>Program</key>
                <string>/usr/local/bin/update-pod-repo</string>
                <key>StartCalendarInterval</key>
                <array>
                        <dict>
                                <key>Minute</key>
                                <integer>10</integer>
                        </dict>
                        <dict>
                                <key>Hour</key>
                                <integer>12</integer>
                        </dict>
                </array>
        </dict>
</plist>
  • 检查 plist 文件语法是否正确
1

$ plutil -lint ~/Library/LaunchAgents/com.dongmeiliang.update-pod-repo.plist
  • 加载 plist 文件，以便无需重启机器就能定时执行我们的脚本
1
2
3

$ launchctl load -w ~/Library/LaunchAgents/com.dongmeiliang.update-pod-repo.plist
// Check plist has been install successfully
$ launchctl list | grep 'com.dongmeiliang.update-pod-repo'

s.dependency 如何依赖私有 Pod？

  1. Create a Private Spec Repo
1
2
3
4

$ cd /opt/git  
$ mkdir Specs.git  
$ cd Specs.git
$ git init --bare
  1. Add your Private Repo to your CocoaPods installation
1
2
3

$ pod repo add artsy-specs git@github:artsy/Specs.git

$ pod repo add aijian-specs ssh://192.168.1.105:/git/ICW/Git/Specs.git --verbose

Check your installation is successful and ready to go:

1
2

$ cd ~/.cocoapods/repos/artsy-specs
$ pod repo lint .
  1. Add your Podspec to your repo
1

pod repo push artsy-specs ~/Desktop/Artsy+OSSUIFonts.podspec

Your private Pod is ready to be used in a Podfile. You can use the spec repository with the source directive in your Podfile as shown in the following example:

1

source 'URL_TO_REPOSITORY'

Solution Reference

Reference

Using Pod Lib Create
The Podfile
CocoaPods进阶：本地包管理
用CocoaPods做iOS程序的依赖管理
Cocoapods 入门
Using Launchd to run a script every 5 mins on a Mac