Retrofit全攻略——基礎(chǔ)篇

實際開發(fā)過程中一般都會選擇一些網(wǎng)絡(luò)框架提升開發(fā)效率。隨著Google對HttpClient 摒棄和Volley框架的逐漸沒落经备,OkHttp開始異軍突起窘俺,而Retrofit則對OkHttp進行了強制依賴病梢,可以簡單理解Retroifit在OKHttp基礎(chǔ)上進一步完善箕般。

Retrofit是由Square公司出品的針對于Android和Java的類型安全的Http客戶端甸昏,目前推出了2.0+的版本顽分。

Retrofit框架項目地址:https://github.com/square/retrofit
Retrofit官方文檔地址: http://square.github.io/retrofit/

使用Retrofit

接下來我們來學(xué)習(xí)下如何使用Retrofit施蜜。
首先需要在app/build.gradle添加依賴卒蘸。

dependencies {
    //...
    //retrofit
    compile 'com.squareup.retrofit2:retrofit:2.1.0'
    //如果用到gson解析 需要添加下面的依賴
    compile 'com.squareup.retrofit2:converter-gson:2.1.0'
}

我們以查號碼歸屬地接口為例 https://www.juhe.cn/docs/api/id/11

Retrofit不能直接使用,需要進行初始化花墩,在這里創(chuàng)建NetWork.java

public class NetWork {
    private static Retrofit retrofit;
  
    /**返回Retrofit*/
    public static Retrofit getRetrofit(){
        if(retrofit==null){
            Retrofit.Builder builder = new Retrofit.Builder();//創(chuàng)建Retrfit構(gòu)建器
            retrofit = builder.baseUrl("http://apis.juhe.cn/") //指定網(wǎng)絡(luò)請求的baseUrl
                    .addConverterFactory(GsonConverterFactory.create())//返回的數(shù)據(jù)通過Gson解析
                    .build();
        }
        return retrofit;
    }
}

Retrofit需要之地baseUrl悬秉,往往一個項目中有很多接口,接口都使用相同的服務(wù)器地址冰蘑,這時候可以把接口地址相同的部分抽取到baseUrl中和泌,Retrofit擴展性極好,可以指定返回的數(shù)據(jù)通過Gson解析祠肥,前提你需要保證項目中有Gson框架和com.squareup.retrofit2:converter-gson:2.1.0的依賴武氓。

除了通過Gson解析還可以使用其它的方式解析,需要的依賴也不同仇箱,有如下幾種:

  • Gson: com.squareup.retrofit:converter-gson
  • Jackson: com.squareup.retrofit:converter-jackson
  • Moshi: com.squareup.retrofit:converter-moshi
  • Protobuf: com.squareup.retrofit:converter-protobuf
  • Wire: com.squareup.retrofit:converter-wire
  • Simple XML: com.squareup.retrofit:converter-simplexml

Retrofit需要把Http的請求接口封裝到一個接口文件中县恕。

public interface NetInterface {
    //獲取號碼歸屬地,返回來類型是Bean, 需要兩個參數(shù)分別為phone何key
    @GET("mobile/get")
    Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}

其中Bean是根據(jù)請求的結(jié)果創(chuàng)建的對象.

方法前添加@GET注解表示當(dāng)前請求是Get方式請求剂桥,鏈接的地址是baseUrl+"mobile/get"忠烛,baseUrl在初始化Retrofit的時候指定了,拼到一起就是 http://apis.juhe.cn/mobile/get权逗。
對于 Retrofit 2.0中新的URL定義方式美尸,這里是我的建議:

  • baseUrl: 總是以 /結(jié)尾
  • url: 不要以 / 開頭

因為如果不是這種方式,拼裝后的結(jié)果和你期望的是不一樣的斟薇,詳情參考官方文檔师坎。

除了Get請求還有下面幾種請求方式

  • @POST 表明這是post請求
  • @PUT 表明這是put請求
  • @DELETE 表明這是delete請求
  • @PATCH 表明這是一個patch請求,該請求是對put請求的補充堪滨,用于更新局部資源
  • @HEAD 表明這是一個head請求
  • @OPTIONS 表明這是一個option請求
  • @HTTP 通用注解,可以替換以上所有的注解胯陋,其擁有三個屬性:method,path袱箱,hasBody

最后的HTTP通用注解寫法比較特殊遏乔,請求可以代替之前的請求。下面的寫法和之前的@GET效果是一樣的发笔。

/**
 * method 表示請的方法按灶,不區(qū)分大小寫
 * path表示路徑
 * hasBody表示是否有請求體
 */
@HTTP(method = "GET",path = "mobile/get",hasBody = false)
Call<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);

@Quert表示查詢參數(shù),用于GET查詢筐咧,注解里的字符串是參數(shù)的key值鸯旁,參數(shù)會自動拼裝到Url后面噪矛。
除了上面的注解,再給大家介紹幾種不同的注解铺罢。

常用的注解

@Url:使用全路徑復(fù)寫baseUrl艇挨,適用于非統(tǒng)一baseUrl的場景。示例代碼:

