[关闭]
@yanzhiwei147 2019-09-17T12:04:24.000000Z 字数 11039 阅读 4501

SDK开发者引入包依赖管理开发流程

CocoaPods tips SDK

ps：本文以IMSDK为例，基于SDK目录结构规范、cocoapods 0.36.4开发
ps2：本文成果传送门
ps3：本文阅读储备知识：Cocoapods三种语法、git操作、语义化版本
ps4：本文严格限定SDK使用第三方库版本
ps5：本文涉及到git远端操作的均使用HTTP形式，使用SSH形式请移步此处完成配置

安装CocoaPods

配置CocoaPods

  1. $ pod repo add sdp_repo http://git.sdp.nd/cocoapods/spec.git

创建SDK工程

本步骤基于xcode6.1.1

配置Podfile

  1. $ pod init
  1. source 'https://github.com/CocoaPods/Specs.git'
  2. source 'http://git.sdp.nd/cocoapods/spec.git'
  1. # 只能安装在可运行target上（单元测试以及App等），其他比如静态库不需要链接因而决不能安装
  2. pod 'UCSDK',     '~> 0.3.1'
  1. source 'https://github.com/CocoaPods/Specs.git'
  2. source 'http://git.sdp.nd/cocoapods/spec.git'
  3. # 注意只能安装可运行的target
  4. target 'IMSDKTests' do
  5.     pod 'UCSDK',     '~> 0.3.1'
  6. end

安装依赖

  1. $ pod install

工程配置

静态库的target（此处为IMSDK）没有收到安装依赖的益处，因此我们需要配置一些项目（IMSDK.xcodeproj上的IMSDK必须能不依赖workspace进行编译）：

  1. "$(SRCROOT)/Pods/Headers/Public"

经过上面搜索路径的配置，现在Xcode就能正常找到所有依赖的第三方包的头文件

开发

SDK生成

使用SDK顶层目录下的build.sh（内容见附录）进行打包，命令如下：

  1. // 更多功能使用-h进行查看
  2. $ sh build.sh -r IMSDKBundle

打包完毕后会在顶层目录下生成一个output目录，生成的framework以及resources都在该文件夹中。
output目录结构如下：

  1. ├── framework
  2. │   ├── Headers -> Versions/Current/Headers
  3. │   ├── IMSDK -> Versions/Current/IMSDK
  4. │   └── Versions
  5. └── resources
  6.     └── IMSDKBundle.bundle
  8. 5 directories, 1 file

SDK发布

配置本地podspec

  1. $ pod spec create IMSDK
  1. s.name         = "IMSDK"
  2. s.version      = "0.0.1"
  3. s.platform     = :ios, "6.0"
  4. s.summary      = "IMSDK官方版"  
  5. s.author       = "IMSDK团队"  
  6. s.homepage     = "http://git.sdp.nd/cocoapods/imsdk"
  7. s.license      = "MIT"
  8. s.source       = { :git => "http://git.sdp.nd/cocoapods/imsdk.git", :tag => "#{s.version}" }
  9. s.public_header_files = "#{s.name}.framework/Versions/A/**/*.h"
  10. s.preserve_paths = "*.framework"
  11. s.vendored_frameworks = "#{s.name}.framework"
  12. s.resources = "IMSDKBundle.bundle"
  13. s.dependency "MUPFoundation", "~> 0.3.6"
  14. s.dependency "SmartCan", "~> 0.3.4"
  1. $ pod ipc spec IMSDK.podspec >> IMSDK.podspec.json

发布framework

创建framework项目
版本库配置
  1. $ mkdir IMSDK
  2. $ cd IMSDK
  3. $ git init
  1. $ git remote add origin http://git.sdp.nd/cocoapods/imsdk.git
  1. $ touch README.md
  2. $ git add README.md IMSDK.framework IMSDKBundle.bundle IMSDK.podspec
  1. $ git commit -m "提交0.0.1版本发布（二进制库）"
  1. $ git tag -a 0.0.1 -m "tag 0.0.1版本"
  1. // 同步本地branch至远端
  2. $ git push -u origin master
  3. // 把本地库所有tag同步至远端
  4. $ git push --tag

发布podspec

部署podspec
  1. $ pod spec lint --use-libraries --allow-warnings --sources="https://github.com/CocoaPods/Specs.git,http://git.sdp.nd/cocoapods/spec.git" IMSDK.podspec
  1. $ pod repo push  sdp_repo IMSDK.podspec --use-libraries --allow-warnings

SDKDemo开发

版本库规范

FAQ

