簡單而強大的 Drag and Drop API 讓你輕鬆建立屬於自己的 Trello App


本篇原文(標題:Building a Trello-like iOS App with Drag & Drop API)刊登於作者 Medium,由 Alfian Losari 所著,並授權翻譯及轉載。

當建構一個讓使用者在螢幕上移動數據的 App 時,拖放 (Drag and Drop) 就是一種很自然的使用者交互 (User Interaction)。這樣的互動方式在 Trello、Jira 等相關 App 中廣泛使用,以在版面之間移動數據。

在 iOS 11 發佈之前,以拖放互動方式來建立一個 iOS app 並不是簡單。以我過往的經驗來說,我們會要手動實作許多乏味的步驟,像是:

  1. 在想要拖動的視圖中加入長壓手勢辨識器 (recognizer)。
  2. 當使用者開始拖動時,建立一個快照視圖 (snapshot)。
  3. 當使用者在螢幕上拖動快照視圖時,處理快照視圖座標的更新。
  4. 偵測並處理使用者放開物件到一個座標位置的行動。
  5. 同步放開數據的目的地及拖動數據的來源,並且在使用者介面 (UI) 作對應的更新。

就算你完成了上面這麼多任務,也很難讓拖放互動方式順利的運行。值得慶幸的是,隨著 iOS 11 的發佈,Apple 終於在 Cocoa Touch SDK 中提供了 Drag and Drop API。雖然 iOS 12 是最新的行動作業系統版本,但 iOS 11 是 iPad 自 2010 年推出以來最大的作業系統更新。iPad 作為 PC 和智慧型手機之間的第三個設備,支援多任務處理 (multitasking),你可以在 Split Screen 和 Slide Over 界面上同時執行多個 App。另外也推出來自 macOS 的 Dock,允許使用者容製化喜歡的或最近使用過的 App。

Drag and Drop API 是 App 之間最好的溝通方式,以下列出了拖放互動方式的主要特點:

  1. 支援 iOS 系統層級的拖放,像是使用 Split View 在 Apps 之間移動文字、圖片和檔案,或是在 Dock 拖動 App 圖示。
  2. 在拖放視圖的時候,API 會自動處理所有動畫,開發者只需要實作協定,來獲得更高的彈性及客製化的需求。
  3. 支援拖動多個項目,使用者只需拖動一個物件並點擊其他物件來選擇。

快速導覽 Drag and Drop API

根據 Apple 的 Documentation 頁面,以下列出了 Drag and Drop API 的概述:

  1. 拖放功能可以在單一 App 或是多個 App 之間實作。在 iPhone 的環境之中,拖放功能只限於在單一 App 中使用。如果是在多個 App 的環境中實作,使用者開始拖動視圖的 App 將成為來源 App (Source App),而使用者將視圖拖動到的位置就會是 目的 App (Destination App)
  2. 當使用者做出拖放的動作時,系統會初始化 Drag Activity。系統也會透過 Drag Session 管理使用者正在拖放的物件的狀態。
  3. 我們可以使用實作 UIDragDelegateUIDropDelegate 兩個協定的物件,來設置 UIView 支援物件的拖放功能。而 UIDragDelegateUIDropDelegate 兩個協定也各自擁有獨立的視圖屬性及協定,來處理每個單元 (cell) 的拖放行為。API 為我們提供彈性,來客製化拖放功能。
  4. 系統也會透過 UTI (Uniform Type Identifier) 自動且安全地處理 App 之間的數據移動及載入,包含文字、圖像和聯絡人等。

我們將要建立的 App

在這篇教學之中,我們將會使用 Drag and Drop API 來建立一個類似 Trello 的 App,包含下列功能:

  1. 創建記事板 (board)。
  2. 將項目加入到記事板。
  3. 透過拖放功能在記事板之間移動項目。

