J'ai été poussé à écrire cet article par une dépression presque nerveuse provoquée par mon désir d'apprendre à communiquer avec des API tierces, j'étais particulièrement intéressée par le processus de décodage des documents JSON! Heureusement, j'ai évité une dépression nerveuse, alors il est maintenant temps de contribuer à la communauté et d'essayer de publier mon premier article sur Habré.
Pourquoi y a-t-il des problèmes avec une tâche aussi simple?
Pour comprendre d'où viennent les problèmes, vous devez d'abord parler de la boîte à outils que j'ai utilisée. Pour décoder des objets JSON, j'ai utilisé le protocole de synthèse relativement nouveau de la bibliothèque Foundation - odable .
Codable est un protocole intégré qui vous permet d'effectuer un encodage dans un objet au format texte et un décodage à partir d'un format texte. Codable est la somme de deux autres protocoles: Decodable et Encodable.
Il vaut la peine de réserver qu'un protocole est appelé synthétisé lorsque certaines de ses méthodes et propriétés ont une implémentation par défaut. Pourquoi de tels protocoles sont-ils nécessaires? Pour faciliter le travail avec leur signature, au moins en réduisant la quantité de code standard.
Ces protocoles permettent également de travailler avec la composition, pas l'héritage!
Parlons maintenant des problèmes:
-, , Apple. " "? JSON ; .
-, . , . .
-,
. : API Flickr, N- ( : ) .
: API, REST- API, , c GET-.
Flickr JSON :
{
"photos":{
"page":1,
"pages":"11824",
"perpage":2,
"total":"23648",
"photo":[
{
"id":"50972466107",
"owner":"191126281@N@7" ,
"secret":"Q6f861f8b0",
"server":"65535",
"farm":66,
"title":"Prompt & Reliable Electrolux Oven Repairs in Gold Coast",
"ispublic":1,
"isfriend":0,
"isfamily":0
},
{
"id":"50970556873",
"owner":"49965961@NG0",
"secret":"21f7a6424b",
"server":"65535",
"farm" 66,
"title":"IMG_20210222_145514",
"ispublic":1,
"isfriend":0,
"isfamily":0
}
]
},
"stat":"ok"
}
, . ? , . ? - , ( , ). - , , , ( ) () Flickr , .
? , GET- , ! : ---. . . JSON- , , . "photo": "id", "secret", "server"
, :
struct Photo {
let id: String
let secret: String
let server: String
}
let results: [Photos] = // ...
"" . , best practices JSON- .
. , . , Codable. , .
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0"
}
. , JSON- ( "id", "secret", "server"); , (, ). Decodable, , ( , ). ? , " ". . ( , Data, decode(...) JSONDecoder Data).
:
, , API - jsonplaceholder.typicode.com, JSON-, GET-.
jsonformatter.curiousconcept.com . "" REST , Playground Xcode.
tool - app.quicktype.io - Swift JSON-.
. :
struct Photo: Decodable {
let id: String
let secret: String
let server: String
}
let json = """
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0"
}
"""
let data = json.data(using: .utf8)
let results: Photo = try! JSONDecoder().decode(Photo.self, from: data)
, JSON-, "key" : "sometexthere" Decodable String, run-time. Decodable coerce- ( ).
struct Photo: Decodable {
let id: Int
let secret: String
let server: Int
}
let json = """
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0"
}
"""
let data = json.data(using: .utf8)
let results: Photo = try! JSONDecoder().decode(Photo.self, from: data)
. ?
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0",
"server":"65535",
"farm":66,
"title":"Prompt & Reliable Electrolux Oven Repairs in Gold Coast",
"ispublic":1,
"isfriend":0,
"isfamily":0
}
, Decodable , , " " , . , API , " " , , , , . - "".
. JSON-:
[
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0",
"server":"65535",
"farm":66,
"title":"Prompt & Reliable Electrolux Oven Repairs in Gold Coast",
"ispublic":1,
"isfriend":0,
"isfamily":0
},
{
"id":"50970556873",
"owner":"49965961@N00",
"secret":"21f7a6524b",
"server":"65535",
"farm":66,
"title":"IMG_20210222_145514",
"ispublic":1,
"isfriend":0,
"isfamily":0
}
]
( ) . , - !
struct Photo: Decodable {
let id: String
let secret: String
let server: String
}
let json = """
[
{
"id":"50972466107",
"owner":"191126281@N07",
"secret":"06f861f8b0",
"server":"65535",
"farm":66,
"title":"Prompt & Reliable Electrolux Oven Repairs in Gold Coast",
"ispublic":1,
"isfriend":0,
"isfamily":0
},
{
"id":"50970556873",
"owner":"49965961@N00",
"secret":"21f7a6524b",
"server":"65535",
"farm":66,
"title":"IMG_20210222_145514",
"ispublic":1,
"isfriend":0,
"isfamily":0
}
]
"""
let data = json.data(using: .utf8)
let results: [Photo] = try! JSONDecoder().decode([Photo].self, from: data)
, [Photo] - Swift. : - !
, , .
" " Decodable , JSON.
JSON- - , . - , . , JSON- ! , -, Character , JSON- .
JSON - . ? , , : JSON (, ). ? , ( )
Decodable .
, . Decodable generic enum CodingKeys, () , JSON , , , ! , . , , : JSON- snake case , Swift camel case. ?
struct Photo: Decodable {
let idInJSON: String
let secretInJSON: String
let serverInJSON: String
enum CodingKeys: String, CodingKey {
case idInJSON = "id_in_JSON"
case secretInJSON = "secret_in_JSON"
case serverInJSON = "server_in_JSON"
}
}
rawValue CodingKeys , JSON-!
! JSON !
{
"photos":{
"page":1,
"pages":"11824",
"perpage":2,
"total":"23648",
"photo":[
{
"id":"50972466107",
"owner":"191126281@N@7" ,
"secret":"Q6f861f8b0",
"server":"65535",
"farm":66,
"title":"Prompt & Reliable Electrolux Oven Repairs in Gold Coast",
"ispublic":1,
"isfriend":0,
"isfamily":0
},
{
"id":"50970556873",
"owner":"49965961@NG0",
"secret":"21f7a6424b",
"server":"65535",
"farm" 66,
"title":"IMG_20210222_145514",
"ispublic":1,
"isfriend":0,
"isfamily":0
}
]
},
"stat":"ok"
}
:
, : "photos", "stat"
"photos" : "page", "pages", "perpages", "total", "photo"
"photo" - , .
?
. dummy . !
Decodable , CodingKeys! ! : Swift ( !) extension stored properties, computed properties odable/Encodable/Decodable, JSON .
, , : photos photo c
, !
// (1) Photo .
struct Photo: Decodable {
let id: String
let secret: String
let server: String
}
// (2) JSONContainer, .
struct JSONContainer: Decodable {
// (3) photos c "photos" JSON, , , - , photo!
let photos: [Photo]
}
extension JSONContainer {
// (4) CodingKeys .
enum CodingKeys: String, CodingKey {
case photos
// (5) , photos.
// (6) - , PhotosKeys - , photos
enum PhotosKeys: String, CodingKey {
// (7) "photo"
case photoKey = "photo"
}
}
// (8)
init(from decoder: Decoder) throws {
// (9) JSON, , - photos
let container = try decoder.container(keyedBy: CodingKeys.self)
// (10) (nested - ) photos
let photosContainer = try container.nestedContainer(keyedBy: CodingKeys.PhotosKeys.self, forKey: .photos)
// (11)
// (12) photos -, .photoKey (.photoKey.rawValue == "photo")
photos = try photosContainer.decode([Photo].self, forKey: .photoKey)
}
}
Voilà, maintenant que l'instance du JSONDecoder. Appellera decode () - sous le capot, il utilisera notre initialiseur pour gérer le décodage
En résumé, je voudrais dire que travailler avec le réseau dans le développement iOS est rempli de diverses "surprises", donc si vous pouvez ajouter quelque chose dans les commentaires, assurez-vous de le faire!
Merci à tous!
PS Après un certain temps, il a été conclu qu'il était correct de mapper à la structure finale dans le code en utilisant uniquement le comportement intégré de Codable. La conclusion a été tirée après avoir regardé la session de la WWDC analysant le travail avec les données reçues du réseau.