ABONAMENTE VIDEO REDACȚIA
RO
EN
×
▼ LISTĂ EDIȚII ▼
Numărul 27
Abonament PDF

Integrarea client server cu ajutorul RestKit

Mihai Fischer
mihaifischer.com
PROGRAMARE

În momentul de față există foarte multe servicii web la care te poți conecta pentru a obține date folositoare. De exemplu Instagram, Twitter pentru imagini sau tweeturi sau în cazul meu personal Foursquare, de unde pot obține o listă cu barurile din zonă. În general ai putea să te conectezi direct la servicii de genul acesta cu NSURLRequest sau cu o librărie precum AFNetworking. Aici intervine RestKit, care te scutește de câteva bătăi de cap și parsări de JSON.

Ce este RestKit?

RestKit este un framework Objective-C al cărui scop e ușurarea interacțiuniilor cu servicii web de tip RESTful. În linii mari, combină un HTTP request/respone API simplu și ușor de folosit cu un sistem puternic de mapare care reduce mult din boilerplate code-ul de care ai avea în mod normal nevoie, atunci când lucrezi cu servici web. Cel mai important aspect a RestKit e ca permite developer-ului să se gândească mai mult cum să-și construiască data model-ul și să-si facă mai puține griji pentru cum să trimită request-uri sau să parseze JSON și să mapeze rezultatele la obiecte native.

Ce conține?

RestKit conține un client HTTP care are la bază NSURLConnection și pune la dispoziție o librărie de metode ajutătoare pentru inspecția tipurilor MIME și a status codes. De exemplu, trimiterea datelor dintr-un form constă doar din crearea unui dicționar cu parametri. De asemenea, există și un suport simplu pentru upload-ul de fișiere mari (ex: video).

Suportul la nivel de framework pentru schimbarea serverelor și a enviroment-urilor (ex: development, production) este de asemenea oferit. RestKit folosește base URL și resource paths în loc de URL-uri întregi pentru a permite schimbarea rapidă între servere.

Un sistem de mapare a obiectelor. Reskit oferă un layer de modelare pentru maparea datelor procesate în obiecte native Cocoa. Nu mai trebuie să-ți faci griji pentru parsarea răspunsului JSON. Maparea obiectelor e făcută cu ajutorul a key-value coding.

De asemenea, oferă integrare cu Apple Core Data framework. Acest lucru permite RestKit să păstreze obiecte ce au fost încărcate de pe un server într-o bază de date locală folosită pe post de cache sau baza de date principală sincronizată periodic cu Cloud-ul.

Data base seeding. Când se folosește în cadrul aplicației Core Data, RestKit e capabil să populeze această bază de date locală, lucru care permite upload-ul în App Store a unei aplicații cu o bază de date locală deja existentă și funcțională.

Integrare cu Rails. RestKit a fost construit la început ca un răspuns Objective-C la Active Resource, dar cum Rails este folosit în general pentru un backend de iOS, era și normal ca RestKit să ofere suport în acest sens.

Exemplu

Voi extrage doar partea legată de RestKit din proiectul meu. Pornind de la o aplicație simplă cu o listă, pe care o vrem populată cu locațiile dorite oferite de serviciul de la Foursquare. Aceasta constă din doua view controller-e mai importante, un UITableViewController pentru listă și un UIViewController pentru detaliile fiecărei dintre locații. Nu voi intra în detalii despre cum ar trebui să se facă aceasta sau cum ar trebui să arate, deoarece nu este subiectul articolului.

După ce avem proiectul pregătit, sunt două modalități de a adăuga RestKit într-un proiect: CocoaPods sau Git submodule. Din motive de simplitate și rapiditate am ales CocoaPods, instalarea pods-urilor fiind doar câteva linii de comandă în terminal:

$ sudo gem install cocoapods
$ pod setup
$ cd /calea/catre/ProiectulVostruCuBaruriApropiate
$ touch Podfile
$ [edit] Podfile (using your preferred editor; vim, nano, etc)
platform: ios, '5.0'
pod 'RestKit', '-> 0.20.0'
$ pod install

Nu în ultimul rând, înainte de a putea folosi APIul, trebuie să înregistrăm aplicația pe https://foursquare.com/developers/apps. Mai multe detalii despre serviciul folosit găsiți pe https://developer.foursquare.com/docs/venues/search.

