ParseSwiftでBack4Appデータオブジェクト間の関係を確立する方法

関係 はじめに 関係は、データベースに保存されたデータオブジェクトを整理するための基本的な特徴です。 parseswift は、back4appデータベース内のクラス間の関係を確立するために必要なツールとメソッドを提供します。 使用ケースに応じて、以下のタイプの関係を特定できます。 1 1 2つのデータオブジェクトを接続する関係です。 1\ n 1つのデータオブジェクトと n n データオブジェクトの関係です。 n\ n データオブジェクト間の関係です。 n n データオブジェクトに対して n n データオブジェクトです。 以下で見るように、 1 1 関係の実装は比較的簡単です。 1\ n および n\ n 関係の実装には、 parserelation parserelation オブジェクトが必要です。これは、 parseswift sdk によって提供されます。 1\ n および n\ n 関係の実装には追加の代替手段があります。ただし、効率とパフォーマンスの観点から、私たちのアプローチに従うことをお勧めします。 このチュートリアルでは、xcode 12で作成された基本的なアプリを使用します。 ios 14 です。 いつでも、私たちのgithubリポジトリを通じて完全なプロジェクトにアクセスできます。 iosの例リポジトリ 目標 back4appデータベースでリレーションがどのように実装されているかを理解するため。 前提条件 このクイックスタートを完了するには、次のものが必要です： xcode。 back4appで作成されたアプリ。 「 新しいparseアプリのチュートリアル 」に従って、back4appでparseアプリを作成する方法を学びます。 注意： 「 parse sdk（swift）インストールチュートリアル 」に従って、back4appに接続されたxcodeプロジェクトを作成します。 私たちのbooksアプリを理解する プロジェクトテンプレートは、ユーザーが書籍の詳細を入力してback4appデータベースに保存するbookアプリです。アプリのホーム画面には、そのためのフォームがあります。 ナビゲーションバーの右上にある + + ボタンを使用して、必要に応じて多くの 出版社 , ジャンル , および 著者 を追加できます。ユーザーが書籍を入力すると、 書籍を追加 書籍を追加 ボタンを使用して、書籍をback4appデータベースに保存できます。さらに、 書籍を一覧表示 書籍を一覧表示 ボタンを使用すると、ユーザーが追加したすべての書籍を表示し、出版社や著者との関係を確認できます。 使用するコマンドのクイックリファレンス 私たちは次のオブジェクトを使用します 著者 著者 , 出版社 出版社 , isbn isbn と 本 本 genre 1 import foundation 2 import parseswift 3 4 struct genre parseobject { 5 6 7 var name string? 8 9 10 } author 1 import foundation 2 import parseswift 3 4 struct author parseobject { 5 6 7 var name string? 8 9 10 } publisher 1 import foundation 2 import parseswift 3 4 struct publisher parseobject { 5 6 7 var name string? 8 9 10 } isbn 1 import foundation 2 import parseswift 3 4 struct isbn parseobject { 5 6 7 var name string? 8 9 10 } book 1 import foundation 2 import parseswift 3 4 struct book parseobject { 5 6 7 var title string? 8 var publishingyear int? 9 var genre genre? 10 var isbn isbn? 11 12 13 } これらのオブジェクトのインスタンスをback4appデータベースに保存する前に、すべてのプロパティは codable codable と hashable hashable プロトコルに準拠する必要があります。 私たちは、back4appデータベース上でこれらのオブジェクトを管理するために、以下の方法を利用します create //when creating a new instance of author we use 1 var newauthor author = author(name "john doe") 2 3 // saves newauthor on your back4app database synchronously and returns the new saved item it throws and error if something went wrong 4 let savedauthor = try? newauthor save() 5 6 // saves newauthor on your back4app database asynchronously, and passes a result\<author, parseerror> object to the completion block to handle the save process 7 newauthor save { result in 8 // handle the result to check wether the save process was successfull or not 9 } read //for reading any of the objects introduced above, we construct the corresponding queries for each of them for author we have 1 let authorquery = author query() // a query to fetch all author items on your back4app database 2 3 // fetches the items synchronously or throws an error if found 4 let fetchedauthors = try? query find() 5 6 // fetches the items asynchronously and calls a completion block passing a result object containing the result of the operation 7 query find { result in 8 // handle the result 9 } add relations //in 1 1 relations, it is sufficient to have the child object as a property of the parent object back4app automatically saves the child object when the parent object is saved for the remaining relations, we use the add( objects ) method via the relation property available in the parent parseobject adding a relation called authors on a book object would look like this 1 let somebook book 2 let authors \[author] 3 4 // adds the relation between somebook and authors under the name 'authors' 5 let booktoauthorsrelation = try? somebook relation? add("authors", objects authors) 6 7 // saves the relation synchronously 8 let updatedsomebook = try? booktoauthorsrelation save() 9 10 // saves the relation asynchronously 11 booktoauthorsrelation save { result in 12 // handle the result 13 } query relations //for 1 1 relations, it is enough to append the include() method in the query for instance, to query all the books together with their isbn relation, we use 1 var query = book query() include("isbn") 2 3 // fetches all books synchronously 4 let books = try? query find() 5 6 // fetches all books asynchronously 7 query find { result in 8 // handle the result 9 } remaining relations //for the remaining relations, we create a query by using the static method queryrelation( ,parent ) provided by the parseobject protocol querying the authors related to a book can be implemented in the following way 1 let somebook book 2 let authors \[author] 3 4 5 // we create a relation (identified by the name 'authors') betwee somebook and a set of authors 6 let booktoauthorsrelation = 7 guard let booktoauthorsrelation = try somebook relation? add("authors", objects authors) // book > author 8 else { 9 fatalerror("failed to add relation") 10 } 11 12 let savedrelation = try booktoauthorsrelation save() // saves the relation synchronously 13 14 booktoauthorsrelation save { result in // saves the relation asynchronously 15 // handle the result 16 } 1 書籍アプリテンプレートをダウンロード この xcode xcode プロジェクトは以下の構造を持っています いつでも、私たちのgithubリポジトリを通じて完全なプロジェクトにアクセスできます。 iosのサンプルリポジトリ 2 追加のcrudフロー さらに進む前に、私たちが 著者 著者 , 出版社 出版社 と ジャンル ジャンル オブジェクトを保存できるようにするために、いくつかのcrud関数を実装する必要があります。 maincontroller+parseswift swift maincontroller+parseswift swift ファイルの中で、 maincontroller maincontroller クラスの拡張の下に、以下のメソッドを実装しました。 1 // maincontroller+parseswift swift file 2 extension maincontroller { 3 /// collects the data to save an instance of book on your back4app database 4 func savebook() { 5 view\ endediting(true) 6 7 // 1 first retrieve all the information for the book (title, isbn, etc) 8 guard let booktitle = booktitletextfield text else { 9 return presentalert(title "error", message "invalid book title") 10 } 11 12 guard let isbnvalue = isbntextfield text else { 13 return presentalert(title "error", message "invalid isbn value ") 14 } 15 16 let query = isbn query("value" == isbnvalue) 17 18 guard (try? query first()) == nil else { 19 return presentalert(title "error", message "the entered isbn already exists ") 20 } 21 22 guard let genreobjectid = genreoptionsview\ selectedoptionids first, 23 let genre = genres first(where { $0 objectid == genreobjectid}) 24 else { 25 return presentalert(title "error", message "invalid genre ") 26 } 27 28 guard let publishingyearstring = publishingyeartextfield text, let publishingyear = int(publishingyearstring) else { 29 return presentalert(title "error", message "invalid publishing year ") 30 } 31 32 let authors \[author] = self authoroptionsview\ selectedoptionids compactmap { \[weak self] objectid in 33 self? authors first(where { objectid == $0 objectid }) 34 } 35 36 let publishers \[publisher] = self publisheroptionsview\ selectedoptionids compactmap { \[weak self] objectid in 37 self? publishers first(where { objectid == $0 objectid }) 38 } 39 40 // since we are making multiple requests to back4app, it is better to use synchronous methods and dispatch them on the background queue 41 dispatchqueue global(qos background) async { 42 do { 43 let isbn = isbn(value isbnvalue) // 2 instantiate a new isbn object 44 45 let savedbook = try book( // 3 instantiate a new book object with the corresponding input fields 46 title booktitle, 47 publishingyear publishingyear, 48 genre genre, 49 isbn isbn 50 ) save() // 4 save the new book object 51 52 // here we will implement the relations 53 54 dispatchqueue main async { 55 self presentalert(title "success", message "book saved successfully ") 56 } 57 } catch { 58 dispatchqueue main async { 59 self presentalert(title "error", message "failed to save book \\((error as! parseerror) message)") 60 } 61 } 62 } 63 } 64 65 /// retrieves all the data saved under the genre class in your back4app database 66 func fetchgenres() { 67 let query = genre query() 68 69 query find { \[weak self] result in 70 switch result { 71 case success(let genres) 72 self? genres = genres // when setting self? genres, it triggers the corresponding ui update 73 case failure(let error) 74 self? presentalert(title "error", message error message) 75 } 76 } 77 } 78 79 /// presents a simple alert where the user can enter the name of a genre to save it on your back4app database 80 func handleaddgenre() { 81 // displays a form with a single input and executes the completion block when the user presses the submit button 82 presentform( 83 title "add genre", 84 description "enter a description for the genre", 85 placeholder nil 86 ) { \[weak self] name in 87 guard let name = name else { return } 88 let genre = genre(name name) 89 90 let query = genre query("name" == name) 91 92 guard ((try? query first()) == nil) else { 93 self? presentalert(title "error", message "this genre already exists ") 94 return 95 } 96 97 genre save { \[weak self] result in 98 switch result { 99 case success(let addedgenre) 100 self? presentalert(title "success", message "genre added!") 101 self? genres append(addedgenre) 102 case failure(let error) 103 self? presentalert(title "error", message "failed to save genre \\(error message)") 104 } 105 } 106 } 107 } 108 109 /// retrieves all the data saved under the publisher class in your back4app database 110 func fetchpublishers() { 111 let query = publisher query() 112 113 query find { \[weak self] result in 114 switch result { 115 case success(let publishers) 116 self? publishers = publishers 117 case failure(let error) 118 self? presentalert(title "error", message error message) 119 } 120 } 121 } 122 123 /// presents a simple alert where the user can enter the name of a publisher to save it on your back4app database 124 func handleaddpublisher() { 125 // displays a form with a single input and executes the completion block when the user presses the submit button 126 presentform( 127 title "add publisher", 128 description "enter the name of the publisher", 129 placeholder nil 130 ) { \[weak self] name in 131 guard let name = name else { return } 132 133 let query = publisher query("name" == name) 134 135 guard ((try? query first()) == nil) else { 136 self? presentalert(title "error", message "this publisher already exists ") 137 return 138 } 139 140 let publisher = publisher(name name) 141 142 publisher save { \[weak self] result in 143 switch result { 144 case success(let addedpublisher) 145 self? presentalert(title "success", message "publisher added!") 146 self? publishers append(addedpublisher) 147 case failure(let error) 148 self? presentalert(title "error", message "failed to save publisher \\(error message)") 149 } 150 } 151 } 152 } 153 154 /// retrieves all the data saved under the genre class in your back4app database 155 func fetchauthors() { 156 let query = author query() 157 158 query find { \[weak self] result in 159 switch result { 160 case success(let authors) 161 self? authors = authors 162 case failure(let error) 163 self? presentalert(title "error", message error message) 164 } 165 } 166 } 167 168 /// presents a simple alert where the user can enter the name of an author to save it on your back4app database 169 func handleaddauthor() { 170 // displays a form with a single input and executes the completion block when the user presses the submit button 171 presentform( 172 title "add author", 173 description "enter the name of the author", 174 placeholder nil 175 ) { \[weak self] name in 176 guard let name = name else { return } 177 178 let query = author query("name" == name) 179 180 guard ((try? query first()) == nil) else { 181 self? presentalert(title "error", message "this author already exists ") 182 return 183 } 184 185 let author = author(name name) 186 187 author save { \[weak self] result in 188 switch result { 189 case success(let addedauthor) 190 self? presentalert(title "success", message "author added!") 191 self? authors append(addedauthor) 192 case failure(let error) 193 self? presentalert(title "error", message "failed to save author \\(error message)") 194 } 195 } 196 } 197 } 198 }sw このステップの詳細については、 基本操作ガイド をご覧ください。 3 関係の設定 関係を作成する前に、互いに関連付けたいオブジェクトについてのアイデアを得るために、 クイックリファレンス https //www back4app com/docs/ios/parse swift sdk/data objects/relationships#quick reference セクションを見てください。以下の図では、これらのオブジェクトがどのように関連しているかを示しています。 ご覧の通り、関係は book book オブジェクトを中央に置くことで作成されます。矢印は、各オブジェクトがどのように book book オブジェクトに関連しているかを示しています。 4 関係の実装 1 1 ケース 1 1 関係を追加することは、 book book オブジェクトにプロパティを追加することで簡単に実現できます。つまり、 1 struct book parseobject { 2 3 4 var isbn isbn? // esablishes a 1 1 relation between book and isbn 5 6 7 } この場合、 本 本 と isbn isbn は 1 1 の関係を共有し、 本 本 が親として特定され、 isbn isbn が子として特定されます。内部的には、back4appが 本 本 のインスタンスを保存するとき、最初に isbn isbn オブジェクト（ isbn isbn クラス名の下）を保存します。このプロセスが完了した後、back4appは 本 本 オブジェクトに進みます。新しい 本 本 オブジェクトは、その isbn isbn プロパティが pointer\<isbn> pointer\<isbn> オブジェクトによって表されるように保存されます。 pointer<> pointer<> オブジェクトは、対応する親に関連する isbn isbn オブジェクトのユニークなインスタンスを保存することを可能にします。 1\ n ケース 「 1\ n 」関係を実装する最も効率的な方法は、 parserelation\<book> parserelation\<book> オブジェクトを介して行うことです。 parseswift は、「 parseobject parseobject 」プロトコルに準拠する任意のオブジェクトに対して、これらのタイプの関係を追加するためのメソッドのセットを提供します。たとえば、「 1\ n 1\ n 」関係を「 book book 」と「 author author 」の間で作成したい場合、次のようにします。 1 let somebook book 2 let authors \[author] 3 4 5 // we create a relation (identified by the name 'authors') between somebook and a set of authors 6 let booktoauthorsrelation = 7 guard let booktoauthorsrelation = try somebook relation? add("authors", objects authors) // book > author 8 else { 9 fatalerror("failed to add relation") 10 } 11 12 let savedrelation = try booktoauthorsrelation save() // saves the relation synchronously 13 14 booktoauthorsrelation save { result in // saves the relation asynchronously 15 // handle the result 16 } このスニペットを私たちが持っている他の関係に適応させるのは簡単です 本 本 \ すべてをまとめる 関係を実装する基本的なアイデアを確立したので、次に savebook() savebook() メソッドを完成させます。このプロセス中に考慮すべき重要なポイントを列挙します 1 extension maincontroller { 2 /// collects the data to save an instance of book on your back4app database 3 func savebook() { 4 5 // 1 first retrieve all the information for the book (booktitle, isbnvalue, etc) 6 7 8 // since we are making multiple requests to back4app, it is better to use synchronous methods and dispatch them on the background queue 9 dispatchqueue global(qos background) async { 10 do { 11 let isbn = isbn(value isbnvalue) // 2 instantiate a new isbn object 12 13 let savedbook = try book( // 3 instantiate a new book object with the corresponding input fields 14 title booktitle, 15 publishingyear publishingyear, 16 genre genre, 17 isbn isbn 18 ) save() // 4 save the new book object 19 20 // 5 add the corresponding relations for new book object 21 guard let booktoauthorsrelation = try savedbook relation? add("authors", objects authors), // book > author 22 let bootktopublishersrelation = try savedbook relation? add("publishers", objects publishers), // book > publisher 23 let genrerelation = try genre relation? add("books", objects \[savedbook]) // genre > book 24 else { 25 return dispatchqueue main async { 26 self presentalert(title "error", message "failed to add relations") 27 } 28 } 29 30 // 6 save the relations 31 = try booktoauthorsrelation save() 32 = try bootktopublishersrelation save() 33 = try genrerelation save() 34 35 dispatchqueue main async { 36 self presentalert(title "success", message "book saved successfully ") 37 } 38 } catch { 39 dispatchqueue main async { 40 self presentalert(title "error", message "failed to save book \\((error as! parseerror) message)") 41 } 42 } 43 } 44 } 45 46 47 } 5 関係のクエリ 親 1 1 関係において、親 book book とその子 isbn isbn , 対応する子を book book クエリに含めることでクエリします。 1 let query = book query() include("isbn") 2 3 let books = try query find() // retrieves synchronously all the books together with its isbn 4 5 query find { result in // retrieves asynchronously all the books together with its isbn 6 // handle the result 7 } 8 これにより、すべての本は query に関連する isbn プロパティが適切に設定され、関連する isbn オブジェクトを持つことになります。 一方、 1\ n 関係を持つオブジェクトを取得するために、 parseobject プロトコルは静的メソッド queryrelation( ,parent ) を提供します。このメソッドは、関係の名前（最初のパラメータとして）と親を提供することで、必要なクエリを作成することを可能にします。たとえば、特定の book に関連するすべての author を取得するには、次のスニペットを使用できます。 1 let book book // book from which we are trying to retrieve its related authors 2 3 do { 4 let authorsquery = try author queryrelations("authors", parent book) // 'authors' is the name of the relation it was saved with 5 6 authorsquery find { \[weak self] result in 7 switch result { 8 case success(let authors) 9 self? authors = authors 10 11 dispatchqueue main async { 12 // update the ui 13 } 14 case failure(let error) 15 dispatchqueue main async { 16 self? presentalert(title "error", message "failed to retrieve authors \\(error message)") 17 } 18 } 19 } 20 } 21 } catch { 22 if let error = error as? parseerror { 23 presentalert(title "error", message "failed to retrieve authors \\(error message)") 24 } else { 25 presentalert(title "error", message "failed to retrieve authors \\(error localizeddescription)") 26 } 27 } 同様に、私たちは publisher のような他の関連オブジェクトをクエリできます。 「 bookdetailscontroller swift 」ファイルでは、書籍が著者や出版社と持つ関係を表示するためにこれらのクエリを実装します。 1 // bookdetailscontroller swift file 2 class bookdetailscontroller uitableviewcontroller { 3 4 5 /// retrieves the book's details, i e , its relation with authors and publishers 6 private func fetchdetails() { 7 do { 8 // constructs the relations you want to query 9 let publishersquery = try publisher queryrelations("publishers", parent book) 10 let authorsquery = try author queryrelations("authors", parent book) 11 12 // obtains the publishers related to book and display them on the tableview, it presents an error if happened 13 publishersquery find { \[weak self] result in 14 switch result { 15 case success(let publishers) 16 self? publishers = publishers 17 18 // update the ui 19 dispatchqueue main async { 20 self? tableview\ reloadsections(indexset(\[section publisher rawvalue]), with none) 21 } 22 case failure(let error) 23 dispatchqueue main async { 24 self? presentalert(title "error", message "failed to retrieve publishers \\(error message)") 25 } 26 } 27 } 28 29 // obtains the authors related to book and display them on the tableview, it presents an error if happened 30 authorsquery find { \[weak self] result in 31 switch result { 32 case success(let authors) 33 self? authors = authors 34 35 // update the ui 36 dispatchqueue main async { 37 self? tableview\ reloadsections(indexset(\[section author rawvalue]), with none) 38 } 39 case failure(let error) 40 dispatchqueue main async { 41 self? presentalert(title "error", message "failed to retrieve authors \\(error message)") 42 } 43 } 44 } 45 } catch { // if there was an error during the creation of the queries, this block should catch it 46 if let error = error as? parseerror { 47 presentalert(title "error", message "failed to retrieve authors \\(error message)") 48 } else { 49 presentalert(title "error", message "failed to retrieve authors \\(error localizeddescription)") 50 } 51 } 52 } 53 54 55 } 6 アプリを実行！ 「 xcode xcode 」の実行ボタンを押す前に、 back4app back4app アプリケーションを appdelegate appdelegate クラスで設定するのを忘れないでください! 新しい本を追加する前に、いくつかの ジャンル 、 出版社 、および 著者 を追加する必要があります。その後、本の情報を入力して、back4appデータベースに保存できます。一冊の本を保存したら、 back4appダッシュボード https //parse dashboard back4app com/apps を開き、「 xcode 」プロジェクトにリンクされたアプリケーションに移動します。データベースセクションでは、 book book クラスを見つけることができ、そこには ios ios アプリによって作成されたすべての本が保存されています。 さらに、back4appは自動的に isbn isbn クラスを作成し、対応する book book オブジェクトと関連付けています。「 book book 」クラスに戻ると、各関係のデータ型を特定できます。「 isbn isbn 」と「 ジャンル ジャンル 」の場合、データ型は「 pointer<> pointer<> 」です。一方、「 著者 著者 」や「 出版社 出版社 」のような関係の場合、データ型は「 relation<> relation<> 」です。これは、関係を構築する際に考慮すべき重要な違いです。