Retrofit

一:簡介

Retrofit是Square公司開發(fā)的一款針對Android網(wǎng)絡(luò)請求的框架怎棱,Retrofit2底層基于OkHttp實現(xiàn)的,OkHttp現(xiàn)在已經(jīng)得到Google官方認可猪勇,大量的app都采用OkHttp做網(wǎng)絡(luò)請求,其源碼詳見OkHttp Github

二:retrofit 的簡單封裝

  • 1: 在具體介紹retrofit的用法之前膀值,gradle配置(具體版本號參見官網(wǎng))
   compile 'com.squareup.retrofit2:retrofit:2.2.0'
    compile 'com.squareup.retrofit2:converter-gson:2.2.0'
    compile 'com.squareup.okhttp3:logging-interceptor:3.6.0'
    compile 'com.squareup.okhttp3:okhttp-urlconnection:3.2.0'

  • 2:這里有必要對baseUrl坐下解釋桶唐,baseurl必須是以“/"結(jié)尾的创橄,在我們定義請求的接口時,會傳入具體的地址莽红,retrofit會幫助我們完成拼接妥畏,最后形成完整url。


/**
 * Created by Administrator on 2017/3/16.
 */

public class AppClient {
    static Retrofit mRetrofit;

    public static Retrofit retrofit() {
        if (mRetrofit == null) {
            /*
            * 設(shè)置cookie
            * */
            OkHttpClient.Builder builder = new OkHttpClient.Builder();
            CookieManager cookieManager = new CookieManager();
            cookieManager.setCookiePolicy(CookiePolicy.ACCEPT_ALL);
            builder.cookieJar(new JavaNetCookieJar(cookieManager))
                    .connectTimeout(30, TimeUnit.SECONDS) //設(shè)置超時  
                    .readTimeout(30, TimeUnit.SECONDS)
                    .writeTimeout(30, TimeUnit.SECONDS)
                    .retryOnConnectionFailure(true)////失敗重連
                    .addNetworkInterceptor(new Interceptor() {   //有無網(wǎng)絡(luò)都走緩存
                    @Override
                    public Response intercept(Chain chain) throws IOException {
                        Response originalResponse = chain.proceed(chain.request());
                        return originalResponse.newBuilder().build();
                    }
                });

 try {
            // Create a trust manager that does not validate certificate chains
            final TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() {
                @Override
                public void checkClientTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public void checkServerTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public java.security.cert.X509Certificate[] getAcceptedIssuers() {
                    return new java.security.cert.X509Certificate[0];
                }
            }};
            // Install the all-trusting trust manager
            final SSLContext sslContext = SSLContext.getInstance("TLS");
            sslContext.init(null, trustAllCerts, new java.security.SecureRandom());
            // Create an ssl socket factory with our all-trusting manager
            final SSLSocketFactory sslSocketFactory = sslContext.getSocketFactory();

            builder.sslSocketFactory(sslSocketFactory).hostnameVerifier(org.apache.http.conn.ssl.SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
        } catch (Exception e) {
            e.printStackTrace();
        } try {
            // Create a trust manager that does not validate certificate chains
            final TrustManager[] trustAllCerts = new TrustManager[]{new X509TrustManager() {
                @Override
                public void checkClientTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public void checkServerTrusted(java.security.cert.X509Certificate[] chain, String authType) throws CertificateException {
                }

                @Override
                public java.security.cert.X509Certificate[] getAcceptedIssuers() {
                    return new java.security.cert.X509Certificate[0];
                }
            }};
            // Install the all-trusting trust manager
            final SSLContext sslContext = SSLContext.getInstance("TLS");
            sslContext.init(null, trustAllCerts, new java.security.SecureRandom());
            // Create an ssl socket factory with our all-trusting manager
            final SSLSocketFactory sslSocketFactory = sslContext.getSocketFactory();

            builder.sslSocketFactory(sslSocketFactory).hostnameVerifier(org.apache.http.conn.ssl.SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);//過濾https請求
        } catch (Exception e) {
            e.printStackTrace();
        }


            if (BuildConfig.DEBUG) {
                // Log信息攔截器
                HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
                    @Override
                    public void log(String message) {
                        TLog.analytics(message);
                    }
                });

                loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
                //設(shè)置 Debug Log 模式
                builder.addInterceptor(loggingInterceptor);
            }


