Retrofit常用注解

1.需要掌握的注解字段

Get Post

Url

Query QueryMap Field FieldMap

Path Body Part MulltiPart

Header Headers FormUrlEncode

retrofit的简单实现:

依赖:

implementation 'com.squareup.retrofit2:retrofit:2.5.0'

implementation 'com.squareup.retrofit2:converter-gson:2.1.0'

权限: <uses-permission android:name="android.permission.INTERNET"/>

代码:


Retrofit retrofit = new Retrofit.Builder()

.baseUrl("http://www.xxxx.com") // 添加请求地址

.addConverterFactory(GsonConverterFactory.create())//使用gson库解析

.build();

IFoodService iFoodService = retrofit.create(IFoodService.class);

Call<ResponseBody> call = iFoodService.getFoodList();

call.enqueue(new Callback<ResponseBody>() {

....此处忽略



1.Get

形式:url + 参数形式。 eg: http://www.qubaobei.com/ios/cf/dish_list.php?stage_id=1&limit=20&page=1

@GET("/ios/cf/dish_list.php?stage_id=1&limit=20")

Call<ResponseBody> getFoodList(@Query("page") String page);

2.Post

发送post请求,一般通过表单发送字段

FormUrlEncoded标识本次请求是表单形式的传参

@FormUrlEncoded

@POST("v1/login")

Call<ResponseBody> userLogin(@Field("phone") String phone, @Field("password") String password);

3.Url

使用base url和端点url可以应对大多数API,但是应用中总会出现另类的API。在我的示例中,现在要获取天气,当然我只能找到一个免费的api了。

@Headers("apikey:b86c2269fe6588bbe3b41924bb2f2da2")

@GET

Call<WeatherWrapper> weather(@Url String url, @Query("cityname") String cityName);

4.Query QueryMap

主要用于get请求,把参数追加到url路径里。

@GET("/ios/cf/dish_list.php?stage_id=1&limit=20")

Call<ResponseBody> getFoodList(@Query("page") String page);

Call<ResponseBody> getFoodList(@QueryMap Map<String, String> options);

5.Field FieldMap

主要用于post请求表单里的参数。可以对比以下两种方式的不同。

@FormUrlEncoded

@POST("v1/login")

Call<ResponseBody> userLogin(@Field("phone") String phone, @Field("password") String password);

@FormUrlEncoded

@POST("book/reviews")

Call<String> addReviews(@FieldMap Map<String, String> fields);


6.Path

接收一个字符串表示接口 path ,与 baseUrl 组成完整的 Url;

@GET("blog/{id}")Call<ResponseBody>getBlog(@Path("id")intid);

7.Body

使用 @Body 注解,指定一个对象作为 request body 。

@POST("users/new")Call<User>createUser(@BodyUser user);

8.Part MulltiPart

主要处理文件上传

@Multipart@POST("upload")Call<ResponseBody>uploadOneFile(@PartMultipartBody.Part body);

9.Header Headers


使用 @Headers 注解设置固定的请求头,所有请求头不会相互覆盖,即使名字相同。

使用 @Header 注解—动态更新请求头,匹配的参数必须提供给 @Header ,若参数值为 null ,这个头会被省略

// Headers的使用

@Headers("Cache-Control: max-age=640000")

@GET("widget/list")

Call<List<Widget>> widgetList();

@Headers({ "Accept: application/vnd.github.v3.full+json","User-Agent: Retrofit-Sample-App"})

@GET("users/{username}")Call<User>

getUser(@Path("username") String username);

// Header的使用

@GET("user")

Call<User> getUser(@Header("Authorization") String authorization)

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