プログラムを書こう！

実務や自作アプリ開発で習得した役に立つソフトウェア技術情報を発信するブログ

トップ > PWEditor > SwiftのiCloudでファイル一覧を取得する。

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

PWEditor Swift

この記事は2018年07月11日に投稿しました。
この記事は2018年07月21日に更新しました。

f:id:paveway:20190914064630j:plain

目次

  1. はじめに
  2. ファイル一覧取得処理
  3. おわりに

現場のためのSwift4 Swift4.1+Xcode9.3対応

現場のためのSwift4 Swift4.1+Xcode9.3対応

1. はじめに

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

"iCloudDocumentSync"ライブラリを使って、iCloudのファイル一覧を取得してみます。
"iCloudDocumentSync"ライブラリを使用した場合、ファイル一覧を取得した結果はクロージャではなく、コールバックメソッドで返されます。

目次へ

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

"iCloudDocumentSync"ライブラリを使用してファイル一覧を取得する場合、次の手順になります。

  1. UIViewControllerに"iCloudDelegate"を指定します。
  2. iCloudオブジェクトの”delegate"に"1のUIViewController"を設定します。
  3. iCloudオブジェクトの"query"オブジェクトの"start"メソッドでクエリを開始します。
  4. 続いて"query"オブジェクトの"updateFiles"メソッドを呼び出し、ファイル更新を要求します。
  5. "iCloudDocumentSync"ライブラリから"iCloudFilesDidChange"メソッドがコールバックされ、ファイル一覧を取得します。
  6. ファイル一覧画面を離れる際、"query"オブジェクトの"stop"メソッドでクエリを停止します。

PWEditorでは、同じUIViewControllerでサブディレクトリのファイル一覧画面も再帰的に取得しています。
例えば、メニュー画面からまずルートディレクトリのファイル一覧画面を表示する場合、次のようにします。

// ルートディレクトリのファイル一覧画面を表示します。
// 引数pathNameにルートディレクトリとして""を指定します。
let vc = ICloudFileListViewController(pathName: "")
navigationContorller?.pushViewController(vc, animated: true)

次に、ルートディレクトリを表示したファイル一覧画面から、サブディレクトリ"dir1"のファイル一覧画面を表示する場合、次のようにします。

// サブディレクトリのファイル一覧を取得します。
// 引数pathNameにサブディレクトリとして"/dir1"を指定します。
let vc = ICloudFileListViewController(pathName: "/dir1")
navigationContorller?.pushViewController(vc, animated: true)

これには2つの問題がありました。

  • クエリを停止しないと、UIViewControllerの引数pathNameが置き換わらない。
  • クエリの停止タイミングによっては、先に遷移先のクエリが開始されてしまう。

そのためいろいろ試した結果、次のようなタイミングでクエリの開始/停止を実装しました。

  • queryの開始 : viewWillAppear
  • queryの停止 : viewWillDisappear

詳細はコード上のコメントを参照してください。

もう1つの問題点というか"iCloudDocumentSync"ライブラリの仕様と思われますが、ファイル一覧を取得するqueryおよびコールバックメソッドで、対象とするパスが指定できません。
どういうことかというと、コールバックメソッドで返されるファイル一覧は、コンテナ上にあるすべてのディレクトリとファイルの一覧になるということです。

例えば、コンテナ上が次のようなディレクトリ・ファイル構成だとします。

/
+-dir1
| +-dir11
| |+-file11
| +file1
+-dir2
+-file3

Dropbox APIやOneDrive APIの場合、ルートディレクトリを指定してファイル一覧を取得した場合、

  • /dir1
  • /dir2
  • /file3

が取得できます。

ところがiCloudDocumentSyncの場合、次のようにすべてのディレクトリ・ファイルの一覧が取得されしまいます。

  • /dir1
  • /dir1/dir11
  • /dir1/dir11/file11
  • /dir1/file1
  • /dir2
  • /file3

そのため、PWEditorでは取得したディレクトリ・ファイルの一覧から、UIViewControllerの引数pathNameに一致するディレクトリ・ファイルのみ一覧化する処理を行っています。

またコールバックメソッドで返される"fileNames"は、各ディレクトリやファイルのパス名になります。
このパス名はiCloud上のパス名のため、先頭にドキュメントURLのパス名が付加されています。
つまり上記の例の"/dir1"は、実際は"<ドキュメントURLのパス名>/dir1"になります。
そのためPWEditorでは、この"<ドキュメントURLのパス名>"を削除する処理を行っています。

import iCloudDocumentSync

/**
 iCloudのファイル一覧を表示する画面クラス
 取得したファイル一覧はテーブルビューで表示しています。
 (ここでは表示部分の処理は省略します)
 */
class ICloucFileListViewController: UIViewController, iCloudDelegate {

    /// パス名
    var pathName: String
    
