SwiftのDropbox APIでファイルデータを取得する。

この記事は2018年06月18日に投稿しました。
この記事は2018年07月20日に更新しました。

f:id:paveway:20190914064630j:plain

1. はじめに

こんにちは、iOSのエディタアプリPWEditorの開発者の二俣です。

ファイルデータを取得する処理はダウンロードの機能で行います。
Dropbox APIのダウンロード機能は、ファイルデータのみを取得するのではなく、ファイル自体をダウンロードする機能のようです。
PWEditorでは他のストレージとの動作に合わせ、ファイルデータはメモリで保持し、更新時にファイルデータをアップロードする仕様にしています。そのためDropboxの場合、ファイルデータはいったん一時ファイルとしてファイルをダウンロードして、そのファイルをメモリに展開することにしました。

目次へ

2. ファイルデータ取得処理

ファイルデータを取得する処理は次の手順になります。

一時ファイルのダウンロードURL(ファイル名)を生成します。
一時ファイルをダウンロードします。
一時ファイルがダウロードできたら、ファイルデータをメモリに展開します。
一時ファイルを削除します。

PWEditorでは、この後ファイルデータがテキストデータかチェックして、テキストデータに変換していますが、サンプルでは省略します。

/**
 ファイルパス名で示されるファイルデータを取得します。
 
 - Parameter filePathName: ファイルパス名
 */
func getFileData(filePathName: String) {
    gaurd let client = DropboxClientManager.authorizedClient else {
        // 認証済みクライアントオブジェクトが取得できない場合、処理を終了します。
        // 念のためのチェックです。
        // 必要ならばエラー処理してください。
        return
    }

    // 一時ファイル用のダウンロード先URLを取得します。
    // 一時ファイルはユーザがアクセスする領域にダウンロードされます。
    // そのためユーザが作成するファイル名と重複しないように
    // ファイル名の先頭にUUIDを付加しています。
    let destination : (URL, HTTPURLResponse) -> URL = { temporaryURL, response in
        let fileManager = FileManager.default
        let directoryURL = fileManager.urls(for: .documentDirectory, in: .userDomainMask)[0]
        let UUID = Foundation.UUID().uuidString
        var fileName = ""
        if let suggestedFilename = response.suggestedFilename {
            fileName = suggestedFilename
        }
        let pathComponent = "\(UUID)-\(fileName)"
        return directoryURL.appendingPathComponent(pathComponent)
    }

    // ファイルをダウンロードします。
    // filePathNameはDropbox上のファイルパス名です。
    // destinationが一時ファイルのダウンロード先になります。
    let _ = client.files.download(path: filePathName, destination: destination).response { response, error in
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要ならばエラー処理してください。
            return
        }

        guard let response = response else {
            // レスポンスがない場合、処理を終了します。
            // 必要ならばエラー処理してください。
            reutrn
        }

        guard let (metadata, url) = response else {
            // レスポンスデータがファイル情報ではない場合、処理を終了します。
            // 必要ならばエラー処理してください。
            reutrn
        }

        // ファイル属性情報を取得します。
        // ファイル属性情報が必要ならば、fileMetadataから取得してください。
        if type(of: metadata) != Files.FileMetadata.self {
            // ファイル属性情報ではない場合、処理を終了します。
            // 必要ならばエラー処理してください。
            reutrn
        }
        let fileMetadata = metadata as Files.FileMetadata

        // ダウンロードしたファイルからファイルデータを取得し、メモリに展開します。
        let data: Data?
        do {
            data = try Data(contentsOf: url)
        } catch {
            data = nil
        }

         // この時点で一時ファイルは不要になります。
　　　　　// そのためこのタイミングで、一時ファイルを削除しておきます(処理は省略します)

        // ファイルデータが取得できたかチェックします。
        guard let fileData = data else {
            // ファイルデータが取得できない場合、処理を終了します。
            // 念のためのチェックです。
            // 必要ならばエラー処理してください。
            reutrn
        }

        // 正常終了の場合の処理を記述してください。
        // 取得したファイルデータはData型のため、ファイルの内容に合わせて適切に変換してください。
        // PWEditorでは、
        // 　①ファイルデータがテキストデータかチェックする。
        // 　②テキストデータに変換する。
        // を行なっています。
    }
}

API Refernce
downloadメソッド

目次へ

3. おわりに

最初はDropboxから直接ファイルデータを取得する方法を探しましたが、見つかりませんでした。
苦肉の策で、一時ファイルをダウンロードして、メモリに展開する仕様にしました。
この方法でもいいのですが、一時ファイルはユーザが使用する領域にできるため、ユーザのファイルと重複する可能性が捨てきれません。
また何かのタイミングで一時ファイルが残ってしまう可能性もあり、できれば他の方法にしたかったです。

念のため、PWEditorではアプリ起動時に何らかの原因で残ってしまった一時ファイルを削除するようにしています。

[改訂新版]Swiftポケットリファレンス (POCKET REFERENCE)

作者: WINGSプロジェクト片渕彼富,山田祥寛
出版社/メーカー: 技術評論社
発売日: 2018/03/09
メディア: 単行本（ソフトカバー）
この商品を含むブログを見る

TECH::EXPERT

紹介している一部の記事のコードは[Gitlab]で公開しています。
興味のある方は覗いてみてください。

目次へ

私が勤務している[ニューラル][ニューラル]では、主に組み込み系ソフトの開発を行っております。
弊社製品のハイブリッドOS [Bi-OS][Bi-OS]は高い技術力を評価されており、特に制御系や通信系を得意としています。
私自身はiOSモバイルアプリやウィンドウズアプリを得意としております。
ソフトウェア開発に関して相談などございましたら、お気軽にご連絡ください。

また一緒に働きたい技術者の方も随時募集中です。
興味がありましたらご連絡ください。

EMAIL : info-nr@newral.co.jp / m-futamata@newral.co.jp
TEL : 042-523-3663
FAX : 042-540-1688

目次へ