在Swift框架中导入CommonCrypto

您如何汇入 CommonCrypto iOS的Swift框架？

我了解如何CommonCrypto在Swift应用程序中使用：您将添加#import <CommonCrypto/CommonCrypto.h>到桥接标题中。但是，Swift框架不支持桥接标头。该文档说：

您可以导入具有纯Objective-C代码库，纯Swift代码库或混合语言代码库的外部框架。无论框架是用单一语言编写还是包含两种语言的文件，导入外部框架的过程都是相同的。导入外部框架时，请确保将要导入的框架的“定义模块”构建设置设置为“是”。

您可以使用以下语法将框架导入不同目标中的任何Swift文件中：

import FrameworkName

不幸的是，导入CommonCrypto无效。也不添加#import <CommonCrypto/CommonCrypto.h>到伞头。

更简单，更可靠的方法是，在运行脚本阶段创建一个名为“ CommonCryptoModuleMap”的聚合目标，以自动生成模块图并使用正确的Xcode / SDK路径：

运行脚本阶段应包含以下bash：

# 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 <<EOF > "${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMap/module.modulemap"
module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}
EOF

使用外壳程序代码，${SDKROOT}意味着您不必对Xcode.app路径进行硬编码，该路径可能会因系统而异，尤其是如果您使用的xcode-select是切换到Beta版本或在安装有多个版本的CI服务器上构建时在非标准位置。您也不需要对SDK进行硬编码，因此它应该适用于iOS，macOS等。您也不需要在项目的源目录中放置任何内容。

创建此目标后，请使用“目标依赖项”项使您的库/框架依赖它：

这将确保在构建框架之前生成模块映射。

macOS注意：如果还需要支持macOS，则需要在刚创建的新聚合目标上添加macosx到Supported Platforms构建设置中，否则它将不会将模块映射Debug与其余的映射放置在正确的派生数据文件夹中框架产品。

接下来，将模块映射的父目录添加到${BUILT_PRODUCTS_DIR}/CommonCryptoModuleMapSwift部分（SWIFT_INCLUDE_PATHS）下的“导入路径”构建设置中：

记住要添加一个 $(inherited)如果您在项目或xcconfig级别定义了搜索路径，一行。

就是这样，您现在应该可以 import CommonCrypto

Xcode 10更新

Xcode 10现在附带CommonCrypto模块映射，因此不需要这种解决方法。如果您想同时支持Xcode 9和Xcode 10，则可以在“运行脚本”阶段进行检查，以查看模块映射是否存在，例如

COMMON_CRYPTO_DIR="${SDKROOT}/usr/include/CommonCrypto"
if [ -f "${COMMON_CRYPTO_DIR}/module.modulemap" ]
then
   echo "CommonCrypto already exists, skipping"
else
    # generate the module map, using the original code above
fi

实际上，您可以构建一个“可以正常使用”的解决方案（无需按此处其他解决方案的要求将module.modulemap和SWIFT_INCLUDE_PATHS设置复制到您的项目中），但是它确实需要您创建一个虚拟框架/模块。将适当地导入到您的框架中。我们也可以保证它工作平台无论是（iphoneos，iphonesimulator，或macosx）。

1. 在项目中添加一个新的框架目标，并以系统库（例如 “ CommonCrypto”）命名。（您可以删除伞头CommonCrypto.h。）

2. 添加一个新的配置设置文件并将其命名，例如 “ CommonCrypto.xcconfig”。（不要检查您的任何目标是否包含在内。）使用以下内容填充它：

   MODULEMAP_FILE[sdk=iphoneos*]        = \
       $(SRCROOT)/CommonCrypto/iphoneos.modulemap
   MODULEMAP_FILE[sdk=iphonesimulator*] = \
       $(SRCROOT)/CommonCrypto/iphonesimulator.modulemap
   MODULEMAP_FILE[sdk=macosx*]          = \
       $(SRCROOT)/CommonCrypto/macosx.modulemap

3. 在上面创建三个引用的模块映射文件，并用以下内容填充它们：

   • iphoneos.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneOS.platform/Developer/SDKs/iPhoneOS.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }

   • iphonesimulator.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }

   • macosx.modulemap

     module CommonCrypto [system] {
         header "/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.11.sdk/usr/include/CommonCrypto/CommonCrypto.h"
         export *
     }

   （如果您正在运行Beta版本，请将“ Xcode.app”替换为“ Xcode-beta.app”。10.11如果未运行El Capitan，请替换为当前的OS SDK。）

