Retrofit的详解及使用

概念

官方定义:Retrofit是一套Restful架构的Android(Java)客户端实现,基于注解,提供JSON to POJO(Plain Ordinary Java Object,简单Java对象),POJO to JSON,网络请求(POST,GET,PUT,DELETE等)封装。

本质:就是一种网络请求框架。

特点介绍

对于网络请求Android优先使用Okhttp,2.3之后使用HttpUrlConnection,2.3之前使用HttpClient。

Retrofit 就是对Okthttp再做一层封装,是一套注解形式的网络请求封装库,让我们的代码结构更给为清晰。它可以直接解析JSON数据变成JAVA对象,默认是GsonConverter(也可以自定义,也可以直接使用Jackson解析等),并支持回调操作,处理多种结果。

Api注解介绍

Retrofit的所有请求都需要一个请求方法注解并相对url路径作为参数,内含有多个http的注解:如Get、Post、Put、Delete、Head等。

Get:Get请求;

@GET(“group/users”)

Call<Result> groupList(@Query(“id”) int groupId);

等同于

@GET(“group/users?id=groupId")

Post:用于Post方式传递参数,需要在请求接口方法上添加@FormUrlEncoded,即以表单的方式传递参数.示例: 

 //用户登录   

 @FormUrlEncoded    

@POST("user/app_login")    

Call<UserInfo> login(@Field("wechat-info") String wechatInfo);

Put:用于发送一个PUT请求;

Delete:DELETE注解一般必须添加相对路径或绝对路径或者全路径,如果不想在DELETE注解后添加请求路径,则可以在方法的第一个参数中用@Url注解添加请求路径。

Head:添加http header,分为Head和Heads

Head

@GET(“group/users”)Call<List<User>> groupList(@Head(“id”) int groupId);

等同于

@Heads(“id:groupId”)//这里面的groupId为上面的方法传递过来的值@GET(“group/users”)

Call<List<UserInfo>> groupList(@Head(“id”) int groupId);

Heads跟@Header作用一样,只是使用方式不一样,@Header是作为请求方法的参数传入,@Headers是以固定方式直接添加到请求方法上.示例:添加多个设置

@Headers

({    "Accept: application/vnd.github.v3.full+json",  

  "id: Retrofit-Sample-App"})

Call<List<User>> groupList(@Head(“id”) int groupId);

Path:用于URL上占位符.

如:@GET("group/{id}/users")

Call<List<User>> groupList(@Path("id") int groupId);

将groupId变量的值替换到url上的id位置

扩展:

@Parh:

配合@Multipart使用,一般用于文件上传;

@Multipart

@POST(Api.UPLOAD_IMAGE_AND_VIDEO)      //上传视频和封面    Call<ApiResponseObject<UploadFrameAndVideoBean>> upLoadFrameAndVideo(@Part("userId") RequestBody userId);

@Body:

当你发送一个post或put请求,但是又不想作为请求参数或表单的方式发送请求时,使用该注解定义的参数可以直接传入一个实体类,retrofit会通过convert把该实体序列化并将序列化后的结果直接作为请求体发送出去.

实例:

//实体

class  UserEntity{

public String userId;

public String icon;

public String nickname;

@Override

public String toString() {

return "RecommendUserFormListBean{" +

"userId='" + userId + '\'' +

", icon='" + icon + '\'' +

", nickname='" + nickname + '\'' +

'}';

}

//接口

interface Service{

@POST(“common/follow”)

Call<ResposeBody> addCommon(@Body UserEntity)

}

@Field : 同@Post一起用,作用于方法的参数,发送一个表单请求。

@FieldMap:map中每一项的键和值都不能为空,否则抛出IllegalArgumentException异常 ;

@FormUrlEncoded    

@POST("user/app_login")    

Call<ApiResponseObject<UserInfo>> login(@FieldMap Mapfields);

@FormUrlEncoded:使用该注解,表示请求正文将使用表单网址编码,用于修饰Field注解和FieldMap注解;

@Multipart : 使用该注解,表示请求体是多部分的。 每一部分作为一个参数,且用Part注解声明;

Retrofit初始化:

ApiService.java,如图1,2:


图1


图2

* baseUrl:这里才真正给出了请求的地址,这里的地址会和ApiCreator中的GET/post/put等注解中的参数/进行拼接;

* 默认使用OkhttpClient请求方式,但是Retrofit一旦在项目中发现Okhttp,会自动集成Okhttp并优先使用;

* 通过Cache来设置缓存大小及位置;

* addConverterFactory:GsonConverterFactory,本文使用Gson解析;

* RxJavaCallAdapterFactory:如果返回数据封装成Observer,则使用Rxjava技术处理数据,adapterFactory.create()使用动态代理生成我们定义的接口的实现了类,并通过其返回(Retrofit的所有json与object转化工作由RestAdapter)。

好啦,以上的retrofit介绍完了!

简单介绍如何使用

* 首先在模块.gradle添加依赖,导入库:


图3

* 新建需要返回的数据类型模型:CategoryListEntity.java 

class CategoryListEntity{

  public int code;  

  public String msg;   

 public int haveData;   

public List<DataBean>data;

}

* 采用Get注解方式请求:


图4

调用走起:  

Call <CategoryListEntity>observable= ApiService.getInstance().createApi().getCategoryList(userId);

就可以啦,其实很简单。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,372评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,368评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,415评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,157评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,171评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,125评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,028评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,887评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,310评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,533评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,690评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,411评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,004评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,812评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,693评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,577评论 2 353

推荐阅读更多精彩内容