为什么静态库的target不能安装pod依赖？

附录

build.sh脚本

  1. #!/bin/sh
  3. SDK_ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
  5. case $SDK_ROOT_DIR in  
  6.      *\ * )
  7.            echo "您的路径中包含空格，像'make install'是不被支持的."
  8.            exit 1
  9.           ;;
  10. esac
  12. ###########################################################################
  13. #
  14. # 模拟器支持架构
  15. SIMULATOR_ARCHS="i386 x86_64"
  16. #
  17. # 真机支持架构
  18. IPHONEOS_ARCHS="armv7 armv7s arm64"
  19. #
  20. # 编译使用的SDK
  21. SDK_NAME="iphoneos8.1"
  22. #
  23. # 编译产品路径，指定指定build目录（默认为脚本所在目录下的build）
  24. BUILT_PRODUCTS_DIR="${SDK_ROOT_DIR}/build"
  25. #
  26. # 当前framework版本，一般使用字母递增来表示
  27. FRAMEWORK_VERSION="A"
  28. #                                                                         
  29. ###########################################################################
  31. function show_version() {
  32.         echo "version: 1.1"
  33.         echo "updated date: 2015-04-20"
  34. }
  36. function show_usage() {
  37.         echo "Usage(暂时不支持长选项):\n"
  38.         echo "`printf %-16s "    $ $0"` argument\n" 
  39.         echo "Description:"
  40.         echo "`printf %-16s ` [-h|--help] 显示帮助信息"
  41.         echo "`printf %-16s ` [-v|-V|--version] 显示版本"
  42.         echo "`printf %-16s ` [-c|--configuration ... ] 指定编译配置"
  43.         echo "`printf %-16s ` [-p|--project ... ] 指定编译工程"
  44.         echo "`printf %-16s ` [-P|--frameworkproduct ... ] 指定生成framework产品名"
  45.         echo "`printf %-16s ` [-t|--frameworktarget ... ] 指定需要编译framework的target名"
  46.         echo "`printf %-16s ` [-r|--resourcetarget ... ] 指定资源编译target名"
  47. }
  49. # Call this when there is an error.  This does not return.
  50. function die() {
  51.   echo ""
  52.   echo "FATAL: $*" >&2
  53.   exit 1
  54. }
  56. # 工程名，用以指定需要编译的project
  57. PROJECT_NAME=""
  59. # target名，用以指定需要编译的target，默认与工程名一致
  60. TARGET_NAME=""
  62. # 产品名，用以指定需要编译的target，默认与target名一致
  63. PRODUCT_NAME=""
  65. # 配置，用以指定编译代码的配置
  66. CONFIGURATION=""
  68. # 资源名
  69. RESOURCE_NAME=""
  71. # 编译所有target标识
  72. ALLTARGETS_FLAG=0
  74. # 参数列表
  75. while getopts ":hvVac:p:P:t:r:" OPTNAME
  76. do
  77.   case "$OPTNAME" in
  78.     "h")
  79.       show_usage && exit
  80.       ;;
  81.     "v")
  82.       show_version && exit
  83.       ;;
  84.     "V")
  85.       show_version && exit
  86.       ;;
  87.     "c")
  88.       CONFIGURATION=$OPTARG
  89.       ;;
  90.     "p")
  91.       PROJECT_NAME=$OPTARG
  92.       ;;
  93.     "P")
  94.       PRODUCT_NAME=$OPTARG
  95.       ;;
  96.     "t")
  97.       TARGET_NAME=$OPTARG
  98.       ;;
  99.     "r")
  100.       RESOURCE_NAME=$OPTARG
  101.       ;;
  102.     "?")
  103.       show_usage && exit
  104.       ;;
  105.     ":")
  106.       echo "选项$OPTARG缺少输入参数"
  107.       die
  108.       ;;
  109.     *)
  110.     # Should not occur
  111.       echo "处理选项过程发生未知错误"
  112.       die
  113.       ;;
  114.   esac
  115. done
  117. XCODEPROJ_SEARCH_RESULT=`find . -name "*.xcodeproj" -d 1`
  118. if [ -n "${XCODEPROJ_SEARCH_RESULT}" ]; then
  119.   FILENAME="`basename ${XCODEPROJ_SEARCH_RESULT}`"
  120.   XCODEPROJ_NAME="${FILENAME%.*}"
  121. fi
  123. test -n "${CONFIGURATION}"    || CONFIGURATION="Release"
  124. test -n "${PROJECT_NAME}"     || PROJECT_NAME="${XCODEPROJ_NAME}"
  125. test -n "${TARGET_NAME}"      || TARGET_NAME="${PROJECT_NAME}"
  126. test -n "${PRODUCT_NAME}"     || PRODUCT_NAME="${TARGET_NAME}"
  127. test -n "${RESOURCE_NAME}"    || RESOURCE_NAME=""
  129. # echo "${CONFIGURATION}\n${PROJECT_NAME}\n${PRODUCT_NAME}\n${TARGET_NAME}\n${RESOURCE_NAME}\n"
  131. set -e
  132. set +u
  133. # 避免递归调用
  134. if [[ $SF_MASTER_SCRIPT_RUNNING ]]
  135. then
  136. exit 0
  137. fi
  138. set -u
  139. export SF_MASTER_SCRIPT_RUNNING=1
  141. DEVELOPER=`xcode-select -print-path`
  143. if [ ! -d "$DEVELOPER" ]; then
  144.   echo "xcode路径没有被设置正确，$DEVELOPER不存在"
  145.   echo "运行"
  146.   echo "sudo xcode-select -switch <xcode path>"
  147.   echo "来进行默认安装:"
  148.   echo "sudo xcode-select -switch /Applications/Xcode.app/Contents/Developer"
  149.   exit 1
  150. fi
  152. SDK_IPHONEOS="iphoneos"
  153. SDK_IPHONESIMULATOR="iphonesimulator"
  155. # The following conditionals come from
  156. # https://github.com/kstenerud/iOS-Universal-Framework
  157. if [[ "$SDK_NAME" =~ ([A-Za-z]+) ]]
  158. then
  159. SF_SDK_PLATFORM=${BASH_REMATCH[1]}
  160. else
  161. echo "Could not find platform name from SDK_NAME: $SDK_NAME"
  162. exit 1
  163. fi
  165. if [[ "$SDK_NAME" =~ ([0-9]+.*$) ]]
  166. then
  167. SF_SDK_VERSION=${BASH_REMATCH[1]}
  168. else
  169. echo "Could not find sdk version from SDK_NAME: $SDK_NAME"
  170. exit 1
  171. fi
  173. if [[ "$SF_SDK_PLATFORM" = "iphoneos" ]]
  174. then
  175. SF_OTHER_PLATFORM=iphonesimulator
  176. else
  177. SF_OTHER_PLATFORM=iphoneos
  178. fi
  180. function buildFramework() {
  181.   xcodebuild -project ./$PROJECT_NAME.xcodeproj -target $TARGET_NAME -sdk $SDK_IPHONEOS -configuration $CONFIGURATION ARCHS="${IPHONEOS_ARCHS}" build
  183.   xcodebuild -project ./$PROJECT_NAME.xcodeproj -target $TARGET_NAME -sdk $SDK_IPHONESIMULATOR -configuration $CONFIGURATION ARCHS="${SIMULATOR_ARCHS}" build  
  184. }
  186. function buildBundle() {
  188.   xcodebuild -project ./$PROJECT_NAME.xcodeproj -target $RESOURCE_NAME -sdk $SDK_IPHONEOS -configuration $CONFIGURATION ARCHS="${IPHONEOS_ARCHS}" build
  189. }
  191. function copyFramework() {
  192.   # prepare_framework
  193.   mkdir -p "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework/Versions/${FRAMEWORK_VERSION}/Headers"
  195.   # Link the "Current" version to "${FRAMEWORK_VERSION}"
  196.   ln -sfh ${FRAMEWORK_VERSION} "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework/Versions/Current"
  197.   ln -sfh Versions/Current/Headers "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework/Headers"
  198.   ln -sfh "Versions/Current/${PRODUCT_NAME}" "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework/${PRODUCT_NAME}"
  200.   # The -a ensures that the headers maintain the source modification date so that we don't constantly
  201.   # cause propagating rebuilds of files that import these headers.
  202.   TARGET_BUILD_DIR="${BUILT_PRODUCTS_DIR}/${CONFIGURATION}-${SDK_IPHONEOS}"
  203.   cp -a "${TARGET_BUILD_DIR}/include/${PRODUCT_NAME}/" "${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}.framework/Versions/${FRAMEWORK_VERSION}/Headers"
  205.   # compile_framework
  206.   SF_TARGET_NAME=${PROJECT_NAME}
  207.   SF_EXECUTABLE_Name="lib${SF_TARGET_NAME}.a"
  208.   SF_WRAPPER_NAME="${SF_TARGET_NAME}.framework"  
  210.   PLATFORM_EXECUTABLE_PATH="${BUILT_PRODUCTS_DIR}/${CONFIGURATION}-${SF_SDK_PLATFORM}/${SF_EXECUTABLE_Name}"
  211.   OTHER_PLATFORM_EXECUTABLE_PATH="${BUILT_PRODUCTS_DIR}/${CONFIGURATION}-${SF_OTHER_PLATFORM}/${SF_EXECUTABLE_Name}"
  212.   OUTPUT_PATH="${BUILT_PRODUCTS_DIR}/${SF_WRAPPER_NAME}/Versions/${FRAMEWORK_VERSION}/${SF_TARGET_NAME}"
  214.   # Smash the two static libraries into one fat binary and store it in the .framework
  215.   lipo -create "${PLATFORM_EXECUTABLE_PATH}" "${OTHER_PLATFORM_EXECUTABLE_PATH}" -output "${OUTPUT_PATH}"
  217.   # Delete temporary folder if exists
  218.   FINAL_OUTPUT_PATH="output/framework/${SF_WRAPPER_NAME}"
  219.   if [ -d "${FINAL_OUTPUT_PATH}" ]
  220.   mkdir -p "${FINAL_OUTPUT_PATH}"
  221.   then
  222.   rm -dR "${FINAL_OUTPUT_PATH}"
  223.   fi
  225.   # Copy the binary to the other architecture folder to have a complete framework in both.
  226.   cp -a "${BUILT_PRODUCTS_DIR}/${SF_WRAPPER_NAME}" "${FINAL_OUTPUT_PATH}"
  227. }
  229. function copyBundle() {
  230.   # Resources path
  231.   RESOURCE_BUILD_PATH="${BUILT_PRODUCTS_DIR}/${CONFIGURATION}-${SF_SDK_PLATFORM}"
  233.   # Resources name
  234.   RESOURCE_PRODUCT_NAME="${RESOURCE_NAME}.bundle"
  236.   # Delete temporary folder if exists
  237.   FINAL_RESOURCE_OUTPUT_PATH="output/resources/${RESOURCE_PRODUCT_NAME}"
  238.   if [ -d "${FINAL_RESOURCE_OUTPUT_PATH}" ]
  239.   mkdir -p "${FINAL_RESOURCE_OUTPUT_PATH}"
  240.   then
  241.   rm -dR "${FINAL_RESOURCE_OUTPUT_PATH}"
  242.   fi
  244.   cp -a "${RESOURCE_BUILD_PATH}/${RESOURCE_PRODUCT_NAME}" "${FINAL_RESOURCE_OUTPUT_PATH}"
  245. }
  247. test -z "${PROJECT_NAME}" || (buildFramework && copyFramework)
  248. test -z "${RESOURCE_NAME}" || (buildBundle && copyBundle)

