SwiftのiCloudでディレクトリを作成する。

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

f:id:paveway:20190914064630j:plain

1. はじめに

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

今回はiCloudDocumentSyncライブラリを使って、iCloudでディレクトリを作成してみます。

2. ディレクトリ作成処理

iCloudでディレクトリを作成するにあたり、iCloudの仕様なのか、iCloudDocumentSyncライブラリの仕様なのかわからないのですが、iCloud上に空のディレクトリを作成することができませんでした。
iCloud上にディレクトリを作成するには、ディレクトリとその中にファイルも作成する必要がありました。

そのためPWEditorでは、iCloudのディレクトリの作成は、iCloudのファイル作成画面でディレクトリとファイルを指定して行うようにしました。

またiCloud上にディレクトリを作成するには、iCloudDocumentSyncライブラリではなく、FileManagerクラスのcreateDirectoryメソッドを使用します。
createDirectoryメソッドは、iOS端末のローカルストレージにディレクトリを作成します。

そのためディレクトリを作成する場所がポイントになります。
つまりiCloudで認識される場所にディレクトリを作成する必要があります。

iCloudで認識される場所は、iCloudオブジェクトのubiquitousDocumentsDirectoryURLメソッドで取得できます。
ubiquitousDocumentsDirectoryURLメソッドで取得したドキュメントURLの配下に、ディレクトリ作成します。

これらのことはiCloudDocumentSyncライブラリのドキュメントで見つけられませんでした。
別のサイトなど、いろいろ調べて実装しました。
(すみません情報源については失念しました)

import iCloudDocumentSync

/**
 iCloudで、ディレクトリを作成します。

 - Parameter dirName: ディレクトリ名
 */
func createDir(_ dirName: String) {
    // iCloudオブジェクトを取得します。
    guard let cloud = iCloud.shared() else {
        // iCloudが取得できない場合、処理を終了します。
        // 念のためのチェックです。
        // 必要に応じてエラー処理を行ってください。
        return false
    }

    // iCloudで認識される場所(ドキュメントURL)を取得します。
    guard var documentUrl = cloud.ubiquitousDocumentsDirectoryURL() else {
        return false
    }

    // ドキュメントURLに作成するディレクトリ名を付加し、作成するディレクトリURLを作成します。
    documentUrl = documentUrl.appendingPathComponent(dirName)

    // 作成するディレクトリと同名のディレクトリが存在しないかチェックします。
    // fileExistsメソッドは、引数atPathで指定されたディレクトリまたはファイルが存在するかどうかチェックします。
    // 存在する場合はtrueを返却し、存在しない場合はfalseを返却します。
    //
    // また同名のディレクトリまたはファイルが存在する場合、引数isDirectoryに存在するのがディレクトリかどうかが設定されます。
    // isDirectoryがtrueの場合は存在するのがディレクトリで、falseの場合は存在するのがファイルになります。
    let fileManager = FileManager.default
    var isDirectory: ObjCBool = false
    let result = fileManager.fileExists(atPath: documentUrl.path, isDirectory: &isDirectory)
    if !result || (result && !isDirectory.boolValue) {
        // 同名のディレクトリが存在しない、または存在するのは同名のファイルの場合
        do {
            // ディレクトリを作成します。
            // ディレクトリが作成できない場合、例外が発生する場合があるので、do～catchで例外を処理します。
            try fileManager.createDirectory(at: targetUrl, withIntermediateDirectories: true, attributes: nil)
        } catch {
            // 例外が発生しディレクトリが作成できない場合、処理を終了します。
            // 必要に応じてエラー処理を行ってください。
            return
        }
        
        // 正常終了の場合、ファイルを作成してください。
        // (ここではファイル作成処理については省略します)
    }
}

目次へ

3. おわりに

iCloudDocumentSyncライブラリのドキュメントにディレクトリ作成に関する記述がありませんでした。
そのため最初はファイル作成で使用したsaveAndCloseDocumentWithNameメソッドであれこれ試行錯誤しました。
結局saveAndCloseDocumentWithNameメソッドでディレクトリは作成できないため、他の方法を調べて実装しました。

オンラインで学ぶ！小中学生向けプログラミング D-SCHOOLオンライン

[改訂新版]Swift実践入門 ── 直感的な文法と安全性を兼ね備えた言語 (WEB+DB PRESS plus)

作者: 石川洋資,西山勇世
出版社/メーカー: 技術評論社
発売日: 2018/01/17
メディア: 単行本（ソフトカバー）
この商品を含むブログを見る

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

目次へ

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

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

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

目次へ