retrofit一瞥

retrofit,这周采用的一个rest client库,在系统集成的时候用来从其他系统获取rest数据,使用起来非常简单方便。

retrofit可根据定义的api接口,发送http请求获取数据,数据会被指定的converter自动反序列化为对应的DTO(data template object)。由于大多数rest请求返回的数据都采用json格式,因此常用的converter为gson或jackson,这两个库提供了灵活的注解处理相应字段。下面以gson示例retrofit的使用。

class Book { // a DTO
  @SerializedName("name") //name based value put to title
  String title;
  String author;
  String year;
  String type; 
 //ignored getter and setters here...
}
class BookApiService{ //rest api
  @GET("v1/book/{id}")  //get method, request uri is v1/book/id
  public Call<Book> getBook(@Path("id")int id); //Call is like a future

  @GET("vi/books") //get method, request uri is vi/books?author=author&year=year
  public  Call<List<Book>> getBooks(@Query("author")String author, @Query("year")int year);

  @Headers("Content-Type: application/json")  //request headers
  @POST("v1/book/add") //post method, request uri is v1/book/add
  public Call<Book> addBook(@Body Book book, @Header("auth")String auth); //post request header with auth field, post data is a json format book
}

class BookService{  // retrofit service
  private Retrofit retrofit = new Retrofit.Builder().baseUrl("http://ip/").addConverterFactory(GsonConverterFactory().create()).build(); //base url is the start part of the rest uri , should be end with '/'
  private BookApiService service = retrofit.create(BookApiService.class);

  public Book getBook(int id){ //backend call this method to get book
    Call<Book> call = service.getBook(id);
    Response<Book> execute = call.execute();
    if(execute.isSuccessful()) { //if request success, make sure to judge success first
      return execute.body();
    } else{  //if request failed, bad request or internal server error...
      ResponseBody body = execute.errorBody(); //deal with error body
     ...
     return null; // or throw exception here
    }
  }
  // ignored other specified api method 
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容

  • 相信很多人都在使用Retrofit,我也在用,但是对它的理解都不是太深刻,现在Retrofit2已经出来一段时间,...
    WHOKNOWME阅读 7,466评论 6 19
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,367评论 25 707
  • 不熟悉Retrofit的同学可以先参考这篇文章:Retrofit – Java(Android) 的REST 接口...
    LucasAdam阅读 1,428评论 3 3
  • 你痛苦过吗?到什么程度?夜里哭醒! 你痛苦过吗?到什么程度?夜不能寐! 你痛苦过吗?到什么程度?恨夜太长! 我想痛...
    微风的自由阅读 236评论 2 1
  • 鱼儿 作者: 大吕 鱼儿缸中游, 犹觉不自由。 夜半急跃起, 朝闻则槁矣。 我家的鱼缸里原本有三只小鱼儿,...
    大吕娘阅读 146评论 0 0