Retrofit - 网络请求库

Retrofit基于注解和动态代理,优化了Android中的网络请求操作。

OverView

这篇笔记基于Retrofit 1.9。

从上图可见,对Retrofit的使用可以分成三部分:

  1. 建立POJO或者Model Class
    服务端返回给客户端的数据一般都是JSON格式,所以可以利用GSON或其他库把JSON直接转换成一个对象。POJO或这个Model Class就是这个对象的类。

  2. 定义REST API Interface
    定义一个Interface,声明我们需要的网络请求方法。
    例如:

    public interface GitHubService {
         @GET("/users/{user}/repos")
         List<Repo> listRepos(@Path("user") String user);
    

}

   Repo,就是第一步中定义的POJO或者Model Class。Retrofit框架会自动把服务端返回的JSON数据,转换成Repo。Retrofit默认采用GSON库。
3. RestAdapter  
   RestAdapter用来配置网络请求的参数,并且生成一个接口的实现。  
   配置请求参数:
   

RestAdapter restAdapter = new RestAdapter.Builder()
.setEndpoint("https://api.github.com")
.setClient(new OkClient(new OkHttpClient()))
.build();

生成接口的实现:

    GitHubService service = restAdapter.create(GitHubService.class);

以上三步完成后,调用接口函数完成与服务器的交互:

  List<Repo> repos = service.listRepos("octocat");
## 请求方法
Retrofit框架提供了很多注解,其中HTTP注解有五个,用来修饰请求方法(还可以顺便处理URL路径):

* GET
* POST
* PUT
* DELETE
* HEAD

这五个注解正好涵盖了数据的增删改查方法,符合REST标准。每一个请求方法都必须要由这五个注解中的一个修饰。  

  @GET("/users/list")
可以在注解中添加查询参数

  @GET("/users/list?sort=desc")
  
## URL处理
* @Path - 替换参数  

      @GET("/group/{id}/users")
      List<User> groupList(@Path("id") int groupId);
* @Query - 添加查询参数

      @GET("/group/{id}/users")
      List<User> groupList(@Path("id") int groupId, @Query("sort") String sort);
* @QueryMap - 如果有多个查询参数,把它们放在Map中

      @GET("/group/{id}/users")
      List<User> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);
      
## 请求体
请求体(RequestBody),一般用于POST方法传递请求参数。  
`@Body`

  @POST("/users/new")
  void createUser(@Body User user, Call<User> call);
  
参数会被指定的转换器转换成字符串或字节流提交到服务器,如果没有指定转换器,Retrofit将会默认使用**RequestBody**。

## FORM ENCODED(表单) And MULTIPART
* #### FORM ENCODED

使用 **@FormUrlEncoded** 修饰请求方法,可以把表单数据提交到服务端。  
用 **@Field** 修饰key-value对。

      @FormUrlEncoded
      @POST("/user/edit")
      User updateUser(@Field("first_name") String first, @Field("last_name") String last);
      
* #### MULTIPART

使用 **@Multipart** 修饰请求方法,**@Part** 修饰每一个Part

      @Multipart
      @PUT("/user/photo")
      User updateUser(@Part("photo") TypedFile photo, @Part("description") TypedString description);
      
Multipart 中的Part使用  **RestAdapter**  的转换器来转换,也可以实现  **TypedOutput**  自己处理序列化。

`Multipart主要用来上传文件吗?如果是,具体操作又是如何?`  [答案在这里](http://yat3s.com/2015/09/16/retrofit/)

## 配制HEADER
用 **@Headers** 设置Http请求的header。

@Headers("Cache-Control: max-age=640000")
@GET("/widget/list")
void widgetList(Call<List<Widget>> call);

@Headers({
"Accept: application/vnd.github.v3.full+json",
"User-Agent: Retrofit-Sample-App"
})
@GET("/users/{username}")
void getUser(@Path("username") String username, Call<User>);

Http请求头不会互相覆盖,如果存在多个请求头的名字相同,那么它们全部都会被包含在Http请求中。

## 动态更新HEADER
* #### 在请求方法的参数中,用 **@Header** 动态更新Http请求头

        @GET("/user")
        void getUser(@Header("Authorization") String authorization, Call<User> call)
  参数不能为null,否则这个header将会被删掉。
* #### 在RestAdapter中,利用RequestInterceptor动态更新Header

    ```
RequestInterceptor requestInterceptor = new RequestInterceptor() {
    @Override
    public void intercept(RequestFacade request) {
        request.addHeader("User-Agent", "Retrofit-Sample-App");
    }
};
RestAdapter restAdapter = new RestAdapter.Builder()
    .setEndpoint("https://api.github.com")
    .setRequestInterceptor(requestInterceptor)
    .build();

异步与同步

每个请求方法都可以定义成同步或者异步。

  • 同步

    同步方法有返回值,且参数中不包含回调

      @GET("/users/{user}/repos")
      List<Repo> listRepos(@Path("user") String user);
    
  • 异步

    异步方法没有返回值,且最后一个参数须是Callback对象

      @GET("/users/{user}/repos")
      void listRepos(@Path("user") String user, Callback<List<Repo>> call);
    

    在Android中,callbacks将会在主线程中调用。在普通Java程序中,callbacks将会在执行HTTP请求方法的那个线程中调用。

处理服务器返回结果

RestAdapter中的转换器会把服务器的返回结果(一般为JSON)转换成我们在函数返回值或Callback接口中定义的Java对象。

          @GET("/users/{user}/repos")
        List<Repo> listRepos(@Path("user") String user);
         
        @GET("/users/{user}/repos")
        void listRepos(@Path("user") String user, Callback<List<Repo>> call);

List<Repo>,就是将要被转换成的Java对象。

直接获取返回体

如果要直接获取服务器返回的HTTP返回体,在返回值或callback中直接使用 Response对象。

          @GET("/users/{user}/repos")
        Response listRepos(@Path("user") String user);
         
        @GET("/users/{user}/repos")
        void listRepos(@Path("user") String user, Callback<Response> call);

参考链接:

  1. 官方文档,不过是Retrofit2.0
  2. 中文文档,这个是Retrofit1.9
  3. http://jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/1109/3662.html
  4. http://jcodecraeer.com/a/anzhuokaifa/androidkaifa/2015/0915/3460.html
  5. 源码解析,http://frodoking.github.io/2015/05/16/android-retrofit/
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 230,048评论 6 542
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 99,414评论 3 429
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 178,169评论 0 383
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 63,722评论 1 317
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 72,465评论 6 412
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 55,823评论 1 328
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 43,813评论 3 446
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 43,000评论 0 290
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 49,554评论 1 335
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 41,295评论 3 358
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 43,513评论 1 374
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 39,035评论 5 363
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 44,722评论 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 35,125评论 0 28
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 36,430评论 1 295
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 52,237评论 3 398
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 48,482评论 2 379

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,825评论 18 139
  • 简介 刚接触Retrofit的时候,就写了一篇简单的使用介绍:Retrofit 2.0基本使用方法,算是对Retr...
    Whyn阅读 2,872评论 4 24
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 172,728评论 25 708
  • 明媚的阳光洒向大地、射入人心、穿梭在大街小巷中……阳光能给予人们温暖,给予人们伤怀,能给人一种想要望向天空却要眯上...
    愌惞阅读 752评论 1 7
  • “嗨,你来了啊!” 早上进车库刚上车,车库门前就传来了这一句喊话,一辆三轮车也停在了门口。 我一看,知道了,是经常...
    淡隐于朝阅读 691评论 0 0