如何快速创建Podspec文件

简介

• 私有库创建时对应项目的podspec文件书写

#
#  Be sure to run `pod spec lint new.podspec' to ensure this is a
#  valid spec and to remove all comments including this before submitting the spec.
#
#  To learn more about Podspec attributes see https://docs.cocoapods.org/specification.html
#  To see working Podspecs in the CocoaPods repo see https://github.com/CocoaPods/Specs/
#

Pod::Spec.new do |spec|

  # ―――  Spec Metadata  ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  These will help people to find your library, and whilst it
  #  can feel like a chore to fill in it's definitely to your advantage. The
  #  summary should be tweet-length, and the description more in depth.
  #

  spec.name         = "new"
  spec.version      = "0.0.1"
  spec.summary      = "A short description of new."

  # 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!
  spec.description  = <<-DESC
                   DESC

  spec.homepage     = "http://EXAMPLE/new"
  # spec.screenshots  = "www.example.com/screenshots_1.gif", "www.example.com/screenshots_2.gif"


  # ―――  Spec License  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Licensing your code is important. See https://choosealicense.com for more info.
  #  CocoaPods will detect a license file if there is a named LICENSE*
  #  Popular ones are 'MIT', 'BSD' and 'Apache License, Version 2.0'.
  #

  spec.license      = "MIT (example)"
  # spec.license      = { :type => "MIT", :file => "FILE_LICENSE" }


  # ――― Author Metadata  ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the authors of the library, with email addresses. Email addresses
  #  of the authors are extracted from the SCM log. E.g. $ git log. CocoaPods also
  #  accepts just a name if you'd rather not provide an email address.
  #
  #  Specify a social_media_url where others can refer to, for example a twitter
  #  profile URL.
  #

  spec.author             = { "Holaween" => "lianghwen@live.cn" }
  # Or just: spec.author    = "Holaween"
  # spec.authors            = { "Holaween" => "lianghwen@live.cn" }
  # spec.social_media_url   = "https://twitter.com/Holaween"

  # ――― Platform Specifics ――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If this Pod runs only on iOS or OS X, then specify the platform and
  #  the deployment target. You can optionally include the target after the platform.
  #

  # spec.platform     = :ios
  # spec.platform     = :ios, "5.0"

  #  When using multiple platforms
  # spec.ios.deployment_target = "5.0"
  # spec.osx.deployment_target = "10.7"
  # spec.watchos.deployment_target = "2.0"
  # spec.tvos.deployment_target = "9.0"


  # ――― Source Location ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Specify the location from where the source should be retrieved.
  #  Supports git, hg, bzr, svn and HTTP.
  #

  spec.source       = { :git => "http://EXAMPLE/new.git", :tag => "#{spec.version}" }


  # ――― Source Code ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  CocoaPods is smart about how it includes source code. For source files
  #  giving a folder will include any swift, h, m, mm, c & cpp files.
  #  For header files it will include any header in the folder.
  #  Not including the public_header_files will make all headers public.
  #

  spec.source_files  = "Classes", "Classes/**/*.{h,m}"
  spec.exclude_files = "Classes/Exclude"

  # spec.public_header_files = "Classes/**/*.h"


  # ――― Resources ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  A list of resources included with the Pod. These are copied into the
  #  target bundle with a build phase script. Anything else will be cleaned.
  #  You can preserve files from being cleaned, please don't preserve
  #  non-essential files like tests, examples and documentation.
  #

  # spec.resource  = "icon.png"
  # spec.resources = "Resources/*.png"

  # spec.preserve_paths = "FilesToSave", "MoreFilesToSave"


  # ――― Project Linking ―――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  Link your library with frameworks, or libraries. Libraries do not include
  #  the lib prefix of their name.
  #

  # spec.framework  = "SomeFramework"
  # spec.frameworks = "SomeFramework", "AnotherFramework"

  # spec.library   = "iconv"
  # spec.libraries = "iconv", "xml2"


  # ――― Project Settings ――――――――――――――――――――――――――――――――――――――――――――――――――――――――― #
  #
  #  If your library depends on compiler flags you can set them in the xcconfig hash
  #  where they will only apply to your library. If you depend on other Podspecs
  #  you can include multiple dependencies to ensure it works.

  # spec.requires_arc = true

  # spec.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" }
  # spec.dependency "JSONKit", "~> 1.4"

