@[toc]
前言
系列目錄
上一篇 已經寫了如何讓自己的項目， 通過 SPM 依賴第三方.
那現在有個問題, 自己如何去創建一個支持 Swift Package 的庫呢? 那么接下來, 我們就來探索如何把自己的庫支持 SPM 吧! ??
創建 Swift Package 庫
和以往一樣, 一步一步來!
初始化 Swift Package 項目
命令行初始化
創建 XQPackageTest 文件夾, 然后打開終端 cd 到該文件夾下, 輸入
swift package init
然后控制臺顯示如下
那么就表示, 當前已經初始化好一個最基礎的庫了
Creating library package: XQPackageTest
Creating Package.swift
Creating README.md
Creating .gitignore
Creating Sources/
Creating Sources/XQPackageTest/XQPackageTest.swift
Creating Tests/
Creating Tests/LinuxMain.swift
Creating Tests/XQPackageTestTests/
Creating Tests/XQPackageTestTests/XQPackageTestTests.swift
Creating Tests/XQPackageTestTests/XCTestManifests.swift
文件目錄如下 ( .gi 是我后面自己加上的 )
里面的文件, 其實我們要關心的, 一般就兩個
- Package.swift: 是描述庫的一些配置, 屬性等等, 可以當做 CocoaPods 的 xxx.podspec 文件. (這個后面再詳細描述, 現在默認配置就行)
- Source/xxx 文件夾: 放源碼的文件夾, 我們直接把源碼扔到這個文件夾下就可以了
使用 Xcode 初始化
當然，Xcode 也提供了創建 Swift Package 入口, 如下圖
編寫庫代碼
這里就直接拿系統生成的 XQPackageTest.swift 更改一下代碼, 方便依賴成功后, 測試一下是否真的成功了。
然后 command + build 一下, 看看是否正確.
報錯了, 這個時候看一下報錯.
其實就是因為我們修改了代碼, 導致 Test 模塊運行不了( Build 會運行 Test 模塊 )
這個時候, 我們可以選擇把這行代碼注釋掉, 或者修改成正確代碼就可以了, 如下
上傳庫到云端
修改好后, 上傳庫到云端(github, gitee 或者其他托管服務器都行), 我這邊上傳到我本地 gitlab 服務器.
項目進行依賴
打開你一個 iOS 或者 Mac 項目都行, 然后進行添加依賴, 操作和 上一篇 一樣, 只需要把第三方的 鏈接 替換為你自己庫的 鏈接 就可以了
不過這里要注意一下, 如果你不想發 Release 版本(偷懶), 就直接選擇 Branch, 或者 Commit 就行.
比如我當前沒創建 Release 版本, 直接進行依賴的話, 就會出現以下錯誤
The package dependency graph can not be resolved; unable find any available tag for the following requirements:
這個時候, 我們只需要把 Version 改為 Branch 或者 Commit 就行了.
例如我這里選擇 Branch, 并輸入 master 分支, 這樣就能點擊 Next 了.
依賴成功
成功之后, 就能看到, 自己的庫已經在列表中了
測試依賴
測試一下庫的接口, 如下圖
是的, 至此, 已經完成依賴了. ??
庫中, 依賴別的第三方
這個只要在庫里的 Package.swift 文件, 添加依賴就行了. 如下
import PackageDescription
let package = Package(
name: "XQPackageTest",
platforms: [
.iOS(.v10),
],
products: [
.library(
name: "XQPackageTest",
targets: ["XQPackageTest"]),
],
/// 依賴那些第三方
dependencies: [
.package(url: "https://github.com/SnapKit/SnapKit.git", from: .init(5, 0, 1)),
],
targets: [
.target(
name: "XQPackageTest",
dependencies: [
// 你依賴的第三方
"SnapKit",
]),
.testTarget( name: "XQPackageTestTests", dependencies: ["XQPackageTest"]),
],
)
Package.swift 簡介
上面說過, Package.swift 是相當于 CocoaPods 中的 xxx.podspec 文件
那么我這里就簡單介紹一下里面的一些屬性
import PackageDescription
let package = Package(
name: "XQPackageTest",
/// 支持平臺多少版本以上
platforms: [
.iOS(.v10),
// .macOS(.v10_12),
// .tvOS(.v10),
// .watchOS()
],
/// 該庫的一些配置
products: [
.library(
name: "XQPackageTest",
// 動態庫 or 靜態庫
// 默認為 靜態庫
type: .static,
targets: ["XQPackageTest"]),
],
/// 依賴那些第三方
dependencies: [
// 第三方有良好的版本格式: 大版本.小版本.測試版本
// 就可以直接用這個
.package(url: "https://github.com/SnapKit/SnapKit.git", from: .init(5, 0, 1)),
// 如果第三方版本格式, 是其他的, 例如 1.2, 根本沒用第三位, 那么我們也可以這樣, 直接傳入字符串
// .package(url: "https://github.com/SnapKit/SnapKit.git", from: .init(stringLiteral: "5.0.1")),
// 如果第三方目前的 release 版本還沒支持 SPM 的話, 我們可以直接指向他的 master 分支
// .package(url: "https://github.com/SnapKit/SnapKit.git", Package.Dependency.Requirement.branch("master")),
// 當然, 也能關聯本地的能支持 SwiftPM 的庫
// .package(path: "../XQSwiftPMTest"),
],
targets: [
// 你庫的 target
.target(
name: "XQPackageTest",
dependencies: [
// 你關聯的第三方
"SnapKit",
]),
// 測試的 target
.testTarget(
name: "XQPackageTestTests",
dependencies: ["XQPackageTest"]),
],
// 庫支持 Swift 語言版本
swiftLanguageVersions: [
.v5
]
)
SPM OC
目前, 據我了解, 還不能進行 Swift 和 OC 的混編.
但是能編寫 OC 和 C 這些的庫, 如下圖
這里要注意一下, 系統默認是公開的 .h是 ==Sources/[targetName]/include== 路徑下.
如果要修改為某個路徑下的.h文件, 要自己重寫 target 的 ==publicHeadersPath==.
publickHeadersPath 默認的路徑是在 ==[Sources]/[targetName]== 下.
例如我要暴露整個庫所有的 .h
那么如上圖, publicHeadersPath 就為 "../XQPackageTest" 即可
待解決問題
目前還有幾個問題待解決, 后續解決了的話, 也會馬上更新文章。
當然，如有大佬已經解決了以下問題，請評論或者私信我, 因為我也想知道如何解決 o(╥﹏╥)o
- 如何直接關聯本地代碼, 就是不用上傳到云端的. 類似 CocoaPods 直接 :path => '' 指向本地
- 關聯 lib 庫
- 關聯 framework 庫
- 添加資源文件, 如 .xib, .storyboard, .png, .html, .xcassets, .json, .zip 等等
坑
Authentication failed
選擇更新 SPM 庫的時候, 偶爾會報錯, 如下
==x-swift-package-repository-authentication://?scm=com.apple.dt.Xcode.sourcecontrol.Git&url=xxx#error=-1005 Authentication failed because the credentials were missing==
因為有些庫是私有庫, 需要賬號密碼, 或者一些其他驗證登錄.
如果像賬號密碼登錄, 那么過了一定時間, 就會驗證失效. 需要重新輸入賬號密碼.
這時候雙擊圖中, 藍色選中的這個錯誤, 系統會彈出一個輸入框.
這個時候, 只要輸入賬號密碼, 點擊 OK 即可.
庫不會更新到最新
修改完自己的庫, 提交上去, 偶爾會出現無法下拉最新代碼.
這時候選中 File -> Swift Packages -> Reset Package Caches, 如下圖.
如還沒有, 那么嘗試關閉 Xcode，或點擊 Update tolatest Package Versions 操作.
如還是沒有的話...那么 Show Find 你的庫, 進入到項目的編譯緩存文件夾, 刪除這個項目的編譯緩存
路徑如這樣 ==~/Library/Developer/Xcode/DerivedData/你項目的名稱-隨機碼==
一般進行以上操作都是可以的了
