[Swift/SwiftUI]Realmでデータベースの実装（データ取得・登録）

概要

データベースを使用するならサーバーと連携すればいい。
しかし、サーバーをせずともデータベースを使用したい時はある。

サーバー環境がない
サーバーとやりとりするほど大きな規模では作りたくない
端末にデータを保存したい

そんなときはSwiftで使えるデータベースのライブラリを使おう。
CocoaPodsを導入するので、その点はこちらを確認。

ソースコード

import SwiftUI

@main
struct TestApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate
    
    var body: some Scene {
        WindowGroup {
            DatabaseListView()
        }
    }
}

View関連

simport SwiftUI

struct DatabaseListView: View {
    @ObservedObject var viewModel: DatabaseListViewModel = DatabaseListViewModel()
    
    @State var inputText: String = ""
    
    var body: some View {
        VStack {
            Spacer()
            HStack {
                Spacer()
                TextField("", text: self.$inputText)
                    .textFieldStyle(.roundedBorder)
                Spacer()
                Button {
                    self.viewModel.registerData(inputText: self.inputText)
                    self.inputText = ""
                } label: {
                    Text("登録")
                }
                Spacer()
            }
            Spacer()
            List {
                ForEach(self.viewModel.data, id: \.self) { data in
                    VStack(alignment: .leading) {
                        Text("ID: \(data.id)")
                        Text("入力文字: \(data.title)")
                        Text("登録日: \(data.registerDate.transeJapaneseDateString())")
                        Text("更新日: \(data.updateDate.transeJapaneseDateString())")
                    }
                }
            }
        }
        .alert(isPresented: self.$viewModel.isShownDialog) {
            Alert(title: Text("Error"),
                  message: Text("登録に失敗しました"),
                  dismissButton: .default(Text("閉じる")))
        }
    }
}

処理部分

import Foundation
import RealmSwift

class DatabaseListViewModel: ObservableObject {
    @Published var isShownDialog: Bool = false
    @Published var data: [DatabaseTableData]
    
    init() {
        self.data = DatabaseManager.shared.getInstance()
    }
    
    func registerData(inputText: String) {
        let data = DatabaseTableData(id: self.data.count + 1,
                                     title: inputText,
                                     registerDate: Date(),
                                     updateDate: Date())
        DatabaseManager.shared.registerFavoriteSetting(data: data)
        self.data = DatabaseManager.shared.getInstance()
    }
}

日付表示部分のExtension

import Foundation

extension Date {
    func transeJapaneseDateString() -> String {
        let format = Date.FormatStyle().locale(Locale(identifier: "ja_JP"))
                    .year()
                    .month(.twoDigits)
                    .day(.twoDigits)
                    .weekday(.abbreviated)
                    .hour(.twoDigits(amPM: .wide))
                    .minute(.twoDigits)
                    .second(.twoDigits)
        return format.format(self)
    }
}

DB処理部分

データベースの項目クラス（テーブルのカラム設定のようなもの）

import Foundation
import RealmSwift

class DatabaseTableData: Object {
    @objc dynamic var id: Int
    @objc dynamic var title: String
    @objc dynamic var registerDate: Date
    @objc dynamic var updateDate: Date
    
    override init() {
        self.id = 0
        self.title = ""
        self.registerDate = Date()
        self.updateDate = Date()
    }
    
    init(id: Int, title: String, registerDate: Date, updateDate: Date) {
        self.id = id
        self.title = title
        self.registerDate = registerDate
        self.updateDate = updateDate
    }
}

DBのデータ取得や登録処理

import Foundation
import RealmSwift

class DatabaseManager {
    static let shared = DatabaseManager()
    var realm: Realm? = nil
    
    private init() {
        
    }
    
    func getInstance() -> [DatabaseTableData] {
        do {
            self.realm = try? Realm()
        }
        guard let objects = self.realm?.objects(DatabaseTableData.self) else {
            return []
        }
        return Array(objects)
    }
    
    func registerFavoriteSetting(data: DatabaseTableData) {
        do {
            self.realm = try? Realm()
            try? self.realm?.write {
                self.realm?.add(data)
            }
        }
    }
    
    func deleteFariteSetting(data: DatabaseTableData) {
        do {
            self.realm = try? Realm()
            try? self.realm?.write {
                self.realm?.delete(data)
            }
        }
    }
}

デモ動画

詳細

実装の方法

今回はライブラリ「RealmSwift」を使用している。
そのため、データベースに関する実装を行うときは以下のようにRealmSwiftをコードに取り込む。

import RealmSwift

また、今回のようにデータベースはアプリ内のいろんなクラスから呼び出されるが、
インスタンスはただ一つにしたいため、シングルトンクラスを使用している。（sharedを使って行うやつ。今回はDatabaseManagerクラス）
そして、そのクラスに処理をまとめることで同じようなメソッドをする必要がないようにしている。

データを取得したときの型をViewで使用しやすいようにする

また、通常、Realmクラスのobjectsメソッドで返されるオブジェクトの型はResults<[Objectを継承したクラス名]>になるが、今回は以下のようにすることで配列型にしている。
こうすることでViewクラスでも使用がしやすいようにしている。

// getInstance()メソッドの一部を抜粋
guard let objects = self.realm?.objects(DatabaseTableData.self) else {
    return []
}
return Array(objects) // ここで配列型にしている

データ登録処理

データを登録するときはRealmクラスのwriteメソッド内でaddメソッドを呼ぶ。
dataの型はResults<[Objectを継承したクラス名]>を使用する。

do {
    self.realm = try? Realm()
    try? self.realm?.write {
        self.realm?.add(data)
    }
}

参考ページ：
プログラミングガール RealmのResults型をArrayに変換する

目次

概要