4. 在项目设置的“ 信息”选项卡上的“ 配置”下，将CommonCrypto的“ 调试”和“ 发布”配置设置为CommonCrypto（引用CommonCrypto.xcconfig）。

5. 在框架目标的Build Phases选项卡上，将CommonCrypto框架添加到Target Dependencies。另外，将libcommonCrypto.dylib添加到“ 使用库链接二进制文件”构建阶段。

6. 在“ 产品”中选择CommonCrypto.framework，并确保其包装的目标成员身份设置为Optional。

您现在应该能够构建，运行并 import CommonCrypto在包装器框架中。

有关示例，请参见SQLite.swift如何使用虚拟sqlite3.framework。

我找到了一个在Swift框架中成功使用CommonCrypto的GitHub项目：SHA256-Swift。另外，这篇文章关于sqlite3的相同问题也很有用。

基于上述内容，步骤如下：

1）CommonCrypto在项目目录中创建一个目录。在其中，创建一个module.map文件。模块映射将允许我们将CommonCrypto库用作Swift中的模块。其内容是：

module CommonCrypto [system] {
    header "/Applications/Xcode.app/Contents/Developer/Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator8.0.sdk/usr/include/CommonCrypto/CommonCrypto.h"
    link "CommonCrypto"
    export *
}

2）在“构建设置”的“ Swift编译器-搜索路径”中，将CommonCrypto目录添加到“ 导入路径”（SWIFT_INCLUDE_PATHS）。

3）最后，将Swift中的CommonCrypto导入到其他模块中。例如：

import CommonCrypto

extension String {

    func hnk_MD5String() -> String {
        if let data = self.dataUsingEncoding(NSUTF8StringEncoding)
        {
            let result = NSMutableData(length: Int(CC_MD5_DIGEST_LENGTH))
            let resultBytes = UnsafeMutablePointer<CUnsignedChar>(result.mutableBytes)
            CC_MD5(data.bytes, CC_LONG(data.length), resultBytes)
            let resultEnumerator = UnsafeBufferPointer<CUnsignedChar>(start: resultBytes, length: result.length)
            let MD5 = NSMutableString()
            for c in resultEnumerator {
                MD5.appendFormat("%02x", c)
            }
            return MD5
        }
        return ""
    }
}

局限性

在另一个项目中使用自定义框架在编译时失败，并显示错误missing required module 'CommonCrypto'。这是因为CommonCrypto模块似乎未包含在自定义框架中。一种解决方法是Import Paths在使用框架的项目中重复步骤2（设置）。

模块映射不是独立于平台的（当前指向特定的平台，即iOS 8 Simulator）。我不知道如何使标头路径相对于当前平台。

iOS 8更新<=我们应该删除该行 链接“ CommonCrypto”，以获得成功的编译。

更新/编辑

我不断收到以下构建错误：

ld：找不到用于x86_64体系结构的-lCommonCrypto的库clang：错误：链接器命令失败，退出代码为1（使用-v查看调用）

除非我link "CommonCrypto"从module.map创建的文件中删除该行。一旦我删除了这条线，它就可以了。

该答案讨论了如何使其在框架内以及与Cocoapods和Carthage一起工作

🐟modulemap方法

我modulemap在我的包装中使用了CommonCrypto https://github.com/onmyway133/arcane， https://github.com/onmyway133/Reindeer

对于那些获取header not found，请看看https://github.com/onmyway133/Arcane/issues/4或运行xcode-select --install

• 制作一个CCommonCrypto包含以下内容的文件夹module.modulemap

    module CCommonCrypto {
      header "/usr/include/CommonCrypto/CommonCrypto.h"
      export *
    }

• 转到内置设置->导入路径

    ${SRCROOT}/Sources/CCommonCrypto

co Cocoapods与Modulemap方法

• 这是podspec https://github.com/onmyway133/Arcane/blob/master/Arcane.podspec

    s.source_files = 'Sources/**/*.swift'
    s.xcconfig = { 'SWIFT_INCLUDE_PATHS' =>
    '$(PODS_ROOT)/CommonCryptoSwift/Sources/CCommonCrypto' }
    s.preserve_paths = 'Sources/CCommonCrypto/module.modulemap'

• 使用module_map不起作用，请参阅https://github.com/CocoaPods/CocoaPods/issues/5271

• 结合使用Local Development Pod path不起作用，请参阅https://github.com/CocoaPods/CocoaPods/issues/809