De aici veți avea nevoie de client ID și client secret, pe care le puțeti adăuga în proiect sub formă de macros

#define kCLIENTID @
#define kCLIENTSECRET @

După ce ați făcut setup-ul și toți pașii ceruți, puteți testa serviciul și observa că în răspunsul serviciul veți avea cam întodeauna un JSON de genul:

{
  "meta": {
    "code": 200
  },
  "notifications": [
    {
      "item": {
        "unreadCount": 3
      },
      "type": "notificationTray"
    }
  ],
  "response": {
    "confident": true,
    "neighborhoods": [],
    "venues": [
      {
        "categories": [
          {
            "icon": {
              "prefix": "https://ss1.4sqi.net/img/categories_v2/food/bar_",
              "suffix": ".png"
            },
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Bar",
            "pluralName": "Bars",
            "primary": true,
            "shortName": "Bar"
          }
        ],
        "contact": {
          "formattedPhone": "(408) 446-9000",
          "phone": "4084469000",
          "twitter": "jackslongdrinks"
        },
        "hereNow": {
          "count": 0,
          "groups": []
        },
        "id": "51630409498eedc7dd88e60b",
        "location": {
          "address": "20686 Stevens Creek Blvd",
          "cc": "US",
          "city": "Cupertino",
          "country": "United States",
          "crossStreet": "De Anza Blvd",
          "distance": 936,
          "lat": 37.32246179607897,
          "lng": -122.03470838696346,
          "postalCode": "95014",
          "state": "CA"
        },
        "name": "Jacks Cocktails",
        "referralId": "v-1390061483",
        "specials": {
          "count": 0,
          "items": []
        },
        "stats": {
          "checkinsCount": 3790,
          "tipCount": 40,
          "usersCount": 1460
        },
        "verified": true
      },
      {
        "categories": [
          {
            "icon": {
              "prefix": "https://ss1.4sqi.net/img/categories_v2/food/bar_",
              "suffix": ".png"
            },
            "id": "4bf58dd8d48988d1e0931735",
            "name": "Bar",
            "pluralName": "Bars",
            "primary": true,
            "shortName": "Bar"
          }
        ],
        "contact": {
          "formattedPhone": "(650) 321-2161",
          "phone": "6503212161",
          "twitter": "downtown_coffee"
        },
        "hereNow": {
          "count": 0,
          "groups": []
        },
        "id": "4dd1580eb3adb047f5024231",
        "location": {
          "address": "101 Forest Ave",
          "cc": "US",
          "city": "Palo Alto",
          "country": "United States",
          "crossStreet": "at Alma St.",
          "distance": 17063,
          "lat": 37.442086282055726,
          "lng": -122.16159119091502,
          "postalCode": "94301",
          "state": "CA"
        },
        "name": "Downtown Coffee",
        "referralId": "v-1390061483",
        "specials": {
          "count": 0,
          "items": []
        },
        "stats": {
          "checkinsCount": 14168,
          "tipCount": 118,
          "usersCount": 4044
        },
        "verified": true
      }
    ]
  }
}

Partea de cod

