はじめに

Core Dataは、Appleが提供するオブジェクトグラフ管理および永続化フレームワークです。アプリ内でデータの保存、取得、更新、削除を効率的に行うことができます。本記事では、iOSアプリでのCore Dataの基本的な使い方と、一対多のリレーションシップ、多対多のリレーションシップの例を含めて、SwiftUI を用いて解説します。

Core Dataのセットアップ

プロジェクトにCore Dataを追加する

新しいプロジェクトを作成する際に、*「Use Core Data」 のオプションにチェックを入れることで、自動的にCore Dataがセットアップされます。SwiftUIプロジェクトの場合、PersistenceController というクラスが自動生成され、Core Dataスタックの管理が簡単になります。

既存のプロジェクトにCore Dataを追加する場合は、以下の手順を行います。

データモデルファイルの追加

File > New > File... を選択し、Data Model を検索して追加します。

Core Data Stackのセットアップ

PersistenceController クラスを作成し、以下のように設定します。

import CoreData

struct PersistenceController {
    static let shared = PersistenceController()

    let container: NSPersistentContainer

    init(inMemory: Bool = false) {
        container = NSPersistentContainer(name: "YourDataModelName")
        if inMemory {
            container.persistentStoreDescriptions.first?.url = URL(fileURLWithPath: "/dev/null")
        }
        container.loadPersistentStores { storeDescription, error in
            if let error = error as NSError? {
                fatalError("Unresolved error \(error), \(error.userInfo)")
            }
        }
    }
}

`managedObjectContext`を環境変数として設定

YourAppApp.swift ファイルで、managedObjectContext を環境変数に追加します。

@main
struct YourAppApp: App {
    let persistenceController = PersistenceController.shared

    var body: some Scene {
        WindowGroup {
            ContentView()
                .environment(\.managedObjectContext, persistenceController.container.viewContext)
        }
    }
}

データモデルの定義

データモデルエディタを使用して、エンティティとその属性を定義します。例えば、Person エンティティを作成し、以下の属性を追加します。

name (String)
age (Integer 16)

CRUD操作の実装

コンテキストの取得（SwiftUIの場合）

import SwiftUI

struct ContentView: View {
    @Environment(\.managedObjectContext) private var viewContext

    var body: some View {
        // ここで viewContext を使用できます
    }
}

データの作成（Create）

Button(action: {
    let newPerson = Person(context: viewContext)
    newPerson.name = "山田太郎"
    newPerson.age = 30

    do {
        try viewContext.save()
        print("データの保存に成功しました")
    } catch {
        print("エラー: \(error)")
    }
}) {
    Text("新しい人を追加")
}

データの取得（Read）

struct ContentView: View {
    @Environment(\.managedObjectContext) private var viewContext

    @FetchRequest(
        entity: Person.entity(),
        sortDescriptors: [NSSortDescriptor(keyPath: \Person.name, ascending: true)]
    ) private var people: FetchedResults<Person>

    var body: some View {
        List {
            ForEach(people) { person in
                VStack(alignment: .leading) {
                    Text("名前: \(person.name ?? "不明")")
                    Text("年齢: \(person.age)")
                }
            }
        }
    }
}

データの更新（Update）

Button(action: {
    if let personToUpdate = people.first {
        personToUpdate.age = 31
        do {
            try viewContext.save()
            print("データの更新に成功しました")
        } catch {
            print("エラー: \(error)")
        }
    }
}) {
    Text("年齢を更新")
}

データの削除（Delete）

Button(action: {
    if let personToDelete = people.first {
        viewContext.delete(personToDelete)
        do {
            try viewContext.save()
            print("データの削除に成功しました")
        } catch {
            print("エラー: \(error)")
        }
    }
}) {
    Text("人を削除")
}

一対多のリレーションシップの例

エンティティの設定

一対多のリレーションシップを設定するために、以下の2つのエンティティを作成します。

Department エンティティ
- 属性:
  - name (String)
- リレーションシップ:
  - employees (一対多, 先: Employee, 双方向)
Employee エンティティ
- 属性:
  - name (String)
- リレーションシップ:
  - department (多対一, 先: Department, 双方向)

データモデルエディタで、Department と Employee の間に一対多のリレーションシップを作成し、それぞれのリレーションシップが双方向になるように設定します。

データの作成とリレーションシップの設定

// コンテキストの取得
@Environment(\.managedObjectContext) private var viewContext

// Departmentエンティティのインスタンスを作成
let department = Department(context: viewContext)
department.name = "開発部"

// Employeeエンティティのインスタンスを作成
let employee1 = Employee(context: viewContext)
employee1.name = "田中太郎"
employee1.department = department

let employee2 = Employee(context: viewContext)
employee2.name = "鈴木花子"
employee2.department = department

do {
    try viewContext.save()
    print("データとリレーションシップの保存に成功しました")
} catch {
    print("エラー: \(error)")
}

データの取得（リレーションシップを含む）

@FetchRequest(
    entity: Department.entity(),
    sortDescriptors: []
) private var departments: FetchedResults<Department>

var body: some View {
    List {
        ForEach(departments) { department in
            Section(header: Text("部署名: \(department.name ?? "不明")")) {
                if let employees = department.employees?.allObjects as? [Employee] {
                    ForEach(employees) { employee in
                        Text("社員名: \(employee.name ?? "不明")")
                    }
                }
            }
        }
    }
}

また、Employee エンティティから所属する部署を取得することもできます。

@FetchRequest(
    entity: Employee.entity(),
    sortDescriptors: []
) private var employees: FetchedResults<Employee>

