Gerenciamento de Tipos de Dados no ParseSwift com Back4App

analisar tipos de dados no swift introdução ao salvar dados em um banco de dados back4app, cada entidade é armazenada em um formato de par chave valor o tipo de dado para o campo de valor vai dos fundamentais (como string , int , double , float , e bool ) para estruturas mais complexas o principal requisito para armazenar dados em um banco de dados back4app é que a entidade deve conformar se ao parseswift protocolo por sua vez, este protocolo fornece um conjunto de métodos para armazenar, atualizar e excluir qualquer instância de uma entidade neste guia, você aprenderá como criar e configurar uma entidade para salvá la em seu banco de dados back4app no exemplo do projeto, a entidade que estamos armazenando contém informações sobre uma receita este tutorial usa um aplicativo básico criado no xcode 12 e ios 14 a qualquer momento, você pode acessar o projeto completo através de nossos repositórios no github repositório de exemplo ios objetivo para entender como os objetos são analisados e armazenados em um banco de dados back4app pré requisitos para completar este guia rápido, você precisa xcode um aplicativo criado no back4app siga o tutorial de novo aplicativo parse para aprender como criar um aplicativo parse no back4app nota siga o tutorial de instalação do parse sdk (swift) para criar um projeto xcode conectado ao back4app compreendendo nosso aplicativo de receitas a funcionalidade do aplicativo é baseada em um formulário onde se pode inserir informações sobre uma receita dependendo das informações, o tipo de dado pode variar no nosso exemplo, a receita possui as seguintes características campo tipo de dados descrição nome string nome da receita porções int número de porções disponível bool determina se a receita está disponível ou não categoria categoria uma enumeração personalizada que classifica uma receita em três categorias café da manhã, almoço e jantar ingredientes \[ingredientes] o conjunto de ingredientes contidos em uma struct customingredient opções laterais \[string] nomes das opções adicionais que a receita vem acompanhada informação nutricional \[string\ string] um dicionário contendo informações sobre o conteúdo nutricional da receita data de lançamento data uma data mostrando quando a receita estava disponível além disso, existem mais tipos de dados que são usados para implementar a funcionalidade do banco de dados, como a relação entre objetos esses tipos de dados não são abordados neste tutorial referência rápida dos comandos que vamos usar dado um objeto, digamos receita, se você quiser salvá lo em um banco de dados back4app, primeiro deve fazer com que este objeto esteja em conformidade com o protocolo parseswift (disponível via o sdk parseswift) 1 import foundation 2 import parseswift 3 4 struct recipe parseobject { 5 /// enumeration for the recipe category 6 enum category int, caseiterable, codable { 7 case breakfast = 0, lunch = 1, dinner = 2 8 9 var title string { 10 switch self { 11 case breakfast return "breakfast" 12 case lunch return "lunch" 13 case dinner return "dinner" 14 } 15 } 16 } 17 18 19 20 /// a string type property 21 var name string? 22 23 /// an integer type property 24 var servings int? 25 26 /// a double (or float ) type property 27 var price double? 28 29 /// a boolean type property 30 var isavailable bool? 31 32 /// an enumeration type property 33 var category category? 34 35 /// an array of structs 36 var ingredients \[ingredient] 37 38 /// an array of strings 39 var sideoptions \[string] 40 41 /// a dictionary property 42 var nutritionalinfo \[string string] 43 44 /// a date type property 45 var releasedate date? 46 } antes de armazenar instâncias deste objeto em um banco de dados back4app, todas as suas propriedades devem estar em conformidade com os protocolos codable e hashable utilizamos os seguintes métodos para gerenciar esses objetos no banco de dados back4app create //the procedure for reading and updating a recipe object is similar since they rely on the save() method how a recipe is instantiated determines if we are creating or updating the object on the back4app database when creating a new instance we use 1 var newrecipe recipe 2 3 // setup newrecipe's properties 4 newrecipe name = "my recipe's name" 5 newrecipe servings = 4 6 newrecipe price = 3 99 7 newrecipe isavailable = false 8 newrecipe category = breakfast 9 newrecipe sideoptions = \["juice"] 10 newrecipe releasedate = date() 11 12 13 // saves newrecipe on your back4app database synchronously and returns the new saved item it throws and error if something went wrong 14 let savedrecipe = try? savedrecipe save() 15 16 // saves savedrecipe on your back4app database asynchronously, and passes a result\<todolistitem, parseerror> object to the completion block to handle the save proccess 17 savedrecipe save { result in 18 // handle the result to check the save was successfull or not 19 } update //and to update an existing instance, we have to provide the objectid value which identifies the the object on the back4app database a satandard update can be implemented in the following way 1 let recipetoupdate = recipe(objectid "object id") 2 3 // update the properties you need 4 recipetoupdate name = "my updated recipe's name" 5 recipetoupdate servings = 5 6 recipetoupdate price = 5 99 7 recipetoupdate isavailable = true 8 recipetoupdate category = lunch 9 recipetoupdate sideoptions = \["juice", "coffee"] 10 recipetoupdate releasedate = date() addingtimeinterval(3600 24) 11 12 13 // save changes synchronousty 14 try? recipetoupdate save() 15 16 // or save changes asynchronously 17 recipetoupdate save { result in 18 // handle the result 19 } read //for reading objects stored on your back4app database, recipe now provides the query() static method which returns a query\<recipe> this query object can be constructed using one or more queryconstraint objects in the following way 1 let query = recipe query() // a query to fetch all recipe items on your back4app database 2 let query = recipe query("name" == "omelette") // a query to fetch all recipe items with name "omelette" on your back4app database 3 let query = recipe query(\["name" == "omelette", "price" = 9 99]) // a query to fetch all recipe items with name = "omelette" and price = 9 99 4 5 // fetches the items synchronously or throws an error if found 6 let fetchedrecipes = try? query find() 7 8 // fetches the items asynchronously and calls a completion block passing a result object containing the result of the operation 9 query find { result in 10 // handle the result 11 } delete //any deletion process is performed by calling the method delete() on the object to be deleted 1 var recipetodelete recipe 2 3 // delete recipetodelete synchronously 4 try? recipetodelete delete() 5 6 // delete recipetodelete asynchronously 7 recipetodelete delete { result in 8 // handle the result 9 } 1 criar o modelo do app de receita começamos criando um novo projeto xcode este tutorial deve parecer assim a qualquer momento, você pode acessar o projeto completo através de nossos repositórios no github repositório de exemplo para ios vá para o xcode e encontre o arquivo scenedelegate swift para adicionar uma barra de navegação no topo do aplicativo, configuramos um uinavigationcontroller como o controlador de visualização raiz da seguinte maneira 1 class scenedelegate uiresponder, uiwindowscenedelegate { 2 3 var window uiwindow? 4 5 func scene( scene uiscene, willconnectto session uiscenesession, options connectionoptions uiscene connectionoptions) { 6 guard let scene = (scene as? uiwindowscene) else { return } 7 8 window = init(windowscene scene) 9 window? rootviewcontroller = uinavigationcontroller(rootviewcontroller recipescontroller()) 10 window? makekeyandvisible() 11 12 // additional logic 13 } 14 15 16 } a classe do controlador de visualização raiz (recipescontroller) para o controlador de navegação é uma subclasse de uiviewcontroller na qual iremos dispor um formulário para criar e atualizar objetos de receita no banco de dados back4app 2 configurar o objeto receita os objetos que você deseja salvar no seu banco de dados back4app devem conformar se ao protocolo parseobject no nosso aplicativo de receitas, este objeto é receita portanto, você primeiro precisa criar este objeto crie um novo arquivo recipe swift e adicione o seguinte 1 import foundation 2 import parseswift 3 4 struct recipe parseobject { 5 /// enumeration for the recipe category 6 enum category int, caseiterable, codable { 7 case breakfast = 0, lunch = 1, dinner = 2 8 9 var title string { 10 switch self { 11 case breakfast return "breakfast" 12 case lunch return "lunch" 13 case dinner return "dinner" 14 } 15 } 16 } 17 18 // required properties from parseobject protocol 19 var objectid string? 20 var createdat date? 21 var updatedat date? 22 var acl parseacl? 23 24 /// a string type property 25 var name string? 26 27 /// an integer type property 28 var servings int? 29 30 /// a double (or float ) type property 31 var price double? 32 33 /// a boolean type property 34 var isavailable bool? 35 36 /// an enumeration type property 37 var category category? 38 39 /// an array of structs 40 var ingredients \[ingredient] 41 42 /// an array of strings 43 var sideoptions \[string] 44 45 /// a dictionary property 46 var nutritionalinfo \[string string] 47 48 /// a date type property 49 var releasedate date? 50 51 /// maps the nutritionalinfo property into an array of tuples 52 func nutritionalinfoarray() > \[(name string, value string)] { 53 return nutritionalinfo map { ($0 key, $0 value) } 54 } 55 } onde já adicionamos todas as propriedades necessárias à receita de acordo com a tabela de características das receitas o tipo de dado ingredient é uma estrutura que contém a quantidade e a descrição do ingrediente como mencionado anteriormente, esse tipo de dado deve conformar os protocolos codable e hashable para fazer parte das propriedades da receita 1 import foundation 2 3 struct ingredient hashable, codable { 4 var quantity float 5 var description string 6 } além disso, a propriedade category em recipe tem uma enumeração (category) como tipo de dado que também conforma os protocolos correspondentes 1 struct recipe parseobject { 2 /// enumeration for the recipe category 3 enum category int, caseiterable, codable { 4 case breakfast = 0, lunch = 1, dinner = 2 5 6 7 } 8 9 } 3 configurando o recipescontroller no recipescontroller, devemos implementar toda a configuração necessária para a navigationbar e o formulário usado para capturar todas as propriedades da receita este tutorial não cobre como implementar o layout para o formulário então, focamos na lógica relacionada à gestão de tipos de dados usando o parseswift sdk abaixo, destacamos os pontos chave no recipescontroller que nos permitem entender como implementamos a conexão entre a interface do usuário e os dados provenientes do seu banco de dados back4app 1 class recipescontroller uiviewcontroller { 2 enum previousnext int { case previous = 0, next = 1 } 3 4 5 6 var recipes \[recipe] = \[] // 1 an array of recipes fetched from your back4app database 7 8 // section header labels 9 private let recipelabel uilabel = titlelabel(title "recipe overview") 10 private let ingredientslabel uilabel = titlelabel(title "ingredients") 11 private let nutritionalinfolabel uilabel = titlelabel(title "nutritional information") 12 13 // 2 a custom view containing input fields to enter the recipe's information (except nutritional info and ingredients) 14 let recipeoverviewview recipeinfoview 15 16 // 3 a stack view containig the fields to enter the recipe's ingredients 17 let ingredientsstackview uistackview 18 19 // 4 a stack view containig the fields to enter the nutritional information 20 let nutritionalinfostackview uistackview 21 22 // 5 buttons to handle the crud logic for the recipe object currently displayed 23 private var savebutton uibutton = uibutton(title "save") 24 private var updatebutton uibutton = uibutton(title "update") 25 private var reloadbutton uibutton = uibutton(title "reload") 26 27 var currentrecipeindex int? // 6 an integer containing the index of the current recipe presenten from the recipes property 28 29 override func viewdidload() { 30 super viewdidload() 31 setupnavigationbar() 32 setupviews() 33 } 34 35 override func viewdidappear( animated bool) { 36 super viewdidappear(animated) 37 handlereloadrecipes() 38 } 39 40 private func setupnavigationbar() { 41 navigationcontroller? navigationbar bartintcolor = primary 42 navigationcontroller? navigationbar titletextattributes = \[ foregroundcolor uicolor white] 43 navigationcontroller? navigationbar istranslucent = false 44 navigationcontroller? navigationbar barstyle = black 45 navigationitem title = "parse data types" uppercased() 46 } 47 48 private func setupviews() { 49 // see the project example for more details 50 51 savebutton addtarget(self, action #selector(handlesaverecipe), for touchupinside) 52 updatebutton addtarget(self, action #selector(handleupdaterecipe), for touchupinside) 53 reloadbutton addtarget(self, action #selector(handlereloadrecipes), for touchupinside) 54 } 55 56 57 } 3 lidando com a entrada do usuário e analisando um objeto receita em um arquivo separado (chamado recipescontroller+parseswiftlogic swift), usando uma extensão agora implementamos os métodos handlesaverecipe(), handleupdaterecipe() e handleupdaterecipe() para lidar com os dados de entrada 1 import uikit 2 import parseswift 3 4 extension recipescontroller { 5 /// retrieves all the recipes stored on your back4app database 6 @objc func handlereloadrecipes() { 7 view\ endediting(true) 8 let query = recipe query() 9 query find { \[weak self] result in // retrieves all the recipes stored on your back4app database and refreshes the ui acordingly 10 guard let self = self else { return } 11 switch result { 12 case success(let recipes) 13 self recipes = recipes 14 self currentrecipeindex = recipes isempty ? nil 0 15 self setuprecipenavigation() 16 17 dispatchqueue main async { self presentcurrentrecipe() } 18 case failure(let error) 19 dispatchqueue main async { self showalert(title "error", message error message) } 20 } 21 } 22 } 23 24 /// called when the user wants to update the information of the currently displayed recipe 25 @objc func handleupdaterecipe() { 26 view\ endediting(true) 27 guard let recipe = preparerecipemetadata(), recipe objectid != nil else { // prepares the recipe object for updating 28 return showalert(title "error", message "recipe not found ") 29 } 30 31 recipe save { \[weak self] result in 32 switch result { 33 case success(let newrecipe) 34 self? recipes append(newrecipe) 35 self? showalert(title "success", message "recipe saved on your back4app database! (objectid \\(newrecipe id)") 36 case failure(let error) 37 self? showalert(title "error", message "failedto save recipe \\(error message)") 38 } 39 } 40 } 41 42 /// saves the currently displayed recipe on your back4app database 43 @objc func handlesaverecipe() { 44 view\ endediting(true) 45 guard var recipe = preparerecipemetadata() else { // prepares the recipe object for storing 46 return showalert(title "error", message "failed to retrieve all the recipe fields ") 47 } 48 49 recipe objectid = nil // when saving a recipe object, we ensure it will be a new instance of it 50 recipe save { \[weak self] result in 51 switch result { 52 case success(let newrecipe) 53 if let index = self? currentrecipeindex { self? recipes\[index] = newrecipe } 54 self? showalert(title "success", message "recipe saved on your back4app database! (objectid \\(newrecipe id))") 55 case failure(let error) 56 self? showalert(title "error", message "failed to save recipe \\(error message)") 57 } 58 } 59 } 60 61 /// when called it refreshes the ui according to the content of recipes and currentrecipeindex properties 62 private func presentcurrentrecipe() { 63 64 } 65 66 /// adds the 'next recipe' and 'previous recipe' button on the navigation bar these are used to iterate over all the recipes retreived from your back4app database 67 private func setuprecipenavigation() { 68 69 } 70 71 /// reads the information the user entered via the form and returns it as a recipe object 72 private func preparerecipemetadata() > recipe? { 73 let ingredientscount = ingredientsstackview\ arrangedsubviews count 74 let nutritionalinfocount = nutritionalinfostackview\ arrangedsubviews count 75 76 let ingredients \[ingredient] = (0 \<ingredientscount) compactmap { row in 77 guard let textfields = ingredientsstackview\ arrangedsubviews\[row] as? doubletextfield, 78 let quantitystring = textfields primarytext, 79 let quantity = float(quantitystring), 80 let description = textfields secondarytext 81 else { 82 return nil 83 } 84 return ingredient(quantity quantity, description description) 85 } 86 87 var nutritionalinfo \[string string] = \[ ] 88 89 (0 \<nutritionalinfocount) foreach { row in 90 guard let textfields = nutritionalinfostackview\ arrangedsubviews\[row] as? doubletextfield, 91 let content = textfields primarytext, !content isempty, 92 let value = textfields secondarytext, !value isempty 93 else { 94 return 95 } 96 nutritionalinfo\[content] = value 97 } 98 99 let recipeinfo = recipeoverviewview\ parseinputtorecipe() // reads all the remaining fields from the form (name, category, price, serving, etc) and returns them as a tuple 100 101 // we collect all the information the user entered and create an instance of recipe 102 // the recipeinfo objectid will be nil if the currently displayed information does not correspond to a recipe already saved on your back4app database 103 let newrecipe recipe = recipe( 104 objectid recipeinfo objectid, 105 name recipeinfo name, 106 servings recipeinfo servings, 107 price recipeinfo price, 108 isavailable recipeinfo isavailable, 109 category recipeinfo category, 110 ingredients ingredients, 111 sideoptions recipeinfo sideoptions, 112 nutritionalinfo nutritionalinfo, 113 releasedate recipeinfo releasedate 114 ) 115 116 return newrecipe 117 } 118 119 /// called when the user presses the 'previous recipe' or 'next recipe' button 120 @objc private func handleswitchrecipe(button uibarbuttonitem) { 121 122 } 123 } 4 execute o aplicativo! antes de pressionar o botão de execução no xcode, não se esqueça de configurar seu aplicativo back4app na classe appdelegate! a primeira vez que você executar o projeto, deve ver algo assim no simulador (com todos os campos vazios) agora você pode começar a inserir uma receita para depois salvá la no seu banco de dados back4app uma vez que você tenha salvo uma receita, vá para o seu painel do back4app https //parse dashboard back4app com/apps e vá para sua aplicação, na seção banco de dados você encontrará a classe receita onde todas as receitas criadas pelo app ios em particular, vale a pena notar como tipos de dados não fundamentais como ingrediente, receita categoria ou dicionários são armazenados se você navegar pelos dados salvos sob a classe receita, encontrará que o dicionário nutritionalinformation é armazenado como um objeto json o array \[ingredients] é armazenado como um array de objetos json a enumeração receita categoria, uma vez que possui um tipo de dado inteiro como rawvalue, é transformada em um tipo de valor number a propriedade releasedate, um valor do tipo date em swift , também é armazenada como um valor do tipo date para concluir, ao recuperar dados do seu banco de dados back4app, você não precisa decodificar todos esses campos manualmente, o sdk parseswift faz isso automaticamente isso significa que, ao criar uma consulta (query\<recipe> no caso) para recuperar dados, o método query find() irá analisar todos os tipos de dados e objetos json para retornar um array de receita, não há nenhum procedimento adicional de análise a ser implementado