• 这就是为什么您看到我的示例Podfile https://github.com/onmyway133/CommonCrypto.swift/blob/master/Example/CommonCryptoSwiftDemo/Podfile指向git repo的原因

    target 'CommonCryptoSwiftDemo' do
      pod 'CommonCryptoSwift', :git => 'https://github.com/onmyway133/CommonCrypto.swift'
    end

🐘公共标题方法

• Ji是libxml2的包装器，它使用公共头方法

• 它具有一个头文件https://github.com/honghaoz/Ji/blob/master/Source/Ji.h，Target Membership设置为Public

• 它具有libxml2的头文件列表https://github.com/honghaoz/Ji/tree/master/Source/Ji-libxml

• 它具有构建设置->标头搜索路径

    $(SDKROOT)/usr/include/libxml2

• 它具有构建设置->其他链接器标志

    -lxml2

🐏带有公共头方法的可可足类

• 看看podspec https://github.com/honghaoz/Ji/blob/master/Ji.podspec

    s.libraries        = "xml2"
    s.xcconfig         = { 'HEADER_SEARCH_PATHS' =>           '$(SDKROOT)/usr/include/libxml2', 'OTHER_LDFLAGS' => '-lxml2' }

related有趣的相关职位

• 如何从Swift调用C？
• https://spin.atomicobject.com/2015/02/23/c-libraries-swift/

好消息！Swift 4.2（Xcode 10）终于提供了CommonCrypto！

只需添加import CommonCrypto您的swift文件。

警告：iTunesConnect可能会拒绝使用此方法的应用程序。

我团队的新成员不小心打破了最重要答案之一给出的解决方案，因此我决定将其合并到一个名为CommonCryptoModule的小型包装项目中。您可以手动安装它，也可以通过Cocoapods安装它：

pod 'CommonCryptoModule', '~> 1.0.2'

然后，您要做的就是将模块导入到需要的地方CommonCrypto，如下所示：

import CommonCryptoModule

希望其他人觉得这有用。

我认为我对Mike Weller的出色作品有所改进。

在Compile Sources包含此bash的阶段之前添加一个运行脚本阶段：

# This if-statement means we'll only run the main script if the
# CommonCrypto.framework 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

FRAMEWORK_DIR="${BUILT_PRODUCTS_DIR}/CommonCrypto.framework"

if [ -d "${FRAMEWORK_DIR}" ]; then
echo "${FRAMEWORK_DIR} already exists, so skipping the rest of the script."
exit 0
fi

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

ln -sf "${SDKROOT}/usr/include/CommonCrypto" "${FRAMEWORK_DIR}/Headers"

该脚本使用正确的位置的module.map构建一个裸露的框架，然后依靠Xcode的自动搜索 BUILT_PRODUCTS_DIR对框架。

我将原始的CommonCrypto include文件夹链接为框架的Headers文件夹，因此结果也应适用于Objective C项目。

对于将Swift 4.2与Xcode 10结合使用的任何人：

系统现在提供了CommonCrypto模块，因此您可以像导入其他任何系统框架一样直接将其导入。

import CommonCrypto

@mogstad足够友好，可以将@stephencelis解决方案包装在Cocoapod中：

pod'libCommonCrypto'

其他可用的豆荚对我不起作用。

modulemap解决方案可能很好，并且可以抵抗SDK更改，但是我发现它们在实践中很难使用，并且不如我想要的可靠。为了使一切变得更加简单，我采取了另一种方式：

只需复制标题即可。

我知道，脆弱。但是，Apple几乎从未对CommonCrypto进行过重大更改，而我梦想着在不最终使CommonCrypto成为模块化头文件的情况下，他们不会以任何重大方式对其进行更改。

“复制标头”是指“将所需的所有标头剪切并粘贴到项目中的一个大型标头中，就像预处理器一样。” 作为可以复制或改编的示例，请参见RNCryptor.h。

请注意，所有这些文件均根据APSL 2.0进行了许可，并且此方法有意维护了版权和许可声明。我的连接步骤已获得MIT的许可，并且仅适用于下一个许可通知）。

我并不是说这是一个漂亮的解决方案，但到目前为止，对于实施和支持而言，这似乎都是非常简单的解决方案。

我知道这是一个老问题。但是我想出了一种在Swift项目中使用库的替代方法，这对于那些不想导入这些答案中介绍的框架的人可能会有所帮助。

在Swift项目中，创建一个Objective-C桥接头，在Objective-C中创建NSData类别（或使用该库的自定义类）。唯一的缺点是您必须在Objective-C中编写所有实现代码。例如：

