一步步創建自己的 iOS 框架_ZenDei技術網路在線

創建你的第一個iOS框架如果你曾經試圖去創建一個自己的iOS框架的話，你應該知道這件事並不是那些畏懼困難的人能夠成功完成的－畢竟管理依賴和編寫測試並不容易。這篇文章將從開始到最終完成一步步的進行講解，以便你掌握後可以更好的創建自己的框架。在教程中我們會構建一個框架，框架裡面會暴露一個名為RGBU

創建你的第一個iOS框架

如果你曾經試圖去創建一個自己的iOS框架的話，你應該知道這件事並不是那些畏懼困難的人能夠成功完成的－畢竟管理依賴和編寫測試並不容易。這篇文章將從開始到最終完成一步步的進行講解，以便你掌握後可以更好的創建自己的框架。

在教程中我們會構建一個框架，框架裡面會暴露一個名為RGBUIColor(red:green:blue)的函數，該函數會返回使用這些參數創建的UIColor對象。我們會使用Swift語言，並且使用Carthage作為依賴項的管理工具。我們的框架將會支持通過Carthage、CocoaPods或者git來使用。

讓我們開始吧！

創建Xcode工程

選擇 File -> New -> Project
在左側的選擇 iOS -> Framework & Library，右側選擇“Cocoa Touch Framework”。
點擊“下一步”，並填寫選項提示。確保以及勾選了“Include Unit Tests”。
選擇工程保存的位置。
不要勾選“Create Git repository on My Mac”，我們在後面手動進行設置。
點擊“創建”並且打開工程。
選擇File -> Save As Workspace並使用工程相同的名字保存到相同的目錄中。之所以創建workspace是因為我們需要添加Carthage中的依賴作為子模塊；使用Xcode
編譯他們的時候必須是在一個workspace中。
選擇File -> Close Project關閉工程。
然後選擇File -> Open打開＊workspace*文件。
Xcode左上角的scheme並選擇“Manage Schemes”。我們需要確保sheme勾選了“shared”，以便能使用“Carthage”來構建工程。

初始化git

首先，切換到工程所在的目錄。

運行git init初始化空版本庫。
創建一個 .gitignore的文件。該文件會過濾一些Xcode或者依賴文件中一些我們不想也不需要上傳的文件。

這裡是一個標準的Swift工程的gitignore文件，我們只是添加了.DS_Store並移除了fastlane和一些多餘的部分。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

## OS X Finder .DS_Store ## Build generated build/ DerivedData ## Various settings *.pbxuser !default.pbxuser *.mode1v3 !default.mode1v3 *.mode2v3 !default.mode2v3 *.perspectivev3 !default.perspectivev3 xcuserdata ## Other *.xccheckout *.moved-aside *.xcuserstate *.xcscmblueprint ## Obj-C/Swift specific *.hmap *.ipa # Swift Package Manager .build/ # Carthage Carthage/Build

添加Carthage和依賴項