            OkHttpClient okHttpClient = builder.build();
            mRetrofit = new Retrofit.Builder()
                    .client(okHttpClient)// 設(shè)置client對象
                    .baseUrl("http://61.129.70.23:84/EasyRentService.svc/")// baseurl地址
                    .addConverterFactory(GsonConverterFactory.create()) //表示調(diào)用Gson庫來解析json返回值


                    .build();

        }

        return mRetrofit;
    }

    public interface ApiStores {
        /**
         * post請求獲取區(qū)域
         */
        @POST("GetBigZoneInfos")
        @FormUrlEncoded
        Call<AreaBean> requestFansList(@Field("") String str);

        /**
         * json請求
         * @param route
         * @return
         */
        @POST("HourseDetail")
        Call<HouseDetailBean> gethouseDetail(@Body RequestBody route);

        /**
         * get請求
         * @return
         */
        @GET("index")
        Call<GiftBean> getUsers();


    }

}

三:Retrofit 用法實例

(一) :一般的get請求

  • (1) 首先定義一個接口對象,定義請求方法贺归,通過@GET方式表示為get請求汇四, @GET中所填寫的value和baseUrl組成完整的路徑
 public interface ApiStores {
        /**
         * get請求
         * @return
         */
        @GET("index")
        Call<GiftBean> getData();
}
  • 具體點業(yè)務(wù)邏輯代碼
  AppClient.ApiStores apiStores = AppClient.retrofit().create(AppClient.ApiStores.class);
        Call<AreaBean> call = apiStores.getData();
        call.enqueue(new Callback<GiftBean>() {
            @Override
            public void onResponse(Call<GiftBean> call, Response<GiftBean> response) {
                Log.i("MainActivity", "normalGet:" + response.body() + "");

            }

            @Override
            public void onFailure(Call<GiftBean> call, Throwable t) {

            }
        });

2. @Query(當然相同的方式也適用于POST,只需要把注解修改為@POST即可网棍。)

Get方法請求參數(shù)都會以key=value的方式拼接在url后面

/**
*這里需要稍作說明,@GET注解就表示get請求妇智,@Query表示請求參數(shù)滥玷,將會以key=value的方式拼接在url后面
/
public interface BlueService {
   @GET("book/search")
   Call<BookSearchResponse> getSearchBooks(@Query("q") String name, 
        @Query("tag") String tag, @Query("start") int start, 
        @Query("count") int count);
}

此處最后得到的url完整地址為

https://api.douban.com/v2/book/search?q=%E5%B0%8F%E7%8E%8B%E5%AD%90&tag=&start=0&count=3

3. @QueryMap

如果Query參數(shù)比較多氏身,那么可以通過@QueryMap方式將所有的參數(shù)集成在一個Map統(tǒng)一傳遞

public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@QueryMap Map<String, String> options);
}
Map<String, String> options = new HashMap<>();
map.put("q", "小王子");
map.put("tag", null);
map.put("start", "0");
map.put("count", "3");
Call<BookSearchResponse> call = mBlueService.getSearchBooks(options);

4. Query集合

假如你需要添加相同Key值,但是value卻有多個的情況惑畴,一種方式是添加多個@Query參數(shù)蛋欣,還有一種簡便的方式是將所有的value放置在列表中,然后在同一個@Query下完成添加

public interface BlueService {
    @GET("book/search")
    Call<BookSearchResponse> getSearchBooks(@Query("q") List<String> name);
}
最后得到的url地址為

https://api.douban.com/v2/book/search?q=leadership&q=beyond%20feelings

5. @Path

如果請求的相對地址也是需要調(diào)用方傳遞如贷,那么可以使用@Path注解陷虎,示例代碼如下:

@GET("book/{id}")
Call<BookResponse> getBook(@Path("id") String id);

具體代碼

Call<BookResponse> call = mBlueService.getBook("1003078"

此時的url地址為

https://api.douban.com/v2/book/1003078

(二:)Post請求

1. @field(請求參數(shù)比較少)

@POST("oneselfmessage")
    @FormUrlEncoded
    Call<User> login(@Field("uid") String username);

2. @FieldMap

 @FormUrlEncoded
 @POST("book/reviews")
 Call<String> addReviews(@FieldMap Map<String, String> fields);

3. @Body(向服務(wù)器傳入json字符串)

@FormUrlEncoded
@POST("book/reviews")
Call<String> addReviews(@Body Reviews reviews);

public class Reviews {
    public String book;
    public String title;
    public String content;
    public String rating;
}

注意上述向服務(wù)器提交json字符串如果不行的話可以參考如下代碼:

        /**
         * json請求
         * @param route
         * @return
         */
        @POST("HourseDetail")
        Call<HouseDetailBean> gethouseDetail(@Body RequestBody route);

