如何在swift项目中引入CommonCrypto

这是一篇马上过期的文章,xcode10已经解决无法import CommonCrypto问题。(2018.7.20)
Good news! Swift 4.2 (Xcode 10) finally provides CommonCrypto!

1.Bridging-Header中导入

如果项目是混编项目,在Bridging-Header.h中引入即可。

//  xxx-Bridging-Header.h
//  Use this file to import your target's public headers that you would like to expose to Swift.
//

#import 

2.使用modulemap导入

modulemap是什么可以自行谷歌,swift的import系统可以看下这篇文章。
简单来说,可以通过modulemap来映射oc/c库,使得swift可以直接import。

思路:
1.创建modulemap,映射swift模块名到oc/c的头文件
2.在项目中配置import path,使得xcode能够找到你的modulemap

第1步:
如图,添加ModuleMaps目录放置modulemap文件,Demo中使用的modulemap来自Arcane,直接拿过来改就好了。

modulemap的语法也不纠结,大致也能看懂,CCommonCrypto是swift模块名,system表示系统环境,header指向oc/c的头文件,export *,导出所有。

第2步:
Targets -> Build Settings -> Import Paths中添加路径
根据不同环境的SDK指向不同的路径,demo中只添加了iOS和iOS Simulator的SDK导入路径。其余同理。

$(SRCROOT)/CryptoDemo/ModuleMaps/iphones
$(SRCROOT)/CryptoDemo/ModuleMaps/iphonesimulator

要注意的是,由于header指向了绝对路径,当xcode位置不对,或者库文件位置变更,会找不到头文件。能不能使用环境变量变成相对路径?xcode的常用变量(${SDKROOT}之类)不能在modulemap文件中使用,有好的方法请留言

如果你好奇那些路径怎么来的,你可以执行命令

xcodebuild -sdk -version

配置好import path就可以正常使用了。

3.包装一层framework

刚才我们使用modulemap导入,有两处不完善的地方:
1.创建modulemap时需要给不同的系统指向不同的库路径
2.路径都是绝对路径
下面的方法优雅的解决了以上问题。

我们知道,编译项目时,会首先编译它依赖的库,而编译后是可以执行脚本的。
所以我们的思路是:
编译项目 -> 编译依赖库 -> 执行依赖库的脚本 -> 生成modulemap
执行脚本时可以使用xcode的环境变量${SDKROOT},这样就轻易解决以上两个问题。

实施步骤:
1.创建Aggregate
2.添加编译脚本
3.项目依赖Aggregate
4.项目指定import path
Done!

  1. 创建Aggregate


2.添加编译脚本
脚本比较易读
创建文件夹${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap
创建文件${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap/module.modulemap

# This if-statement means we'll only run the main script if the CommonCryptoModuleMap directory doesn't exist
# Because otherwise the rest of the script causes a full recompile for anything where CommonCrypto is a dependency
# Do a "Clean Build Folder" to remove this directory and trigger the rest of the script to run
if [ -d "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap" ]; then
echo "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap directory already exists, so skipping the rest of the script."
exit 0
fi

mkdir -p "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap"
cat < "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap/module.modulemap"
module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}
EOF

3.项目依赖Aggregate


4.指定import path${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap

Done!

4.使用cocoapods

上述方法中我们:
${BUILT_PRODUCTS_DIR}动态指定modulemap文件的位置
${SDKROOT}指定SDK所在位置
当xcode build时会先编译Aggregate来触发脚本,而脚本通过环境变量获取路径。

我尝试在podspec中使用prepare_command来达到类似效果,但并不成功。
prepare_command中使用环境变量,pod install会报错。

[!] Failed to download 'CryptoKit'.

进步一的原因是:没有权限访问环境变量

/Sources/CommonCryptoModuleMap/module.modulemap: Permission denied

官方文档中一段解释:prepare_command在项目创建之前就被执行。
所以猜测执行脚本的环境仅仅是Pods目录下,并不能获取到环境变量。

#This command is executed before the Pod is cleaned and before the Pods project is created. 
#The working directory is the root of the Pod.

目前看来,要使用cocoapods来管理的话,只能使用方法2。

回顾方法2的两个步骤:
1.创建modulemap,映射swift模块名到oc/c的头文件
2.在项目中配置import path,使得xcode能够找到你的modulemap

按上文的步骤配置完后,还需要做以下处理:
由于pod install根据podspec的配置来编译,我们在build setting设置的选项,要在podspec中再设置一遍。

所以要在podspec中设置import path。这里也只考虑2种常用环境,其余自行添加。

s.pod_target_xcconfig = {
    'SWIFT_INCLUDE_PATHS[sdk=iphoneos*]'         => '$(SRCROOT)/CryptoDemo/ModuleMaps/iphones',
    'SWIFT_INCLUDE_PATHS[sdk=iphonesimulator*]'  => '$(SRCROOT)/CryptoDemo/ModuleMaps/iphonesimulator',
}

有些例子还会添加一句:原因是pod打包后只保留源代码和资源文件,如果modulemap所在的目录不被s.source_files包含,那么需要添加preserve_paths来告诉pod要保留文件。

s.preserve_paths = 'CocoaPods/**/*'   // modulemap所在目录

Done~

参考链接

你可能感兴趣的:(如何在swift项目中引入CommonCrypto)