為了創造這些功能,以下是我們將要在專案中實作的任務:

  1. App 流程圖
  2. 在 Xcode 創建並設置初始專案
  3. 為記事板創建模型,並列出所包含的項目
  4. 設置 UI 佈局
  5. 設置視圖控制器與單元
  6. 透過 UITableViewDragDelegate 處理 UITableView 內拖動項目的行為
  7. 透過 UITableViewDropDelegate 處理將項目置放 UITableView 的行為

你可以在 GitHub 複製我們最終完成的專案。

事不宜遲,我們來瞭解 App 流程圖吧!

App 流程圖

Application-Flow-Diagram

為了建立一個能顯示包含項目記事板集合的 App,我們需要幾個 UIKit 元件來規劃我們的策略。以下是整個流程的總覽:

  1. 我們會使用 UICollectionViewControllerUICollectionViewFlowLayout 來建構主螢幕。
  2. 我們會設置 UICollectionViewCell 的滾動方向屬性為 Horizontal,這樣我們就能夠以水平的方式來滾動記事板。
  3. 我們會以 UITableView 作為 ContentView 來創建一個 UICollectionViewCell 的原型,每當 UICollectionView 從佇列 (queue) 中提取一個單元,UICollectionViewController 將會傳遞記事板模型的參考。
  4. 我們以 UICollectionViewCelldatasource 及 UITableView 的 delegate,它也會在 UITableView 提取單元格時為項目提供數據。
  5. 我們將會設定 UITableView 的屬性來啟用拖動互動 (drag interaction),並將 UICollectionViewCell 設置為 UITableViewUITableViewDragDelegateUITableViewDropDelegate

開始處理 Xcode 專案

首先,打開 Xcode 並創建一個新專案,選擇 Single View App 作為模板,並取消勾選 use unit testsCore Data 選項。任意為專案取一個名稱,並按下 confirm 來創建專案。

刪除 ViewController.swift,然後在 main.storyboard 中也刪除 UIViewController.swift。我們待會會回來 storyboard 設定 App 的 UI。下一步,我們將會創建模型來呈現一個包含項目列表的記事板。

為記事板創建模型

新建一個名為 Board.swift 的檔案,並且在檔案中宣告一個同名的類別。

在類別的宣告中,我們用初始化器 (initializer) 宣告了兩個實例 (instant) 屬性:

  1. 宣告記事板的標題為字串 (String)
  2. 宣告項目列表為字串陣列 ([String])

這樣模型就完成了。為了突顯這篇教學文章的主題,我們盡量保持文章簡潔清晰。

設置 UI 佈局

讓我們為 App 創解 UI 吧!先打開 main.storyboard 並跟著下列步驟操作:

  1. 從物件函式庫 (object library) 中點選並拖動 Collection View Controller
  2. 點擊它,並到 Editor 中單擊嵌入 Navigation Controller,將它設置為 Initial View Controller
  3. Collection View Controller 中選擇 Collection View
  4. Attribute Inspector 中,將 Scroll Direction 屬性設定為 Horizontal ,同時把 background 的顏色設定為 #0070BF
  5. Size Inspector 中,將 CellsLinesmin spacing 都改為 10。接著將所有方向的 Section Insets 都改為 0,最後把 Cell Size 的寬度改為 320,高度改為 480
  6. 選擇 Collection View Cell 並將它的 identifier 設定為 Cell
  7. 打開物件函式庫,把一個 Table View 拖動到 Collection View Cell 之中。
  8. TableViewleadingtrailingtopbottom 的自動佈局屬性設置為 0,請確認你有取消勾選 Constrain to margins 的選項。
  9. 把一個 Table View Cell 從物件函式庫拖到 Table View 裡,同時將它的 identifier 設定為 Cell,並將 style 設定為 Basic
  10. 把一個 UIView 拖到 TableView Header View,並將高度設定為 44
  11. 把一個 UIButton 拖到剛剛創建的 TableView Header View 中,並且把所有方向的約束設置為 0。最後,把標題文字設為 Add

操作完上述所有步驟之後,你的 storyboard 看起來應該像是這樣。

Main-Stroyboard

設定記事板集合視圖單元格