@GET Call<ResponseBody> XXX(@Url String url);

@Streaming:用于下載大文件韭赘。示例代碼:

@Streaming @GET Call<ResponseBody> downloadFileWithDynamicUrlAsync(@Url String fileUrl);
  
  
//獲取數(shù)據(jù)的代碼
ResponseBody body = response.body();
long fileSize = body.contentLength();
InputStream inputStream = body.byteStream();

@Path:URL占位符缩滨,用于替換和動態(tài)更新,相應(yīng)的參數(shù)必須使用相同的字符串被@Path進行注釋

//實際請求地址會給句groupId的值發(fā)生變化--> http://baseurl/group/groupId/users
@GET("group/{id}/users") Call<List<User>> groupList(@Path("id") int groupId);

@QueryMap:查詢參數(shù),和@Query類似泉瞻,區(qū)別就是后面需要Map集合參數(shù)脉漏。示例代碼:

Call<List<News>> getNews((@QueryMap(encoded=true) Map<String, String> options);

@Body:用于POST請求體,將實例對象根據(jù)轉(zhuǎn)換方式轉(zhuǎn)換為對應(yīng)的json字符串參數(shù)袖牙,這個轉(zhuǎn)化方式是GsonConverterFactory定義的侧巨。 示例代碼:

@POST("add")
Call<List<User>> addUser(@Body User user);

@Field,@FieldMap:Post方式傳遞簡單的鍵值對鞭达,需要添加@FormUrlEncoded表示表單提交

@FormUrlEncoded @POST("user/edit") Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

@Part司忱,@PartMap:用于POST文件上傳,其中@Part MultipartBody.Part代表文件畴蹭,@Part(“key”) RequestBody代表參數(shù)坦仍,需要添加@Multipart表示支持文件上傳的表單。

@Multipart
   @POST("upload")
   Call<ResponseBody> upload(@Part("description") RequestBody description,
                             @Part MultipartBody.Part file);

完成請求實例

了解了Retrofit叨襟,我們用Retrofit請求完成請求繁扎,Retrofit使用起來比較省事,核心代碼如下所示:

//初始化Retrofit,加載接口
NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
//請求接口
netInterface.getAddress(editText.getText().toString(),"你的app key")
        .enqueue(new Callback<Bean>() {
            @Override
            public void onResponse(Call<Bean> call, Response<Bean> response) {
                //請求成功
                Bean bean = response.body();
                //...
            }
   
            @Override
            public void onFailure(Call<Bean> call, Throwable t) {
                //請求失敗
            }
        });

Retrofit會自動在子線程中進行網(wǎng)絡(luò)請求糊闽,請求結(jié)束切換到主線程中梳玫,而且內(nèi)部使用了線程池,對網(wǎng)絡(luò)請求的緩存控制的也非常到位墓怀,網(wǎng)絡(luò)響應(yīng)速度也是很快的汽纠,使用起來非常的爽!

RxJava和Retrofit結(jié)合

RxJava非常強大卫键,就連Retrofit都要抱下他的大腿傀履,Retrofit也可以用RxJava方式進行網(wǎng)絡(luò)請求,只需要對上面的代碼進行改造即可莉炉。

首先添加框架依賴钓账。

dependencies {
  //...
       
    compile 'io.reactivex:rxandroid:1.2.1'
    compile 'io.reactivex:rxjava:1.1.6'
   
    compile 'com.google.code.gson:gson:2.8.0'
   
    compile 'com.squareup.retrofit2:retrofit:2.1.0'
    //如果用到gson解析 需要添加下面的依賴
    compile 'com.squareup.retrofit2:converter-gson:2.1.0'
    //Retrofit使用RxJava需要的依賴
    compile 'com.squareup.retrofit2:adapter-rxjava:2.1.0'
   
}

修改Retrofit初始化的代碼:

public class NetWork {
    private static Retrofit retrofit;
  
    /**返回Retrofit*/
    public static Retrofit getRetrofit(){
        if(retrofit==null){
            //創(chuàng)建Retrfit構(gòu)建器
            Retrofit.Builder builder = new Retrofit.Builder();
            //指定網(wǎng)絡(luò)請求的baseUrl
            retrofit = builder.baseUrl("http://apis.juhe.cn/")
                    //返回的數(shù)據(jù)通過Gson解析
                    .addConverterFactory(GsonConverterFactory.create())
                    //使用RxJava模式
                    .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
        }
        return retrofit;
    }
}

上面代碼我們通過,添加代碼addCallAdapterFactory(RxJavaCallAdapterFactory.create())就變成了使用RxJava模式絮宁。

接口也需要修改,把方法的返回值類型由Call改成了RxJava中的Observable梆暮。

public interface NetInterface {
    //獲取號碼歸屬地,返回來類型是Bean, 需要兩個參數(shù)分別為phone何key
    @GET("mobile/get")
    Observable<Bean> getAddress(@Query("phone") String phone, @Query("key") String key);
}

接下來修改最終網(wǎng)絡(luò)請求的代碼绍昂,可以改成RxJava方式了啦粹。

  NetInterface netInterface = NetWork.getRetrofit().create(NetInterface.class);
    //RxJava方式
    netInterface.getAddress(editText.getText().toString(),"你的app key")
            .subscribeOn(Schedulers.io())//設(shè)置網(wǎng)絡(luò)請求在子線程中
            .observeOn(AndroidSchedulers.mainThread())// 回調(diào)在主線程中
            .subscribe(new Action1<Bean>() {
                @Override
                public void call(Bean bean) {
                    //請求成功
                }
            }, new Action1<Throwable>() {
                @Override
                public void call(Throwable throwable) {
                    //請求失敗
                }
            });

總結(jié)

這是Retrofit基礎(chǔ)篇偿荷, 后面有時間再繼續(xù)深入研究

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市唠椭,隨后出現(xiàn)的幾起案子跳纳,更是在濱河造成了極大的恐慌,老刑警劉巖贪嫂,帶你破解...
    沈念sama閱讀 216,692評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件寺庄,死亡現(xiàn)場離奇詭異,居然都是意外死亡力崇,警方通過查閱死者的電腦和手機斗塘,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,482評論 3 392
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來亮靴,“玉大人馍盟,你說我怎么就攤上這事√ê铮” “怎么了朽合?”我有些...
    開封第一講書人閱讀 162,995評論 0 353
  • 文/不壞的土叔 我叫張陵,是天一觀的道長饱狂。 經(jīng)常有香客問我曹步,道長,這世上最難降的妖魔是什么休讳? 我笑而不...
    開封第一講書人閱讀 58,223評論 1 292
  • 正文 為了忘掉前任讲婚,我火速辦了婚禮,結(jié)果婚禮上俊柔,老公的妹妹穿的比我還像新娘筹麸。我一直安慰自己,他們只是感情好雏婶,可當(dāng)我...
    茶點故事閱讀 67,245評論 6 388
  • 文/花漫 我一把揭開白布物赶。 她就那樣靜靜地躺著,像睡著了一般留晚。 火紅的嫁衣襯著肌膚如雪酵紫。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,208評論 1 299
  • 那天错维,我揣著相機與錄音奖地,去河邊找鬼。 笑死赋焕,一個胖子當(dāng)著我的面吹牛参歹,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播隆判,決...
    沈念sama閱讀 40,091評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼犬庇,長吁一口氣:“原來是場噩夢啊……” “哼僧界!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起臭挽,我...
    開封第一講書人閱讀 38,929評論 0 274
  • 序言:老撾萬榮一對情侶失蹤捎泻,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后埋哟,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體笆豁,經(jīng)...
    沈念sama閱讀 45,346評論 1 311
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,570評論 2 333
  • 正文 我和宋清朗相戀三年赤赊,在試婚紗的時候發(fā)現(xiàn)自己被綠了闯狱。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 39,739評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡抛计,死狀恐怖哄孤,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情吹截,我是刑警寧澤瘦陈,帶...
    沈念sama閱讀 35,437評論 5 344
  • 正文 年R本政府宣布,位于F島的核電站波俄,受9級特大地震影響晨逝,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜懦铺,卻給世界環(huán)境...
    茶點故事閱讀 41,037評論 3 326
  • 文/蒙蒙 一捉貌、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧冬念,春花似錦趁窃、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,677評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至裆针,卻和暖如春刨摩,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背据块。 一陣腳步聲響...
    開封第一講書人閱讀 32,833評論 1 269
  • 我被黑心中介騙來泰國打工码邻, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留折剃,地道東北人另假。 一個月前我還...
    沈念sama閱讀 47,760評論 2 369
  • 正文 我出身青樓,卻偏偏與公主長得像怕犁,于是被迫代替她去往敵國和親边篮。 傳聞我的和親對象是個殘疾皇子己莺,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,647評論 2 354

推薦閱讀更多精彩內(nèi)容

  • 本博客為作者原創(chuàng),如需轉(zhuǎn)載請注明原博客出處:WONDER'TWO 0X00 寫在前面 相信做過And...
    一只酸奶牛哇閱讀 4,361評論 9 34
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,081評論 25 707
  • 前段時間看了RxJava戈轿,發(fā)現(xiàn)跟他一起用的Retrofit凌受,今天就把認(rèn)識的他們倆個來總結(jié)梳理一下 一、什么是RxJ...
    毹毹閱讀 671評論 0 5
  • Retrofit 實際上并不能說是一個網(wǎng)絡(luò)請求框架思杯,它其實是對 okHttp 這個網(wǎng)絡(luò)請求框架在接口層面的封裝胜蛉,網(wǎng)...
    EmanLu閱讀 1,041評論 0 2
  • 猖狂過 才知靜默的舒心 自大過 才懂謙虛的好處 孤獨過 才知獨處的收獲 自我過 才知融入的歡樂 天下熙熙 皆為利來...
    三腳貓WW閱讀 388評論 0 0