#import "NSData+NSDataEncryptionExtension.h"
#import <CommonCrypto/CommonCryptor.h>

@implementation NSData (NSDataEncryptionExtension)
- (NSData *)AES256EncryptWithKey:(NSString *)key {
    //do something
}

- (NSData *)AES256DecryptWithKey:(NSString *)key {
//do something
}

然后在您的Objective-c桥接标头中添加此代码

#import "NSData+NSDataEncryptionExtension.h"

然后在Swift类中做类似的事情：

public extension String {
func encryp(withKey key:String) -> String? {
    if let data = self.data(using: .utf8), let encrypedData = NSData(data: data).aes256Encrypt(withKey: key) {
        return encrypedData.base64EncodedString()
    }
    return nil
}
func decryp(withKey key:String) -> String? {
    if let data = NSData(base64Encoded: self, options: []), let decrypedData = data.aes256Decrypt(withKey: key) {
        return decrypedData.UTF8String
    }
    return nil
}
}

它按预期工作。

如果您需要在cocoapods库中使用CommonCrypto，我在jjrscott的答案中添加了一些cocoapods魔术。

1）将此行添加到您的podspec中：

s.script_phase = { :name => 'CommonCrypto', :script => 'sh $PROJECT_DIR/../../install_common_crypto.sh', :execution_position => :before_compile }

2）将其保存在您的库文件夹中或任何您喜欢的位置（但是请不要忘记相应地更改script_phase ...）

# This if-statement means we'll only run the main script if the
# CommonCrypto.framework 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
FRAMEWORK_DIR="${BUILT_PRODUCTS_DIR}/CommonCrypto.framework"

if [ -d "${FRAMEWORK_DIR}" ]; then
echo "${FRAMEWORK_DIR} already exists, so skipping the rest of the script."
exit 0
fi

mkdir -p "${FRAMEWORK_DIR}/Modules"
echo "module CommonCrypto [system] {
    header "${SDKROOT}/usr/include/CommonCrypto/CommonCrypto.h"
    export *
}" >> "${FRAMEWORK_DIR}/Modules/module.modulemap"

ln -sf "${SDKROOT}/usr/include/CommonCrypto" "${FRAMEWORK_DIR}/Headers"

奇迹般有效 ：）

我不确定Xcode 9.2是否有所更改，但是现在更容易实现。我唯一要做的就是在框架项目目录中创建一个名为“ CommonCrypto”的文件夹，并在其中创建两个文件，一个名为“ cc.h”，如下所示：

#include <CommonCrypto/CommonCrypto.h>
#include <CommonCrypto/CommonRandom.h>

另一个叫做module.modulemap：

module CommonCrypto {
    export *
    header "cc.h"
}

（我不知道为什么您不能直接在Modulemap文件中引用来自SDKROOT区域的头文件，但我无法使其正常工作）

第三件事是找到“导入路径”设置并将其设置为$（SRCROOT）。实际上，如果您不想在根级别使用它，则可以将其设置为希望CommonCrypto文件夹位于的任何文件夹。

之后，您应该可以使用

import CommonCrypto

在任何迅速文件和所有类型/功能/等。可用。

不过要提个警告-如果您的应用程序使用libCommonCrypto（或libcoreCrypto），那么一个不太老练的黑客将调试器附加到您的应用程序并找出将哪些密钥传递给这些功能非常容易。

如果您遇到以下问题：

ld：未找到-lapple_crypto clang的库：错误：链接器命令失败，退出代码为1（使用-v查看调用）

在Xcode 10中，Swift 4.0。CommonCrypto是框架的一部分。

加

 import CommonCrypto

去掉

• 链接二进制文件中的CommonCrpto lib文件与构建阶段中的库
• import CommonCrypto 来自桥接头

这对我有用！

更新Xcode之后，对我来说也是一样。我尝试了所有可以做的事情，例如重新安装cocoapods和清理项目，但没有成功。现在，重新启动系统后已解决。

非常简单 加

#import <CommonCrypto/CommonCrypto.h>

到.h文件（您项目的桥接头文件）。按照惯例，您可以将其称为YourProjectName-Bridging-Header.h。

然后转到您的项目“构建设置”，然后寻找“ Swift Compiler-代码生成”。在其下，将桥接头的名称添加到条目“ Objetive-C桥接头”。

你完成了。您的Swift代码中无需导入。Swift可以看到此桥接头文件中列出的所有公共Objective-C头。