新建一個名為 BoardCollectionViewCell 的檔案,並把下面這段程式碼輸入到檔案之中。

以下簡單解釋了這段程式碼:

  1. 創建一個 UICollectionViewCell 的子類別,命名為 BoardCollectionViewCell
  2. 宣告三個實例屬性:tableViewboard 模型、及 BoardCollectionViewCellweak 引用。
  3. 覆寫 awakeFromNib 方法,讓我們可以設定單元格的圖層,以添加輕微的圓角效果。接著,我們把 tableView 的 delegatedatasource 設定為 BoardCollectionViewCell
  4. 創建一個 IBAction 方法,使用者點擊 Add 按鈕時就會觸發這個方法。在這個方法之中,我們以 alert 風格創建一個 UIAlertController,並添加一個 UITextField,以輸入即將添加到記事板中的項目名稱。當使用者加入項目時,我們只要把它附加到記事板模型的項目陣列即可。接著,我們告訴 Table View 在底層插入新的行列,並且滾動到特定的 IndexPath
  5. 創建接受 Board 模型為參數的 setupWithBoard 方法,它把傳遞過來的記事板儲存為實例屬性,並觸發 Table ViewreloadData 方法來更新視圖。
  6. 創建一個實作 UITableViewDataSourceUITableViewDelegate 的擴展 (extenstion)。
  7. 對於 tableView:numberOfRowsInSection:,我們只回傳記事板中的項目數量。
  8. tableView:cellForRowAtIndexPath: 中,我們以 storyboard 設定的識別字將 Table View Cell 取出佇列,使用記事板項目的 IndexPath 列來取得項目,並以項目來設定單元格 textLabel 的文字屬性來顯示它。

完成了!確認一下你有在 storyboard 中設定 UICollectionViewCell 類別為 BoardCollectionViewCell,並連結 Add 按鈕的 touchUpInside 行為到 addTapped: 選擇器 (selector) 之中。

設定記事板集合視圖控制器

新建一個名為 BoardCollectionViewController 的檔案,並把下面這段程式碼輸入到檔案之中。

讓我簡單地解釋一下這段程式碼:

  1. 創建一個 UICollectionViewController 的子類別,並命名為 BoardCollectionViewController。它同時也實作了 UICollectionDelegateFlowLayout 協定,因為我們在 storyboard 中設定了 Collection View Controller 使用流動佈局 (Flow Layout)。
  2. viewDidLoad 之中,我們觸發了 setupAddButtonItem 方法。這個方法把一個 UIBarButtonItem 加入到 NavigationBar 右側列按鈕項目之中。我們將 target action selector 設置為 addListTapped: 方法。最後,我們觸發 updateCollectionViewItem 來傳遞 view 的尺寸,以設定單元格的項目尺寸。
  3. updateCollectionViewItem 方法中,我們計算了 Collection View Cell 的動態高度為 view 高度的 0.8 倍,而單元格的寬度則固定為 225 點。在螢幕旋轉而 view 需要計算新尺寸時,這個方法也會被調用。
  4. addListTapped 被調用時,我們建立一個 alert 風格的 UIAlertController。接著,我們添加 UITextField,讓使用者輸入想要創建的記事板名字。在使用者填寫完 Text Field 並確認後,我們創建一個新記事板,以使用者輸入的名稱為標題文字屬性,並將它附加到 Board 陣列之中。最後,我們告訴 Collection View 要在最後的 indexPath 插入一個新項目,並自動滾動到新的位置。
  5. 對於 collectionView:numberOfItemsInSection:,我們只回傳 board 陣列的尺寸。
  6. 對於 collectionView:cellForItemAtIndexPath:,我們以 storyboard 中設定的識別字來將單元格從佇列中提取出來,並將它轉型為 BoardCollectionViewCell。接著,我們使用 indexPath 獲得記事板,並觸發單元格的 setupWithBoard:,將記事板傳遞給單元格。

首次執行 App