定制化gitignore文件

按照我们对git的版本控制的需要，我们写出如下的的.gitignore：

  1. # Xcode
  2. #
  3. build/
  4. output/
  5. .DS_Store
  6. .svn
  7. *.pbxuser
  8. !default.pbxuser
  9. *.mode1v3
  10. !default.mode1v3
  11. *.mode2v3
  12. !default.mode2v3
  13. *.perspectivev3
  14. !default.perspectivev3
  15. xcuserdata
  16. *.xccheckout
  17. *.moved-aside
  18. DerivedData
  19. *.hmap
  20. *.ipa
  21. *.xcuserstate
  23. # CocoaPods
  24. #
  25. # We recommend against adding the Pods directory to your .gitignore. However
  26. # you should judge for yourself, the pros and cons are mentioned at:
  27. # http://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control
  28. #
  29. #Pods/

别名git命令

每次使用commit、checkout等冗长的命令想抓狂，可以尝试一下如下的别名设置（ ~/.gitconfig），你会有svn的那种简写畅快感：

  1. [alias]
  2.   st = status
  3.   ci = commit
  4.   di = diff
  5.   l = log --oneline --decorate -12 --color
  6.   ll = log --oneline --decorate --color
  7.   lc = log --graph --color
  8.   co = checkout
  9.   br = branch
  10.   rb = rebase
  11.   dci = dcommit
  12.   sbi = submodule init
  13.   sbu = submodule update
  14.   sbp = submodule foreach git pull
  15.   sbc = submodule foreach git co master

现在一些命令就可以这么用：

  1. // 等同于 git commit -m "我是提交注释"
  2. $ git ci -m "我是提交注释"
  4. // 等同于 git status
  5. $ git st
  7. // 等同于 git diff
  8. $ git di

部分Cocoapods技巧

添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注