在工程的文件目錄下創建一個名為Cartfile的文件以及運行時的依賴性。我們添加**Curry]**([鏈接)
github "thoughtbot/Curry"
創建一個名為Cartfile.private的文件。它會負責私有的一些依賴就像我們的測試框架一樣。我們使用Quick和Nimble。

1 2 github "Quick/Quick" github "Quick/Nimble"
新建bin/setup腳本。它可以提供一個簡單的方式來處理依賴和工程，無論時對於貢獻者還是我們自己。

1 2 3 mkdir bin touch bin/setup chmod +x bin/setup

打開bin/setup並將一下代碼加入：

1 2 3 4 5 6 7

#!/usr/bin/env sh if ! command -v carthage > /dev/null; then printf 'Carthage is not installed.n' printf 'See https://github.com/Carthage/Carthage for install instructions.n' exit 1 fi carthage update --platform iOS --use-submodules --no-use-binaries

在這個腳本裡面，我們假設用戶一句安裝了Carthage鏈接，然後我們使用update命令來安裝那些依賴項。

我們使用–use-submodules，所有那些依賴項會以子模塊的方式被添加。當用戶需要的時候，他就可以直接使用我們的框架而不需要使用Carthage。我們使用了–no-use-binaries，所有這些依賴項都會在我們自己的系統上進行編譯。

當bin/setup建好後，我們直接在終端運行腳本讓Cartfile自行下載依賴項。

現在我們就可以設置我們的工程並且編譯這些依賴項了。

添加依賴到工作區

因為我們的依賴是作為子模塊，我們需要將這些自模塊添加到工作區。

1.打開Carthage/Checkouts然後將每個依賴項的.xcodeproj添加到工作區。你可以使用直接拖拽到項目的工作區。

添加完結束後：

鏈接運行時依賴

在工作區的導航欄選擇”RGB” ,然後在中間選擇”RGB”目標，進而選擇”Build Phases”，展開”Link binary with libraries”。
點擊”+”然後選擇Curry.framework框架的Curry-iOS。
點擊添加。

鏈接開發依賴項

在中間的工具欄選擇”RGBTests”。
使用上面一樣的步驟，將”Quick”和”Nimble”框架添加到”Link binary with libraries”。
當我們將依賴添加到兩個目標的時候，Xcode會自動在”Build Settings”下添加”Framework Search Paths”。我們可以在”RGB”和”RGBTests”中移除，因為同處同一工作區， Xcode將他們本身的一部分。
選擇目標下的兩個目標，選中”Build Settings”下的”Framework Search Paths”，然後按“退格鍵”刪除。
接下來，在導航欄選擇”RGB”工程的時候，你就會看見下麵you三個剛剛添加的三個框架。然後全選這三個框架，然後右擊選擇”New group from selection”然後將他們放到一個組裡，我將組命名為”Frameworks”。

現在Carthage已經設置完成，接下來是CocoaPods。

添加CocoaPods支持

為了添加CocoaPods支持，我們需要在工程的根目錄新建.podspec，並且包含工程的信息。

新建RGB.podspec文件。
將下麵的實例拷貝並複製到文件中(自行對照修改相應的部分)。
使用項目的信息來設置那些選項。更多的選項詳情鏈接，但是該工程中你所需要的那些選擇如下。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

Pod::Spec.new do |spec| spec.name = "RGB" spec.version = "1.0.0" spec.summary = "Sample framework from blog post, not for real world use.Functional JSON parsing library for Swift." spec.homepage = "https://github.com/jakecraige/RGB" spec.license = { :type => 'MIT', :file => 'LICENSE' } spec.authors = { "Jake Craige" => '[email protected]', "thoughtbot" => nil, } spec.social_media_url = "http://twitter.com/thoughtbot" spec.source = { :git => "https://github.com/jakecraige/RGB.git", :tag => "v#{spec.version}", :submodules => true } spec.source_files ="RGB/**/*.{h,swift}" spec.requires_arc = true spec.platform = :ios spec.ios.deployment_target = "9.1" spec.dependency "Curry", '~> 1.4.0' end

這裡面需要註意到的一行是spec.dependency “Curry”, ‘~> 1.4.0′。因為我們需要支持CocoaPods，我們假設框架的使用者會使用CocoaPods而不是Carthage，
所有我們我們在最後一行也聲明依賴而不僅僅只在Carthfile聲明。

當我們設置好了之後，我們在終端中運行pod lib lint命令測試所有的東西是不是都配置好了。如果沒錯的話，我們能看見如下的提示：

當工程的依賴項設置好後，我們就可以寫代碼了。但是在我們開始之前，先提交代碼。

1	git commit -am "Project and dependencies set up"

編寫第一個測試

打開RGBTests/RGBTests.swift文件，你可以看見一個預設的模版。她使用了@testable和XCTest(，但是接下來我們會作出一些調整。

首先，我們會移除@testable，因為我們需要測試那些框架使用者可能調用的API介面。隨著框架的增長，我們可能會需要@testable去測試那些不是作為公共介面暴露的部分；總的來說，就是我們想避免測試那些暴露給使用者的介面。這個特性在測試應用的時候會更加有效，而不是在框架測試中。

來源於蘋果關於測試部分的文檔:

伴隨者可測試性，你系那種能夠在Swift 2.0框架和應用中編寫測試並且不需要要測試所有的internal和public部分。在XCTest目標而不是其他框架或者應用的測試代碼中
使用@testable import {ModuleName}。

我們使用Quick和Nimble作測試。Quick提供以一個行為驅動類型的測試介面，與RSpec和Specta非常相近；Nimble給我們提供了強大的斷言以及少量模版就能寫成非同步代碼的能力。

寫完之後，代碼如下：

1 2 3 4 5 6 7 8 9 10 11 12 13

import Quick import Nimble import RGB class RGBTests: QuickSpec { override func spec() { describe("RGB") { it("works") { expect(true).to(beTrue()) } } } }

使用快捷鍵CMD + U或者Product -> Test運行測試代碼，會顯示測試成功。

所以，到現在已經完成了！

開玩笑而已。讓我們來一些真正的測試。

我們暴露一個RGBUIColor(red: 195, green: 47, blue: 52)調用介面，介面會返回一個漂亮的thoughtbot red的UIColor。

代碼如下：

1 2 3 4 5 6 7 8 9 10 11 12 13

describe("RGBUIColor") { it("is a correct representation of the values") { let thoughtbotRed = UIColor( red: CGFloat(195/255), green: CGFloat(47/255), blue: CGFloat(52/255), alpha: 1 ) let color = RGBUIColor(red: 195, green: 47, blue: 52) expect(color).to(equal(thoughtbotRed)) } }

如果你此時運行此時的話，會像預料中的那樣－失敗。因為Swift語言的類型檢查會組織我們運行一個沒有定義的RGBUIColor函數。接下來讓我們完成它。

編寫實現代碼

右擊RGB選擇新建一個文件。創建一個名為RGBUIColor.swift的文件，並將下麵的代碼拷貝過去。

1 2 3 4 5 6 7 8 9 10 11 12 13 14

import Curry func RGBUIColor(red red: Int, green: Int, blue: Int) -> UIColor { return curry(createColor)(red)(green)(blue) } private func createColor(red: Int, green: Int, blue: Int) -> UIColor { return UIColor( red: CGFloat(red/255), green: CGFloat(green/255), blue: CGFloat(blue/155), alpha: 1 ) }

這裡使用Curry作為一個運行時的依賴性的例子來使用。這裡採用了一個不標準的使用斌強沒有提供任何值。讓我們繼續測試！

第一眼看過去，我們可能會感到很奇怪。我們明明已經定義了RGBUIColor函數啊？