podSpec文件相关知识整理

上一篇文章整理了我用SVN创建私有库的过程，本文将整理一下有关podSpec文件的相关知识。

podSpec中spec的全称是“Specification”，说明书的意思。顾名思义，这是用来描述你这个私有pod的说明信息的。
podSpec是cocoapods的一种文件格式，有一套自己的语法，我们可以到cocoapods官网进行详细了解（https://guides.cocoapods.org/syntax/podspec.html）。

创建podSpec很简单，只要创建一个以.podSpec为后缀的文件即可，或者直接拷贝别人的进行修改也可以。

它的创建命令是：$pod spec create TestFile

podspec文件的常用配置字段介绍

Pod::Spec.new do|s|

框架名字：框架名字一定要写对，pod search "框架名"就是搜的这个

  s.name         = "yoowei"

框架版本号

  s.version      = "1.0.0"

框架简介

  s.summary      = "yoowei框架"

框架的主页

  s.homepage     = "https://git.oschina.net/yoowei"

框架遵守的开源协议

  s.license      = 'MIT'

框架的作者

  s.author       = { "yoowei" => "yoowei@126.com" }

 

框架的资源路径：路径可以指向远端代码库，也可以指向本地项目，例如：

                     1.指向远端代码库： { :git => "git@git.oschina.net:yoowei/yoowei.git", :tag => "1.0.0" }

                     2.指向本地项目：    { :path => 'yoowei', }

  s.source       = { :git => "git@git.oschina.net:yoowei/yoowei.git", :tag => "1.0.0" }

框架被其他工程引入时，会导入yoowei目录下的.h和.m文件

  s.source_files = 'yoowei/**/*.{h,m}'

框架被其他工程引入时，会导入yoowei/resource目录下的资源文件

  s.resources    = {

    'yoowei' => ['yoowei/resource/**/*.{storyboard,xcassets,xib,png']

  }

框架依赖的framework

  s.framework    = 'CoreData'

框架依赖的其他第三方库

  s.dependency 'MagicalRecord', :git => 'https://github.com/iiiyu/MagicalRecord.git', :tag => 'sumiGridDiary2.1'

  s.dependency 'MBProgressHUD'

框架是否需要支持ARC

  s.requires_arc = true

框架支持的最低平台版本

  s.platform     = :ios, '7.0'

框架公开的头文件

 s.public_header_files = 'yoowei/**/*.h'   


end

 

大型项目模块化管理

随着iOS APP越来越复杂，功能越来越多，对于iOS项目的工程化要求也越来越高了，对于复杂的APP一般都需要对项目进行模块化管理。

模块化有几个方式：

1. 目录结构管理：这是最原始的方式，仅仅通过目录结构实现代码层次的清晰化。但本质上并没有解决代码之间的依赖混乱的情况，模块化划分也非常不清晰。

2. 子工程：通过子工程可以实现代码依赖管理和模块化，但是需要引入复杂的设置，不利于管理。

3. 静态库：将依赖代码打包成为静态库.a，不过由于不能看到源码，调试不方便。

自从有了CocoaPods，可以使用它来管理私有库，从而实现了代码模块化管理。例如下图所示：

 

 

CocoaPods私有库

1. 创建私有的Specs git库

　　例如在github上面创建一个空的git库：https://github.com/xxx/MySpecs

　　将这个git库加入到CocoaPods库的列表中：

pod repo add MySpecs git@github.com:xxx/MySpecs.git

　　此时可以检查下本地的pod repo

<br class="Apple-interchange-newline">$ pod repo list<br><br>MySpecs

- Type: git (master)- URL: git@github.com:xxx/MySpecs.git

- Path: /Users/xxx/.cocoapods/repos/mySpecs

master

- Type: git (master)

- URL:  git@github.com:CocoaPods/Specs.git

- Path: /Users/xxx/.cocoapods/repos/master

　　确定私有库的Specs已经加到本地pod repo中。 

2. 在私有库项目中创建podspec文件

在私有库项目中的根目录，创建对应的podspec文件，里面会描述这个库的基本信息。

PodSpec规范可以查看：https://guides.cocoapods.org/syntax/podspec.html

Pod::Spec.new do |s|

  s.name         = "PodName"

  s.version      = "0.0.1"

  s.summary      = "A short description of PodName."

  s.homepage     = "http://github.com/xxx/PodName"

  s.license      = { :type => "MIT", :text => <<-LICENSE

    Copyright © 2016年 xxx. All rights reserved.

    LICENSE

     }

  s.author       = { "" => "" }

  s.source       = { :git => "git@github.com:xxx/PodName.git", :tag => "0.0.1" }

  s.source_files = "**/*.{h,m,mm,c}"

  s.frameworks   = "Foundation", "QuartzCore", "UIKit", "WebKit"

  s.libraries    = "z"

  

  s.dependency 'AFNetworking'

  s.ios.deployment_target = '6.0'

end

resource: 可以指定资源文件，建议使用bundle以避免资源文件产生冲突。

frameworks: 指定这个pod依赖的系统framework

libraries: 指定这个pod依赖的系统动态库。注意使用的名字：比如需要引用"libz.dylib", 那么这里只需要写"z"

 

无论原始项目的目录结构或者group结构，默认的pod里面的代码都会平铺在根目录里面

如果需要增加目录层次结构，则需要使用subspec，详细使用规范：https://guides.cocoapods.org/syntax/podspec.html#subspec

注意：SubSpecs之间不能存在相互依赖关系，只能单向依赖

 

3. 验证私有库的合法性

pod lib lint --sources='git@github.com:xxx/MySpecs.git' --verbose --use-libraries --allow-warnings

sources参数可以指定私有库的Pod Specs库的地址。如果能够通过，说明代码编译没有问题

4. 提交私有库的版本信息

git tag -m "first release" "0.0.1"

$ git push --tags     #推送tag到远端仓库

 

 

5. 向Spec Repo提交podspec

pod repo push MySpecs PodName.podspec --sources='git@github.com:xxx/MySpecs.git' --use-libraries --allow-warnings

这样就完成了一个CocoaPods的私有库的提交了，别人就可以在Podfile里面使用这个私有库了。