具體代碼

  AppClient.ApiStores apiStores = AppClient.retrofit().create(AppClient.ApiStores.class);
        RequestBody body = RequestBody.create(okhttp3.MediaType.parse("application/json; charset=utf-8"),
                new Gson().toJson(new Enity("30921")));
        Call<HouseDetailBean> call = apiStores.gethouseDetail(body);
        call.enqueue(new Callback<HouseDetailBean>() {
            @Override
            public void onResponse(Call<HouseDetailBean> call, Response<HouseDetailBean> response) {
                Log.i("MainActivity", "房屋詳情:" + response.body() + "");


            }

            @Override
            public void onFailure(Call<HouseDetailBean> call, Throwable t) {
;
            }
        });

其中的enty實例

public class Enity  {
    public String HouseId;

    public Enity(String HouseId) {
        this.HouseId = HouseId;
    }

( 三):上傳

1:單文件上傳@Multipart

 // 上傳單個文件
    @Multipart
    @POST("modifyheadimg")
    Call<BaseBean> uploadFile(
            @Part("uid") RequestBody uid,
            @Part MultipartBody.Part file);
//這里@MultiPart的意思就是允許多個@Part了,第二個我們準備上傳個文件杠袱,使用了MultipartBody.Part類型尚猿,其余兩個均為簡單的鍵值對。

具體上傳代碼如下:

   File file = new File(path);
        RequestBody photoRequestBody = RequestBody.create(MediaType.parse("multipart/form-data"), file);
        MultipartBody.Part photo = MultipartBody.Part.createFormData("img", file.getName(), photoRequestBody); //第一個參數(shù)是上傳文件的key楣富,第二個是文件的名字

        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl("http://114.55.128.82/20160507/Home/Member/")
                .addConverterFactory(GsonConverterFactory.create())
                .build();
        Controller userBiz = retrofit.create(Controller.class);
        Call<BaseBean> call = userBiz.uploadFile(RequestBody.create(null, "10000367"),photo);
        call.enqueue(new Callback<BaseBean>() {
            @Override
            public void onResponse(Call<BaseBean> call, Response<BaseBean> response) {
                Log.i("MainActivity", "=======update========" + response.body() + "");
            }

            @Override
            public void onFailure(Call<BaseBean> call, Throwable t) {
                Log.i("MainActivity", "=======update失敗========" + t + "");

            }
        });

2多文件上傳

