SwiftのDropbox APIでファイル一覧を取得する。

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

f:id:paveway:20190914064630j:plain

1. はじめに

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

いよいよDropboxのファイルにアクセスします。
まず最初に指定されたパス上のディレクトリとファイルの一覧を取得してみます。

2. ファイル一覧取得処理

指定されたパスのディレクトリ、ファイルの一覧を取得するには、listFolderメソッドを実行します。
listFolderメソッドの引数は他にもいくつかありますが、PWEditorではpathのみ指定して、その他の引数はデフォルト値のままにしています。

取得した結果は、クロージャのresponseとerrorで返却されます。
実行した結果、エラーの場合はerrorがセットされ、正常の場合はresponseがセットされます。
PWEditorでは念のため、両方の存在チェックを行っています。

listFolderメソッドを実行すると、通信処理が行われるため時間がかかります。
PWEditorでは処理中ダイアログを表示して、ユーザに処理中であることを知らせています。

/**
 指定したパス名にあるディレクトリ情報、ファイル情報の一覧を取得します。
 ルートディレクトリの一覧を取得する場合は、pathNameに"/"を指定してください。
 パス名は"/パス名1/パス名2..."となります。
 */
func getFileInfoList(pathName: String) {
    gaurd let client = DropboxClientManager.authorizedClient else {
        // Dropboxの認証済みクライアントオブジェクトが取得できない場合、処理を終了します。
        // 必要ならばエラー処理してください。
        // 念のためのチェックです。
        return
    }

    // ディレクトリ、ファイルの一覧を取得します。
    // 非同期で動作します。
    // 一覧取得後、クロージャの処理が呼び出されます。
    let _ = client.files.listFolder(path: pathName).response { response, error in
        if let error = error {
            // エラーの場合、処理を終了します。
            // 必要ならばエラー処理してください。
            return
        }

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

        // エントリー数分繰り返します。
        // entryオブジェクトからディレクトリ、ファイル情報が取得できます。
        for entry in response.entries {
            // 名前
            let name = entry.name

            // パス名
            let pathName = entry.pathLower

            if let fileMetadata = entry as? Files.FileMetadata {
                // ファイルの場合

            } else if let folderMetadata = entry as? Files.FolderMetadata {
                // フォルダの場合

            } else {
                // 上記以外、無視する。
            }
        }
    }
}

API Reference
listFolderメソッド

目次へ

3. おわりに

listFolderメソッドのクロージャですが、実装当初クロージャをあまり使ったことがなかったのとDropboxのAPIリファレンスの見方がよくわからなかったため、どのように実装すればよいか試行錯誤した記憶があります。
(DropboxのAPIリファレンスは未だに見づらいです)

またディレクトリ、ファイル情報を取得するところでは、ファイルかディレクトリかをどうやって判別するかも悩みました。
ファイルかディレクトリかの判別方法はもっとスマートな方法があるかもしれませんが、PWEditorではこのように実装しています。

詳解 Swift 第4版

作者: 荻原剛志
出版社/メーカー: SBクリエイティブ
発売日: 2017/12/26
メディア: 単行本
この商品を含むブログ (1件) を見る

【TECH::CAMP（エンジニアスクール）】

紹介している一部の記事のコードは[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

目次へ