end

• 以上为标准生成的podspec文件结构，生成代码为

pod spec create PODSPEC_NAME

结构说明

Spec Metadata

• 私有库基本描述内容，以下为必要内容
  • name 私有库名称 必须和文件名称相同
  • version 版本 对应git项目中的tag
  • summary 总结
  • description 详细描述 必须长于总结
  • homepage 主页 用git上的页面即可

Spec License

• license 证书

  s.license      = {
    			:type => 'Copyright',
    			:text => <<-LICENSE
             	 			© 1990-2019 Company. All rights reserved.
    			LICENSE
  			}	     		

Author Metadata

• authors 作者

  spec.authors = {'Darth Vader' => 'darthvader@darkside.com',
                 		'Wookiee'    => 'wookiee@aggrrttaaggrrt.com' }	     		

Platform Specifics

• platform 对应平台，必须指明iOS版本

  s.platform     = :ios, "9.0"	     		

Source Location

• source pod下载代码的地址 尾部tag指定为version

  s.source       = { :git => "http://EXAMPLE/new.git", :tag => "#{s.version}" }	     		

  可以指定branch，但是不推荐。

Source Code

• source_files 私有库代码文件

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

* 指定的文件必须为可编译的代码文件 * 注意格式： * \**在其中代表了所有文件夹 * \*为通配符

• subspec subspec内的文件必须可以单独编译成功

  subspec 'Twitter' do |sp|
   		sp.source_files = 'Classes/Twitter'
  end
  
  subspec 'Pinboard' do |sp|
   		sp.source_files = 'Classes/Pinboard'
  end

Resources － 非必要

• resources 资源文件 用于图片，声音类的资源 .h.m类文件放入资源不会被编译，指定形式与source code一样
• xib，storyboard文件也可以直接作为资源文件导入，导入时注意添加UIKit.frameworks

• xib导入时必须以resources导入一次，然后以resources_bundle导入一次
  • 使用时直接利用名称找到resource_bundles，然后利用bundle加载xib

s.resources = "File_Path/*.xib","File_Path/*.png"

s.resource_bundles = {'Resources' => ["File_Path/*.xib","File_Path/*.png"]}

// 使用
NSString *bundlePath = [[NSBundle mainBundle] pathForResource:@"Resources" ofType:@"bundle"];

NSBundle *bundle = [NSBundle bundleWithPath:bundlePath];

[[UIViewController alloc] initWithNibName:@"Xib_Name" bundle:bundle];

• 如果需要导入本地化.strings应该放入一个bundle中来实现

NSString *path = [[NSBundle mainBundle] pathForResource:@"Bundle_Name" ofType:@"bundle"];
NSBundle *bundle = [NSBundle bundleWithPath:path];
[bundle localizedStringForKey:@"Key" value:@"default value" table:@"Table_Name"];

Project Linking － 非必要

• frameworks libraries 用于添加系统的依赖库

  s.frameworks = "SomeFramework", "AnotherFramework"
  s.libraries = "iconv", "xml2"    		

• vendored_frameworks vendored_library 用于添加第三发依赖库

  s.vendored_frameworks = "SomeFramework", "AnotherFramework"
  s.vendored_library = "iconv", "xml2"    		

Project Settings

• s.requires_arc = true 现在这条基本必加了

• xcconfig 对应项目的一些配置

  s.xcconfig = { "HEADER_SEARCH_PATHS" => "$(SDKROOT)/usr/include/libxml2" } 		

• dependency 其它依赖库

  s.dependency "JSONKit", "~> 1.4"		

• 注意：
  • 如果为私有库需要指定好source，branch 或 tag
  • 如果私有库的podspec文件以官方形式维护，示例方式即可

参考文档

格式检查 （非常重要）

• 编辑完成之后 需要先检查格式无误 编译能够通过 才能上传 否者上传会失败

  • 检查方式

  pod spec lint .PODSPEC_FILE_ADDRESS	

• 相关参数：
  • –verbose 查看编译的详情 以理清错误
  • –allow-warnings 允许编译警告
  • –use-libraries 通常用于避免i386 x86的编译错误
  • –sources=”SOURCE_URL, SOURCE_URL” 如果包含私有库的dependency必须加入该参数