WCDB Swift 提供 Cocoapods、Carthage 和 源码 三种安装方式。

基本要求

  • Swift 4.0 及以上
  • Xcode 9.0 及以上
  • 系统要求
    • iOS 8.0 及以上
    • macOS 10.9 及以上
    • tvOS 9.0 及以上
    • watchOS 2.0 及以上

通过 Cocoapods 安装

安装 Cocoapods 工具

可参考 Cocoapods 官方教程进行安装。

更新本地的 Cocoapods 缓存

在命令行中执行:

  1. pod repo update

添加 Podfile 配置

在工程目录下创建 podfile 文件,并在对应 target 下添加 pod 'WCDB.swift'use_frameworks!。以下是一份示例 podfile 文件:

  1. platform :ios, '8.0'
  2. use_frameworks!
  3.  
  4. target 'Sample' do
  5. pod 'WCDB.swift'
  6. end

然后在 podfile 同目录下命令行执行:

  1. pod install --verbose

引入 WCDBSwift

在项目中使用 Cocoapods 生成的 .xcworkspace 文件打开工程,并在需要使用 WCDB Swift 的源代码文件头通过 import WCDBSwift 引入即可。

通过 Carthage 安装

安装 Carthage 工具

可参考 Carthage 官方教程进行安装。

添加 cartfile 配置

在工程目录下创建 cartfile 文件,并添加 github "Tencent/WCDB"。以下是一份示例 cartfile 文件:

  1. github "Tencent/WCDB"

编译生成动态库

在工程目录命令行执行:

  1. carthage update
对于不需要 bitcode 的开发者,可以指定 —configuration WithoutBitcode,以降低二进制的包大小。

完成后可以在 Carthage/Build 目录下找到生成的对应 iOS 或 macOS 平台动态库 WCDBSwift.framework

链入动态库

打开工程,并将对应 iOS 或 macOS 平台的动态库,拖入工程设置的 Build Phases -> Link Binary and Libraries 中。

同样在 Build Phases 中,选择 + 选项,在弹出菜单中选择 New Run Script Phase。在创建的脚本中添加

  1. carthage copy-frameworks

并在 Input Files 中添加对应 iOS 或 macOS 平台的动态库路径,如

  • iOS:
    • $(SRCROOT)/Carthage/Build/iOS/WCDBSwift.framework
  • macOS:
    • $(SRCROOT)/Carthage/Build/Mac/WCDBSwift.framework
      以下是一份 iOS 平台工程的配置示例:

carthage_sample

引入 WCDBSwift

在需要使用 WCDB Swift 的源代码文件头通过 import WCDBSwift 引入即可。

通过源码安装

获取 WCDB Swift 源码

WCDB Swift 包含了 sqlcipher 的子模块,因此也需对其进行更新。在命令行中执行:

  1. git clone https://github.com/Tencent/wcdb.git
  2. cd wcdb
  3. git submodule update --init sqlcipher

链入工程文件

wcdb/swift 目录下的 WCDB.swift.xcodeproj 拖入你的工程文件中,并在工程配置的 Build Phases -> Target Dependencies 中添加 WCDBSwift

链入动态库

同样在工程配置的 General -> Enbedded Binaries 中添加 WCDBSwift.framework

以下是一个完成链入的配置示例:

git_clone_sample

引入 WCDBSwift

在需要使用 WCDB Swift 的源代码文件头通过 import WCDBSwift 引入即可。