現在我們試著首次建置及執行 App,你應該會看見一個帶有項目的記事板清單。試試加入新的記事板及項目,並水平地滾動螢幕。接著,我們將要在 Table View 之中實作 Drag and Drop API,以在記事板之間移動項目。

drag-and-drop-1

使用 UITableViewDragDelegate 處理 UITableView 內的拖動行為

Table View 之中加入支援拖動功能其實很簡單。我們所需要做的就只是設定兩個屬性,將 dragInteractionEnabled 設定為 true,並將 dragDelegate 設定為 BoardCollectionViewCell。打開 BoardCollectionViewCell,並到 theawakeFromNib 方法加入下列程式碼:

這時編譯器可能會有錯誤,因為 BoardCollectionViewCell 還未實作 UITableViewDragDelegate 協定。因此,我們來到檔案的最底下,以擴展的方式加入下列程式碼。

以下就解釋了 UITableViewDragDelegate 實際做了甚麼:

drag-and-drop-2
(圖片來源:Apple Inc.)

  1. UITableViewDragDelegate 需要委派 (delegate) 去實作 tableView:itemsForBeginningSession:atIndexPath: 方法,這個方法會回傳一個 UIDragItem 物件的陣列。它會被 Table View 用來以 indexPath 啟動 drag session,如果我們想要開始 drag session,就需要回傳一個非空 (not empty) 的 UIDragItem 物件陣列。
  2. 我們藉由傳遞 NSItemProvider 來初始化 UIDragItemNSItemProvider 是那些我們想拖放項目的數據表示法 (representation),它使用 UTIs (Uniform Type Identifiers) 來表達數據,像是文字、圖像或名片等。它是拖動來源 App 和置放目標 App 之間的合約/承諾,基於它們的表示法來載入及處理這些數據。
  3. 在方法之中,我們透過 indexPath 從記事板獲得項目,並且使用 utf8 為編碼方法,將它轉換成 Data 型別。
  4. 我們初始化 NSItemProvider 來傳遞數據,並將 typeIdentifier 參數設為 kUTTypePlainText。為了能夠使用常數 (constant),你需要在檔案最上面匯入 MobileCoreServices
  5. 接下來,我們使用了 item provider 來初始化 UIDragItem。我們也設定了 localContext 屬性,來附加拖動項目的額外資訊。這裡,我們指定一個 tuple,當中包含了稍後把項目置放不同 Table View 時會用到的記事板、indexPath、及 table view。
  6. 最後,回傳包含我們創建的 UIDragItem 的陣列。

試著建置並執行 App,並在記事板中嘗試拖動項目。成功了!你現在可以在螢幕上拖動項目了。當然,目前你還沒有辦法將項目放到任何地方,讓我們馬上就來實作項目的置放行為吧!

drag-and-drop-3

使用 UITableViewDropDelegate 處理 UITableView 內的置放行為

接著,我們將要在 Table View 中加入支援置放的功能,這其實跟加入支援拖動的部份很相似,我們只需要設定 Table ViewdropDelegate 屬性給 BoardCollectionViewCell。到 BoardCollectionViewCell 中的 awakeFromNib 方法,在底部加入以下程式碼。

這時編譯器也會跳出錯誤,因為 BoardCollectionViewCell 還未實作 UITableViewDropDelegate 協定。因此,我們來到檔案的最底下,以擴展的方式加入下列程式碼。

