【Swift】アプリ内のファイル読み書き

（2021/04/22 更新）

アプリ内のファイル読み書き方法を解説します。

環境
iOSアプリのファイルシステム
1. iOSアプリのフォルダ構成
アプリからファイルの読み書きをする
1. ファイル書き込み処理の解説
2. ファイル読み込み処理の解説
  1. ファイルの読み込み
実際のファイルを見る方法
あわせて読みたい記事

環境

この記事の情報は次のバージョンで動作確認しています。

【Xcode】12.4
【Swift】5.3.2
【iOS】14.4
【macOS】Big Sur バージョン 11.1

iOSアプリのファイルシステム

iOSアプリは、システム（iOS）が不正に操作されるのを防ぐ為、アクセスできるフォルダがアプリ毎に隔離されています。（Sandbox構造）
対象のフォルダは、該当アプリからのみアクセスできますが、端末からアプリを削除すると一緒に削除されます。
本記事では、対象フォルダでのファイル読み書きについて解説します。

なお、アプリに元からバンドルされているリソースファイルにアクセスする方法は、【Swift】プロジェクト内のファイル読み込みを参照して下さい。

iOSアプリのフォルダ構成

こちらがiOSアプリから読み書きできるフォルダの構成例です。
（フォルダの開き方は、後で解説します）

Documents
ユーザーが作成したファイル、あるいはアプリケーションで再作成できないドキュメントやその他データ（画像、動画など）のうち、ユーザーに見えるようにするファイルをここに保存します。
このフォルダの内容は、後述する方法によって「ファイル」アプリケーションで参照できます。
任意のサブフォルダを作成可能です。
このフォルダはiTunes/iCloudにバックアップされます。
上記に該当しないファイル（キャッシュデータなど）を置いた場合、AppStoreの審査でリジェクトになる場合があります。

Library
Documentフォルダに入れるようなデータ以外を保存するフォルダです。
UserDefaultsに保存したデータは、plistとしてこのフォルダ配下に保存されます。
このフォルダ配下に置いたファイルの内、Chacheフォルダ以外はiTunes/iCloudにバックアップされます。

Library/Application Support
アプリに必要であるが、アプリのデータベースファイルのようにユーザーに見えないようにするファイルをここに保存します。
Core DataのDBファイルもここに作成されます。
このフォルダはiTunes/iCloudにバックアップされます。

Library/Caches
再度ダウンロードまたは再生成できるデータを保存するフォルダです。
例として、データベースのキャッシュファイルや、雑誌、新聞、地図のアプリケーションで使用されるようなダウンロード可能なコンテンツなどが含まれます。
デバイスのディスクスペースが不足している場合、iOSはしばらく使用されていないアプリのキャッシュファイルを削除する可能性があります。
このフォルダはiTunes/iCloudにバックアップされません。

tmp
一時的にのみ使用されるデータを保存するフォルダです。
ファイルを使い終わったら削除をお勧めします。
アプリが起動していない時に、システムによって自動削除される可能性があります。
このフォルダはiTunes/iCloudにバックアップされません。

アプリからファイルの読み書きをする

はじめにサンプルソースを示します。
「実行」ボタンを押すと、アプリケーションのDocumentsフォルダ内の"output.txt"ファイルに文字列を書き込みをし、その後同ファイルから内容を読み込むサンプルです。
実行ボタンはSwiftUIで実現していますが、ファイルの書き込みおよび読み込み処理にはSwiftUIの機能は使用していませんので、UIKitを使ったアプリでも流用可能です。

import SwiftUI

struct ContentView: View {

var body: some View {

Button("実行") {

/// ファイル書き込み

self.writingToFile(text: "カピ通信")

/// ファイル読み込み

/// 読み込んだファイルの内容を確認

print("【ファイル内容】\(self.readFromFile())")

}

/// ファイル書き込みサンプル

func writingToFile(text: String) {

/// ①DocumentsフォルダURL取得

guard let dirURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first else {

fatalError("フォルダURL取得エラー")

}

/// ②対象のファイルURL取得

let fileURL = dirURL.appendingPathComponent("output.txt")

/// ③ファイルの書き込み

do {

try text.write(to: fileURL, atomically: true, encoding: .utf8)

} catch {

print("Error: \(error)")

}

/// ファイル読み込みサンプル

func readFromFile() -> String {

/// ①DocumentsフォルダURL取得

guard let dirURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first else {

fatalError("フォルダURL取得エラー")

}

/// ②対象のファイルURL取得

let fileURL = dirURL.appendingPathComponent("output.txt")

/// ③ファイルの読み込み

guard let fileContents = try? String(contentsOf: fileURL) else {

fatalError("ファイル読み込みエラー")

}

/// ④読み込んだ内容を戻り値として返す

return fileContents

}

ファイル書き込み処理の解説

DocumentsフォルダURL取得

FileManager.default.urls()を使って、DocumentsフォルダURLを取得します。

/// ①DocumentsフォルダURL取得

guard let dirURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first else {

fatalError("フォルダURL取得エラー")

}

引数（for）にはDocumentフォルダを示す.documentDirectoryを、引数（in）にはアプリのファイルが格納されているフォルダドメインを示す.userDomainMaskを指定します。
戻り値にはフォルダURLの配列が返るので、.firstをつけて先頭[0]の要素を取得します。

対象フォルダが取得できない場合はnilが戻りますので、その場合サンプルではfatalError()で強制的にアプリをクラッシュさせています。

FileManagerはファイルとディレクトリを管理するクラスです。
このクラスの１つのオブジェクトがアプリに割り当てられ、アプリのために予約されたストレージスペース内のファイルやディレクトリを作成、削除、コピー、移動ができます。
このオブジェクトを参照するプロパティがFileManager.defaultです。

対象のファイルURL取得

フォルダURLにファイル名を追加して、ファイルURLとします。
ファイルに対しての操作は、このファイルURLを使用します。

/// ②対象のファイルURL取得

let fileURL = dirURL.appendingPathComponent("output.txt")

ファイルの書き込み

Stringに標準で用意されているwriteメソッドを使って、ファイルに書き込みを行います。

/// ③ファイルの書き込み

do {

try text.write(to: fileURL, atomically: true, encoding: .utf8)

} catch {

print("Error: \(error)")

}

引数（to）には書き込むファイルのURLを指定します。ファイルが存在しない場合は、生成されます。
引数（atomically）は、元のファイルが破損しないようにするために、データを最初に補助ファイルに保存するかどうかをBool値で指定します (true推奨)。
引数（encoding）は、文字列を生成するために使用されるエンコーディングタイプを指定します。
特別な事情が無い場合は、utf8にしておけば問題ありません。

このメソッドは、書き込みできない場合にエラーを返す為、do-try-catchでエラーハンドリングをしています。