Implémentation de relations avec Parse Swift SDK sur iOS

relations introduction les relations sont une caractéristique fondamentale pour organiser les objets de données stockés dans une base de données parseswift fournit les outils et méthodes nécessaires pour établir des relations entre les classes dans votre base de données back4app en fonction du cas d'utilisation, nous pouvons identifier les types de relations suivants 1 1 une relation qui ne connecte que deux objets de données 1\ n une relation entre un objet de données et n n objets de données n\ n une relation entre n n objets de données à n n objets de données comme nous le verrons ci dessous, la mise en œuvre des relations 1 1 est relativement simple pour les relations 1\ n et n\ n , la mise en œuvre implique l'objet parserelation parserelation fourni par le parseswift sdk il existe des alternatives supplémentaires pour mettre en œuvre les relations 1\ n et n\ n cependant, en raison de l'efficacité et des performances, nous recommandons de suivre notre approche ce tutoriel utilise une application de base créée dans xcode 12 et ios 14 à tout moment, vous pouvez accéder au projet complet via nos dépôts github dépôt d'exemple ios objectif comprendre comment les relations sont mises en œuvre dans une base de données back4app prérequis pour compléter ce guide rapide, vous avez besoin de xcode une application créée sur back4app suivez le tutoriel sur la nouvelle application parse pour apprendre à créer une application parse sur back4app remarque suivez le tutoriel d'installation du sdk parse (swift) pour créer un projet xcode connecté à back4app comprendre notre application de livres le modèle de projet est une application de livres où l'utilisateur saisit les détails d'un livre pour l'enregistrer dans une base de données back4app sur l'écran d'accueil de l'application, vous trouverez le formulaire pour le faire en utilisant le + + bouton situé en haut à droite de la barre de navigation, nous pouvons ajouter autant de éditeurs , genres et auteurs que nécessaire une fois que l'utilisateur a saisi un livre, il peut utiliser le ajouter un livre ajouter un livre bouton pour enregistrer le livre dans sa base de données back4app de plus, le lister les livres lister les livres bouton nous permettra d'afficher tous les livres que l'utilisateur a ajoutés et également de voir leur relation avec les éditeurs et les auteurs référence rapide des commandes que nous allons utiliser nous utilisons les objets auteur auteur , éditeur éditeur , isbn isbn et livre livre 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 } avant de stocker des instances de ces objets dans une base de données back4app, toutes leurs propriétés doivent se conformer aux codable codable et hashable hashable protocoles nous utilisons les méthodes suivantes pour gérer ces objets sur la base de données 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 téléchargez le modèle de l'application books le xcode xcode projet a la structure suivante à tout moment, vous pouvez accéder au projet complet via nos dépôts github dépôt d'exemple ios 2 flux crud supplémentaire avant d'aller plus loin, il est nécessaire d'implémenter quelques fonctions crud pour pouvoir sauvegarder les auteurs auteurs , éditeurs éditeurs et genres genres objets dans le maincontroller+parseswift swift maincontroller+parseswift swift fichier, sous une extension pour la maincontroller maincontroller classe, nous avons implémenté les méthodes suivantes 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 pour plus de détails sur cette étape, vous pouvez consulter le guide des opérations de base 3 configurer les relations avant de commencer à créer des relations, jetez un œil à la référence rapide https //www back4app com/docs/ios/parse swift sdk/data objects/relationships#quick reference section pour avoir une idée des objets que nous voulons relier entre eux dans la figure ci dessous, nous montrons comment ces objets sont liés comme on peut le voir, les relations sont créées en plaçant l'objet livre livre au milieu les flèches montrent comment chaque objet est lié à un livre livre 4 mise en œuvre des relations cas 1 1 ajouter des relations 1 1 peut être facilement réalisé en ajoutant une propriété dans l'objet livre livre , c'est à dire, 1 struct book parseobject { 2 3 4 var isbn isbn? // esablishes a 1 1 relation between book and isbn 5 6 7 } dans ce cas, livre livre et isbn isbn partagent une relation 1 1 où livre livre est identifié comme le parent et isbn isbn comme l'enfant en interne, lorsque back4app enregistre une instance de livre livre , il enregistre d'abord l'objet isbn isbn (sous le nom de classe isbn isbn ) une fois ce processus terminé, back4app continue avec l'objet livre livre le nouvel objet livre livre est enregistré de manière à ce que sa isbn isbn soit représentée par un pointer\<isbn> pointer\<isbn> objet un pointer<> pointer<> permet de stocker une instance unique de l'objet isbn isbn liée à son parent correspondant cas 1\ n pour 1\ n relations, la manière la plus efficace de les implémenter est via un parserelation\<book> parserelation\<book> objet parseswift fournit un ensemble de méthodes pour ajouter ces types de relations pour tout objet conforme au parseobject parseobject protocole par exemple, si nous voulons créer une 1\ n 1\ n relation entre book book et author author nous pouvons utiliser 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 } il est simple d'adapter ce extrait pour les autres relations que nous avons pour livre livre \ mettre le tout ensemble une fois que nous avons établi l'idée de base pour implémenter les relations, nous complétons maintenant le savebook() savebook() méthode nous énumérons les points clés à garder à l'esprit pendant ce processus 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 interroger les relations pour 1 1 relations, étant donné le parent book book et son enfant isbn isbn , nous interrogeons l'enfant correspondant en l'incluant dans la book book requête 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 avec cela, tous les livres de la query auront également la isbn propriété correctement définie avec l'objet isbn associé d'autre part, afin de récupérer des objets avec une 1\ n relation, le parseobject protocole fournit la méthode statique queryrelation( ,parent ) en fournissant le nom de la relation (comme premier paramètre) et le parent, cette méthode nous permet de créer la requête requise par exemple, pour récupérer tous les author liés à un book spécifique, nous pouvons utiliser le snippet suivant 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 } de même, nous pouvons interroger d'autres objets connexes tels que publisher dans le bookdetailscontroller swift fichier, nous implémentons ces requêtes pour afficher la relation qu'un livre a avec les auteurs et les éditeurs 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 exécutez l'application ! avant d'appuyer sur le bouton exécuter sur xcode xcode , n'oubliez pas de configurer votre back4app back4app application dans la appdelegate appdelegate classe! vous devez ajouter quelques genre ’s, publisher ’s et author ’s avant d'ajouter un nouveau livre ensuite, vous pouvez commencer à entrer les informations d'un livre pour les enregistrer dans votre base de données back4app une fois que vous avez enregistré un livre, ouvrez votre tableau de bord back4app https //parse dashboard back4app com/apps et allez à votre application liée au xcode projet dans la section base de données, vous trouverez la classe book book où tous les livres créés par l' ios ios app sont stockés de plus, vous pouvez voir que back4app a automatiquement créé la classe isbn isbn afin de la relier à son book book correspondant si vous revenez à la classe book book , vous pouvez identifier les types de données pour chaque type de relation dans le cas de isbn isbn et genre genre , le type de données est un pointer<> pointer<> d'autre part, pour des relations comme author author et publisher publisher , le type de données est relation<> relation<> c'est une différence clé à garder à l'esprit lors de la construction des relations