var body: some View {
    List {
        ForEach(employees) { employee in
            VStack(alignment: .leading) {
                Text("社員名: \(employee.name ?? "不明")")
                if let department = employee.department {
                    Text("部署: \(department.name ?? "不明")")
                }
            }
        }
    }
}

リレーションシップの更新

既存の社員の部署を変更する場合:

// 新しい部署を作成
let newDepartment = Department(context: viewContext)
newDepartment.name = "営業部"

// employee1の部署を変更
employee1.department = newDepartment

do {
    try viewContext.save()
    print("リレーションシップの更新に成功しました")
} catch {
    print("エラー: \(error)")
}

リレーションシップの削除

部署を削除すると、その部署に所属する社員のdepartmentリレーションシップはnilになります。

// departmentを削除
viewContext.delete(department)

do {
    try viewContext.save()
    print("部署の削除に成功しました")
} catch {
    print("エラー: \(error)")
}

リレーションシップの考慮点

リレーションシップの整合性: Core Dataはリレーションシップの整合性を自動的に管理しますが、削除ルール（Delete Rule）を適切に設定することが重要です。例えば、Nullify、Cascade、Denyなどのオプションがあります。

パフォーマンス: フェッチ要求でリレーションシップ先のデータを必要とする場合、@FetchRequest の prefetchRelationshipKeyPaths を使用してプリフェッチするとパフォーマンスが向上します。

削除ルールの設定

削除ルールは、エンティティ間のリレーションシップが削除されたときに、関連するオブジェクトに対してどのような操作を行うかを定義します。

Nullify（ヌル化）: 関連するオブジェクトのリレーションシップをnilにします。
Cascade（カスケード）: 関連するオブジェクトも一緒に削除します。
Deny（拒否）: リレーションシップが存在する場合、削除を拒否します。
データモデルエディタで、リレーションシップの詳細設定から削除ルールを選択できます。

多対多のリレーションシップの例

エンティティの設定

多対多のリレーションシップを設定するために、以下の2つのエンティティを作成します。

Student エンティティ
- 属性:
  - name (String)
- リレーションシップ:
  - courses (多対多, 先: Course, 双方向)
Course エンティティ
- 属性:
  - title (String)
- リレーションシップ:
  - students (多対多, 先: Student, 双方向)

データの作成とリレーションシップの設定

// コンテキストの取得
@Environment(\.managedObjectContext) private var viewContext

// Studentエンティティのインスタンスを作成
let student1 = Student(context: viewContext)
student1.name = "佐藤一郎"

let student2 = Student(context: viewContext)
student2.name = "鈴木花子"

// Courseエンティティのインスタンスを作成
let course1 = Course(context: viewContext)
course1.title = "数学"

let course2 = Course(context: viewContext)
course2.title = "英語"

// リレーションシップの設定
student1.addToCourses(course1)
student1.addToCourses(course2)

student2.addToCourses(course1)

// または、逆方向から設定
// course1.addToStudents(student1)
// course1.addToStudents(student2)
// course2.addToStudents(student1)

do {
    try viewContext.save()
    print("データとリレーションシップの保存に成功しました")
} catch {
    print("エラー: \(error)")
}

データの取得（多対多のリレーションシップを含む）

@FetchRequest(
    entity: Student.entity(),
    sortDescriptors: []
) private var students: FetchedResults<Student>

var body: some View {
    List {
        ForEach(students) { student in
            VStack(alignment: .leading) {
                Text("学生名: \(student.name ?? "不明")")
                if let courses = student.courses?.allObjects as? [Course] {
                    Text("登録科目: \(courses.map { $0.title ?? "" }.joined(separator: ", "))")
                }
            }
        }
    }
}

また、Course エンティティから学生を取得することもできます。

@FetchRequest(
    entity: Course.entity(),
    sortDescriptors: []
) private var courses: FetchedResults<Course>

var body: some View {
    List {
        ForEach(courses) { course in
            VStack(alignment: .leading) {
                Text("科目名: \(course.title ?? "不明")")
                if let students = course.students?.allObjects as? [Student] {
                    Text("登録学生: \(students.map { $0.name ?? "" }.joined(separator: ", "))")
                }
            }
        }
    }
}

リレーションシップの更新

// student1からcourse2を削除
student1.removeFromCourses(course2)

// 新しい科目を追加
let course3 = Course(context: viewContext)
course3.title = "科学"
student1.addToCourses(course3)

do {
    try viewContext.save()
    print("リレーションシップの更新に成功しました")
} catch {
    print("エラー: \(error)")
}

リレーションシップの削除

学生や科目を削除すると、そのリレーションシップも自動的に削除されます。

// student2を削除
viewContext.delete(student2)

do {
    try viewContext.save()
    print("学生の削除に成功しました")
} catch {
    print("エラー: \(error)")
}

パフォーマンスの考慮

@FetchRequestにおいて、リレーションシップ先のデータをプリフェッチすることでパフォーマンスを向上させることができます。

@FetchRequest(
    entity: Student.entity(),
    sortDescriptors: [],
    predicate: nil,
    animation: .default,
    fetchRequest: {
        let request = NSFetchRequest<Student>(entityName: "Student")
        request.relationshipKeyPathsForPrefetching = ["courses"]
        return request
    }()
) private var students: FetchedResults<Student>

まとめ

Core Dataを使用することで、アプリ内のデータ管理が効率化されます。一対多や多対多のリレーションシップを含む複雑なデータモデルでも、適切なエンティティとリレーションシップを設定し、CRUD操作を実装することで効率的に管理できます。削除ルールやパフォーマンスの考慮など詳細な設定にも注意を払い、公式ドキュメントや追加のリソースを参照してさらに深く学習してみてください。