以下就解釋了這段程式碼:

  1. 我們實作必要的 tableView:dropSessionDidUpdateSession:withDestinationIndexPath: 方法。這個方法所做的就是要告訴系統,每當使用者在 Table View 拖動項目時,我們想要如何透過特定的 indexPath 內的 UITableViewDragProposal 來消耗置放項目的數據。
  2. UITableViewDragProposal 接受三種類型的操作:copymove 或是 cancel。就我們的情況而言,我們只想要移動 (move) 數據,所以我們將 move 作為操作類型回傳 UITableViewDragProposal,並且將 intent 設定為 insertAtDestinationIndexPath
  3. 最後,我們需要實作 tableView:performDropWithCoordinator:,這個方法將會在使用者的手指離開螢幕時被觸發。在方法中,我們有機會從 coordinator 的 session 中載入拖動項目的數據表示法。我們也需要處理數據源的同步問題。接著,我們要求 Table View 執行移動操作的動畫。請記住,我們可以在不同的 Table View 之間拖動項目。
  4. 在方法之中,我們要求 coordinator 的 session 判斷是否有項目遵從 kUTTypePlainText,如果有的話,我們就使用傳遞 NSString 為型別的 loadObjectOfClass 方法來載入物件,系統將會執行拖動項目數據的載入,並將它傳到封包之中。
  5. 我們對拖動的項目來源 indexPath 和 session 目標 indexPath 使用 switch 條件敘述。
  6. 如果來源 indexPath 和目標 indexPath 都存在,則代表使用者正在同一 Table View 中進行拖放。在這裡,我們只使用來源 indexPath 從記事板刪除來源項目,接著使用目標 indexPath 插入項目。最後,我們告訴 Table View 重新載入來源和目標 indexPath 之間的列。
  7. 如果來源 indexPath 為 nil 而目標 indexPath 存在,則代表使用者在同一個 App 內的不同 Table View 拖動項目。要處理這個情況,我們可以透過附加在 UITableViewDragDelegatedrag sessionlocalContext 方法,來恢復來源 Table View、來源 indexPath、及來源記事板。我們使用來源 indexPath 將項目從來源記事板移除,並且告訴來源 Table View 要刪除該列。最後,我們使用目標 indexPath 將項目插入目標記事板,並告訴目標 Table View 插入該列。
  8. 最後一種情況,是當目標及來源的 indexPath 都是 nil。這種情況代表使用者從其他 App 拖動文字到我們的 App 中。在這種情況下,我們只需要將項目插入到目標記事板中,並告訴 Table View 插入該項目就可以了。

試著建置並執行 App,你應該能夠在記事板之間使用拖放來移動項目了!如果你想要更多的挑戰,可以查看 GitHub 上的專案,看看如何使用 UIDragDelegate 將項目拖放到客製化 UIView 刪除項目。

總結

恭喜,你成功了!我們已經透過 Drag and Drop API 完成了一個類似 Trello 的 App。這個 API 真的簡單又強大,而我們只是學會了它一部分的功能,其實還有更多功能等著你去探索,像是當置放項目需要花點時間時創建佔位符 (placeholder)、拖放多個項目、和其他非常好用的功能。所以你還在等甚麼?讓我們繼續學習、創建新的東西,用科技改善我們的世界吧!

本篇原文(標題:Building a Trello-like iOS App with Drag & Drop API)刊登於作者 Medium,由 Alfian Losari 所著,並授權翻譯及轉載。
作者簡介:Alfian Losari 是一位軟體工程師和 Swift 愛好者,他非常熱愛一切關係科技及其價值的事。他的座右銘是:如果人停止學習,就永遠不會進步。
譯者簡介:HengJay,iOS 初學者,閒暇之餘習慣透過線上 MOOC 資源學習新的技術,喜歡 Swift 平易近人的語法也喜歡狗狗,目前參與生醫領域相關應用的 App 開發,希望分享文章的同時也能持續精進自己的基礎。

LinkedIn: https://www.linkedin.com/in/hengjiewang/
Facebook: https://www.facebook.com/hengjie.wang

原文Building a Trello-like iOS App with Drag & Drop API


此文章為客座或轉載文章,由作者授權刊登,AppCoda編輯團隊編輯。有關文章詳情,請參考文首或文末的簡介。

blog comments powered by Disqus
訂閲電子報

訂閲電子報

AppCoda致力於發佈優質iOS程式教學,你不必每天上站,輸入你的電子郵件地址訂閱網站的最新教學文章。每當有新文章發佈,我們會使用電子郵件通知你。

已收你的指示。請你檢查你的電郵,我們已寄出一封認證信,點擊信中鏈結才算完成訂閱。

Shares
Share This