    /**
     イニシャライザ

     - Parameter coder: デコーダー
     */
    required init?(coder aDecoder: NSCoder) {
        // 使用しない。
        abort()
    }

    /**
     イニシャライザ

     - Parameter pathName: パス名
     */
    init(pathName: String) {
        // 引数のパス名を保存します。
        self.pathName = pathName

        // スーパークラスのメソッドを呼び出します。
        super.init(nibName: nil, bundle: nil)
    }
    
    /**
     インスタンスが生成された時に呼び出されます。
     */
    override func viewDidLoad() {
        // スーパークラスのメソッドを呼び出します。
        super.viewDidLoad()

        // iCloudのデリゲートに自画面を設定します。
        if let cloud = iCloud.shared() {
            cloud.delegate = self
        }
    }
    
    /**
     画面が表示される前に呼び出されます。

     - Parameter animated: アニメーション指定
     */
    override func viewWillAppear(_ animated: Bool) {
        // スーパークラスのメソッドを呼び出します。
        super.viewWillAppear(animated)

        // iCloudのファイル一覧を取得します。
        // 引数のpathNameを更新するため、viewWillDisappearでクエリを停止しているので、
        // ここでqueryを起動します。
        // query.staredプロパティで停止中かどうかを確認すべきですが、query.staredプロパティは
        // 常にtrueが返却されるため、無条件でqueryを開始します。
        if let cloud = iCloud.shared() {
            // クエリを開始します。
            cloud.query.start()
            // ファイル更新を要求します。
            cloud.updateFiles()
        }
    }

    /**
     画面が消される前に呼び出されます。

     - Parameter animated: アニメーション指定
     */
    override func viewWillDisappear(_ animated: Bool) {
        // クエリを停止します。
        // サブディレクトリに移動した場合、クエリを停止しないと引数pathNameが更新されません。
        // viewDidDisappearで行うと遷移先画面のviewWillAppearが先に動くため、
        // viewWillDisappearで行います。
        if let cloud = iCloud.shared() {
            // クエリを停止します。
            cloud.query.stop()
        }

        // スーパークラスのメソッドを呼び出す。
        super.viewDidDisappear(animated)
    }
    
    /**
     ファイル一覧が取得された場合、iCloudDocumentSyncから呼び出されるコールバックメソッドです。
     */
    func iCloudFilesDidChange(_ files: NSMutableArray!, withNewFileNames fileNames: NSMutableArray!) {
        // iCloudオブジェクトを取得します。
        guard let cloud = iCloud.shared() else {
            // iCloudoオブジェクトが取得できない場合、処理を終了します。
            // 念のためのチェックです。
            // 必要に応じでエラー処理を行ってください。
            return
        }

        // ドキュメントURLを取得します。
        guard let documentsUrl = cloud.ubiquitousDocumentsDirectoryURL() else {
            // ドキュメントURLが取得できない場合、処理を終了します。
            // 必要に応じてエラー処理を行ってください。
            return
        }
        // ドキュメントURLのパス名を取得します。
        let documentsPath = documentsUrl.path

        // ファイル情報数分繰り返します。
        let fileNum = files.count
        for i in 0 ..< fileNum {
            // ファイル情報かチェックします。
            guard let file = files[i] as? NSMetadataItem else {
                // ファイル情報ではない場合、次のファイル情報を処理します。
                continue
            }
            
            // パス名を取得します。
            // このパス名には、先に取得したドキュメントURLのパス名が先頭に付加されています。
            guard let path = file.value(forKey: NSMetadataItemPathKey) else {
                // パス名が取得できない場合、次のファイル情報を処理します。
                continue
            }
            
            // ディレクトリかファイルか判別する処理のサンプルです。
            // ディレクトリかファイルか判定するタイプを取得します。
            let contentType = file.value(forKey: NSMetadataItemContentTypeKey) as! String
            if contentTyep == "public.folder" {
                // ディレクトリの場合
            
            } else {
                // ファイルの場合
            }
            
            // PWEditorでは、UIViewControllerの引数pathNameに該当するディレクトリ・ファイルの一覧を
            // 抽出する処理を行っています。
            // またiOS10以前とiOS11以降で、取得されるファイル一覧が微妙に異なるため、
            // iOS10以前とiOS11以降で処理をわけて実装しています。
        }
    }
}

目次へ

3. おわりに

Dropbox APIやOneDrive APIのファイル一覧取得処理とおなじイメージで、iCloudも指定したパスのファイル一覧が取得できると考えていましたが、そうではありませんでした。
上記のコード例では省略していますが、該当するパスのファイル一覧を抽出する処理はかなり面倒です。

またiOS10以前とiOS11以降で取得されるファイル一覧が微妙に違うため、PWEditorのファイル一覧の抽出処理はiOS10以前とiOS11以降で分けて実装しています。

Tech Boost

詳解 Swift 第4版

詳解 Swift 第4版

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

目次へ

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

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

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

目次へ