iPhone
iPad
iOS
Swift
swift4

iPhone / iPadのファイルアプリにテキストファイルを作成する

Swift 4, iOS 12.1で作成

つくるもの

 アプリ内に書き込んだテキストをテキストファイルとして書き出して、ファイルアプリ内にテキストファイルとして保存します。

Info.plistの設定

 Custom iOS Target Properties内のプロパティに項目を追加する。項目を選択するとKeyの右端に+と-が表示されるので、+をクリック。
スクリーンショット 2019-01-10 18.57.13.png
 "Supports opening documents in place"と"Application supports iTunes file sharing"を追加し、どちらもValueに"YES"を指定する。
スクリーンショット 2019-01-10 18.58.51.png
 "Supports opening documents in place"をYESにすると、ファイルアプリに保存できるようになります。
 "Application supports iTunes file sharing"をYESにすると、iTunesからDocumentsフォルダにアクセスできるようになります。

 これらを設定しないと内部では保存された状態になりますが、ファイルアプリ上に表示されません。

StoryboardでUIの作成

 Main.storyboardにはText FieldとButtonを配置。
スクリーンショット 2019-01-10 19.23.29.png

ViewControllerと連携

 View ControllerにText FieldとButtonをドラッグ&ドロップして連携。名前はmyTextとsaveButtonにしました。
スクリーンショット 2019-01-10 19.38.44.png

処理を書く

処理のフローは以下のようになります:
1. Button(saveButton)をタップしたら以下の処理を行う関数が呼び出される。
2. Text Field(myText)に書かれたテキストを取得。
3. ドキュメントフォルダにテキストファイルを保存。

saveButtonをタップして関数を呼び出す。

 先ほど置いたsaveButon関数の中に、createTextFile()を実行するよう記入します。

ViewController.swift
@IBAction func saveButton(_ sender: Any) {
        createTextFile()
    }

*この時点ではエラーが出ますが、まだその関数を置いていないからです。

createTextFile関数

 ViewControllerクラスの一番下にcreateTextFile関数を作ります。

ViewController.swift
func createTextFile(){
        let text = myText.text
        let textName = "data.txt"

        if let dir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last {
            let path = dir.appendingPathComponent(textName)


            do {
                try text?.write(to: path, atomically: true, encoding: String.Encoding.utf8)
            } catch let error as NSError {
                print("エラー:\(error)")
            }
        }
    }
}

以下は解説になります。

変数

 変数にはtextとtextName。関数が呼び出されたときにText Filed(myText)に書かれたテキストを変数textに入れます。書き出すファイル名はtextNameのものを使います。拡張子もここで指定しました。

ViewController.swift
func createTextFile(){
    let text = myText.text
    let textName = "data.txt"
}

保存場所を指定

 変数宣言に続いて、ドキュメントの場所を探してきます。
 *上記コードと一部異なっていますが、エラー処理(後述)のためなので、ここでは分かりやすく省略しています。

ViewController.swift
let dir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last
let path = dir.appendingPathComponent(textName)

 FileManagerクラスはファイルシステムを扱うために使用します。.defaultは常に同じファイルマネージャーを使用するための指定です。.urlsは指定したドメイン内のディレクトリを返してくれます。

 この場合はuserDomainMaskの中のdocumentDirectoryを返してくれます。userDomainMaskはiOSユーザのホームディレクトリを指し、documentDirectoryはドキュメントフォルダのディレクトリです。

 .lastは配列の最後のデータを取り出します。ここで指定した内容で得られるデータは1つだけなのですが、配列から文字列に変換するために.lastもしくは.firstで取り出します。ちなみにオプショナル型になります。

 dir.appendingPathComponentでは括弧内の文字列をdirの最後に追記してくれます。

つまりdirは
.../Documents/
までのパスを取得しましたが、

dir.appendingPathComponent(textName)で
.../Documents/data.txt
のように追記してくれます。

テキストファイルの作成

 先ほど取得したテキストファイルのパスへ、テキストを書き込みます。

ViewController.swift
text?.write(to: path, atomically: true, encoding: String.Encoding.utf8)

 text?.writeで指定したパスへtextの文字列を書き込みます。

 text?とアンラップされているのはエラー処理のためです。textはText Fieldに入力された文字列が代入されます。何も書かれずにButtonが押されればnilが返ってきます。!でアンラップすると、nilが返ってきてクラッシュしますが、?でアンラップすることで、それに続く処理が中断されます。

 to:では書き込み先のディレクトリを指定します。先ほど取得したテキストファイルのパスを指定しています。

 atomically:がtrueの場合、一度バックアップファイルに書き込まれ、エラーが発生しなかった場合に、指定したパスに書き込みます。

 encoding:は文字コードの指定です。一般的なUTF-8を指定しました。

エラー処理

 textFiledに何も書かれていなかったり、ドキュメントのディレクトリが見つからなかったり、書き込みに失敗したり、様々な場合にnilが返ってきてアプリがクラッシュします。クラッシュを避けるためにコードを書き直しました。

ViewController.swift
        if let dir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last {
            let path = dir.appendingPathComponent(textName)

            do {
                try text?.write(to: path, atomically: true, encoding: String.Encoding.utf8)
            } catch let error as NSError {
                print("エラー:\(error)")
            }
        }

 以下は細かく分けて解説です。

ViewController.swift
        if let dir = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).last {
            let path = dir.appendingPathComponent(textName)
        }

 ドキュメントフォルダのディレクトリを取得できた場合のみ、テキストファイルの指定をしています。

 またdo-catchとtryでエラーが起きた場合の保険をかけています。

ViewController.swift
do {
    try text?.write(to: path, atomically: true, encoding: String.Encoding.utf8)
} catch let error as NSError {
    print("エラー:\(error)")
}

 do{}内に記述したメソッドでエラーが発生した場合catch{}を実行します。

 do{}内ではメソッドの前にtryを記述します。
 let error as NSErrorで、tryで行ったメソッドのエラー情報がerrorに入り、catch{}内でコンソールに記述させています。

完成

 ビルドしてみましょう。
 Text Field内に適当な文字を入力してButtonをタップします。

 ホームに戻り、フォルダアプリをタップします。アプリ内にOn My iPhone(iPad)という項目が出現しました。

 Browseにプロジェクトファイル名のフォルダができ、中には先ほど生成したdata.txtが生成されました。テキストファイルの中には、Text Fieldに記入したテキストが書かれています。