 // 上傳多個文件
    @Multipart
    @POST("upload")
    Call<ResponseBody> uploadMultipleFiles(
            @Part("description") RequestBody description,
            @Part MultipartBody.Part file1,
            @Part MultipartBody.Part file2);

具體的實例就不再一一舉例了

(四):下載

        @Streaming
        @GET
        Call<ResponseBody> downloadFile(@Url String url);//假如說你的某一個請求不是以base_url開頭該怎么辦呢凿掂?直接用@Url注解的方式傳遞完整的url地址即可。

具體代碼

Call<ResponseBody> call = userBiz.downloadTest();
call.enqueue(new Callback<ResponseBody>()
{
    @Override
    public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response)
    {
        InputStream is = response.body().byteStream();
        //save file
    }

    @Override
    public void onFailure(Call<ResponseBody> call, Throwable t)
    {

    }
});

(五)okHttp完美支持Https傳輸

http://blog.csdn.net/sk719887916/article/details/51597816

http://blog.csdn.net/duanyy1990/article/details/52139294
http://blog.csdn.net/lmj623565791/article/details/51304204
http://blog.csdn.net/u014695188/article/details/52985514
http://blog.csdn.net/u010286855/article/details/52608485
http://blog.csdn.net/dd864140130/article/details/52625666

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末纹蝴,一起剝皮案震驚了整個濱河市缠劝,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌骗灶,老刑警劉巖惨恭,帶你破解...
    沈念sama閱讀 217,907評論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異耙旦,居然都是意外死亡脱羡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,987評論 3 395
  • 文/潘曉璐 我一進店門免都,熙熙樓的掌柜王于貴愁眉苦臉地迎上來锉罐,“玉大人,你說我怎么就攤上這事绕娘∨Ч妫” “怎么了?”我有些...
    開封第一講書人閱讀 164,298評論 0 354
  • 文/不壞的土叔 我叫張陵险领,是天一觀的道長侨舆。 經(jīng)常有香客問我,道長绢陌,這世上最難降的妖魔是什么挨下? 我笑而不...
    開封第一講書人閱讀 58,586評論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮脐湾,結(jié)果婚禮上臭笆,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好愁铺,可當我...
    茶點故事閱讀 67,633評論 6 392
  • 文/花漫 我一把揭開白布鹰霍。 她就那樣靜靜地躺著,像睡著了一般茵乱。 火紅的嫁衣襯著肌膚如雪茂洒。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,488評論 1 302
  • 那天似将,我揣著相機與錄音获黔,去河邊找鬼蚀苛。 笑死在验,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的堵未。 我是一名探鬼主播腋舌,決...
    沈念sama閱讀 40,275評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼渗蟹!你這毒婦竟也來了块饺?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,176評論 0 276
  • 序言:老撾萬榮一對情侶失蹤雌芽,失蹤者是張志新(化名)和其女友劉穎授艰,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體世落,經(jīng)...
    沈念sama閱讀 45,619評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡淮腾,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,819評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了屉佳。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片谷朝。...
    茶點故事閱讀 39,932評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖武花,靈堂內(nèi)的尸體忽然破棺而出圆凰,到底是詐尸還是另有隱情,我是刑警寧澤体箕,帶...
    沈念sama閱讀 35,655評論 5 346
  • 正文 年R本政府宣布专钉,位于F島的核電站,受9級特大地震影響累铅,放射性物質(zhì)發(fā)生泄漏驶沼。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,265評論 3 329
  • 文/蒙蒙 一争群、第九天 我趴在偏房一處隱蔽的房頂上張望回怜。 院中可真熱鬧,春花似錦、人聲如沸玉雾。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,871評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽复旬。三九已至垦缅,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間驹碍,已是汗流浹背壁涎。 一陣腳步聲響...
    開封第一講書人閱讀 32,994評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留志秃,地道東北人怔球。 一個月前我還...
    沈念sama閱讀 48,095評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像浮还,于是被迫代替她去往敵國和親竟坛。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,884評論 2 354

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