Acum că avem toate piesele la un loc, putem începe să construim aplicația. Pentru acest articol ne vom lega doar de două componente mari ale RestKit: Network și Object Mapping. Pentru Network, definim baza URL-ului pentru API-ul Forsquare (https://api.foursquare.com) și trimitem/primim mesajele. Pentru Object Mapping vom defini un model pe care îl vom mapa la valoriile JSON returnate de catre serviciu.

După ce examinăm un pic JSON-ul de mai sus, putem crea o clasa Locatie care să extindă NSObject. De dragul simplitații, pentru moment, îi adăugăm o singură proprietate:

@interface Venue : NSObject
@property (nonatomic, strong) NSString *name;
@end

Și importăm clasa nou creată și RestKit în view controller-ul principal.

#import 
#import "Locatie.h"

Adăugăm o metodă de configuarare a RestKit și una de încărcare a locațiilor într-una din metodele de lifecycle, de preferat viewDidLoad.

- (void)viewDidLoad
{
    [super viewDidLoad];

    [self configureRestKit];
    [self loadVenues];
}

După care creăm și metodele în sine:

- (void)configureRestKit
{
    // initialize AFNetworking HTTPClient
    NSURL *baseURL = [NSURL URLWithString:@"https://api.foursquare.com"];
    AFHTTPClient *client = [[AFHTTPClient alloc] initWithBaseURL:baseURL];

    // initialize RestKit
    RKObjectManager *objectManager = [[RKObjectManager alloc] initWithHTTPClient:client];

    // setup object mappings
    RKObjectMapping *venueMapping = [RKObjectMapping mappingForClass:[Venue class]];
    [venueMapping addAttributeMappingsFromArray:@[@"name"]];

    // register mappings with the provider using a response descriptor
    RKResponseDescriptor *responseDescriptor = 
        [RKResponseDescriptor responseDescriptorWithMapping:venueMapping 
                                                     method:RKRequestMethodGET 
                                                pathPattern:@"/v2/venues/search" 
                                                    keyPath:@"response.venues" 
                                                statusCodes:[NSIndexSet indexSetWithIndex:200]];

    [objectManager addResponseDescriptor:responseDescriptor];
}

În metodă, definim baza URL-ului despre care vorbeam și mai devreme, pentru API-ul Forsquare. Toate request-urile vor fi legate de acest URL.

Clasa RKObjectManager definește maparea dintre un atribut JSON și atributul corespunzător din data model. addAttributeMappingsFromArray este o metodă care se poate folosi în cazul în care JSON-ul și modelul au aceleași chei, în cazul nostru "name".

Pe urmă creăm un RKResponseDescriptor, care descrie o mapare a unui obiect care este aplicabilă unui răspuns HTTP. pathPattern este comparat cu URL-uri pentru care maparea ar trebui folosită. keyPath:@"response.venues" e folosit de RestKit pentru a găsi obiectele pentru locație.

- (void)loadVenues
{
    NSString *latLon = @"37.33,-122.03"; // aici putem sa trecem locatia noastra curenta
    NSString *clientID = kCLIENTID;
    NSString *clientSecret = kCLIENTSECRET;

    NSDictionary *queryParams = @{@"ll": latLon,
                                  @"client_id": clientID,
                                  @"client_secret": clientSecret,
                                  @"categoryId": @"4bf58dd8d48988d1e0931735",
                                  @"v": @"20140118"};

    [[RKObjectManager sharedManager] getObjectsAtPath:@"/v2/venues/search"
                      parameters:queryParams
                         success:^(RKObjectRequestOperation *operation, RKMappingResult *mappingResult) {
                                     _venues = mappingResult.array;
                                     [self.tableView reloadData];
                                 }
                         failure:^(RKObjectRequestOperation *operation, NSError *error) {
                                     NSLog(@"Din pacate nu sunt baruri in zona...: %@", error);
                                 }];
}

@interface MasterViewController ()

@property (nonatomic, strong) NSArray *venues;

@end

@implementation MasterViewController

- (UITableViewCell *)tableView:(UITableView *)tableView cellForRowAtIndexPath:(NSIndexPath *)indexPath
{
    UITableViewCell *cell = [tableView dequeueReusableCellWithIdentifier:@"Cell" forIndexPath:indexPath];

    Venue *venue = _venues[indexPath.row];
    cell.textLabel.text = venue.name;

    return cell;
}

E o librărie folositoare cu care practic am redus tot codul necesar pentru parsare, mapare și încărcare în cele două metode scurte menționate mai sus. De aici putem dezvolta modelul și să avem mai multe atribute. În final, lăsând la o parte detaliile precum harta și butoanele de navigare, ar trebui să avem o listă ca în imagine, funcțcională, cu barurile din jurul nostru.

LANSAREA NUMĂRULUI 81, CLUJ

Prezentări articole și
Panel: AI și autonomous driving

Miercuri, 20 Martie, ora 18:00
sediul Telenav

Înregistrează-te

Facebook Meetup

Conferință

Sponsori

  • ntt data
  • 3PillarGlobal
  • Betfair
  • Telenav
  • Accenture
  • Siemens
  • Bosch
  • FlowTraders
  • MHP
  • Connatix
  • UIPatj
  • MetroSystems
  • MicroFocus
  • Colors in projects