Retrofit項目封裝使用

歡迎大家訪問我的博客:博客地址

概述

  1. Retrofit開源項目地址
  2. Retrofit項目官網(wǎng)

官網(wǎng)上有它的一系列基本用法，以及他的介紹：A type-safe HTTP client for Android and Java，它和Okhttp一樣都是square公司的開源項目。

RESTful Api：

看下面設(shè)計的三個刪除評論的 api

http://test.net/?method=comment.del&id=x ①

http://test.net/comment/del/id/x ②

而 RESTful Api 則是：

[DELETE] http://test.net/comments/1 ③

我們對比可以發(fā)現(xiàn)①和② URL 中，都有del的動作指示。

SOAP Web API采用RPC風(fēng)格，它采用面向功能的架構(gòu)，所以我們在設(shè)計SOAP Web API的時候首相考慮的是應(yīng)高提供怎樣的功能（或者操作）。而 RESTful Api 是面向資源的架構(gòu)。是查詢、新增、修改、刪除，都與該資源無關(guān)。

RESTful Api 是以 HTTP 協(xié)議為強烈依托的，將類似于①和②這種以功能為主導(dǎo)的URL風(fēng)格舍棄，還原 URL 的本質(zhì)，它的宗旨就是一個 URL 就應(yīng)該是一個資源，不能包含任何動作，如下所示：

- [POST]     http://test.net/users   // 新增
- [GET]      http://test.net/users/1 // 查詢
- [PATCH]    http://test.net/users/1 // 更新
- [PUT]      http://test.net/users/1 // 覆蓋，全部更新
- [DELETE]   http://test.net/users/1 // 刪除

url的簡單構(gòu)成

構(gòu)成一般是這樣的：[scheme:][//authority][path][?query]

看下面一個url：

http://www.java2s.com:8080/yourpath/fileName.htm?stove=10&path=32&id=4

  • scheme: http

  • authority: www.java2s.com:8080

  • path: /yourpath/fileName.htm

  • query:在？后的部分為：stove=10&path=32&id=4

  • 又由于authority又一步可以劃分為host:port形式，其中host:port用冒號分隔，冒號前的是host，冒號后的是port，所以：

    host:www.java2s.com

    port:8080

這里是url中的參數(shù)，除了url中的參數(shù)還有兩個http協(xié)議中常用參數(shù)是：header（請求頭）和body（常用于post請求中的請求體，有多種封裝方法，不暴露在url中）這兩個參數(shù)。

可以看出整個網(wǎng)絡(luò)請求中參數(shù)主要可以分成：scheme、authority、path、query、header、body這六塊，下面主要看下Retrofit怎么配置這六塊參數(shù)的。

Retrofit參數(shù)配置

scheme和authority

在retrofit中將這兩者合體稱為baseurl，接口用法如下：

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

header

  • 靜態(tài)header（分為單個鍵值對和多個鍵值對兩種注解方式）：

單個鍵值對注解：

@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);
  • 動態(tài)header（分為局部動態(tài)header和全局動態(tài)header）

局部動態(tài)header（分為單個鍵值對header和多個鍵值對header）：

單個鍵值對局部動態(tài)header：

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

多個鍵值對局部動態(tài)header（retrofit:2.1.0新加的）：

@GET("user")
Call<User> getUser(@HeaderMap Map<String, String> headerMap)

全局動態(tài)header（適用于項目中的header規(guī)則一致的情況）

這里是用了 OkHttp的interceptor：

private static void initHttpClient() {
        OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder();
        if (httpClientBuilder.interceptors() != null) {
            httpClientBuilder.interceptors().clear();
        }
        httpClientBuilder.addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
            
                //這里可以獲取到請求的request所有數(shù)據(jù)
                Request request = chain.request();
                String path = request.url().encodedPath();
                Log.d("AppClient", path + ">>>path");
                String query = request.url().query();
                if (BuildConfig.DEBUG){
                    Log.d("AppClient", query + ">>>query");
                }
                //這里設(shè)置成你的全局header
                Request interRequest = chain.request().newBuilder()
                        .headers(Headers.of(Map yourHeader))
                        .build();
                return chain.proceed(interRequest);
            }
        })
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS);
        
        mOkHttpClient = httpClientBuilder.build();
    }

path

這里只看下GET請求，POST, PUT, DELETE請求一樣處理

這里分為帶參數(shù)和不帶參數(shù)兩種：

  1. 不帶參數(shù)的：
@GET("widget/list")
Call<List<Widget>> widgetList();
  1. 帶參數(shù)的：
@GET("users/{user}/repos")
Call<List<Repo>> listRepos(@Path("user") String user);

這里是通過@Path("user")注解實現(xiàn)參數(shù)傳遞。

query

以GET請求為例提供了兩種注解方式（單個鍵值對和多個鍵值對），如下：

單個鍵值對：

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @Query("sort") String sort);

多個鍵值對：

@GET("group/{id}/users")
Call<List<User>> groupList(@Path("id") int groupId, @QueryMap Map<String, String> options);

body

用于POST請求中：

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

Retrofit請求簡單封裝

寫在前面：Retrofit中網(wǎng)絡(luò)請求實際上用的還是他自家的OkHttp，所以如果要配置請求的一些全局參數(shù)還是得先創(chuàng)建一個OkHttp的實例對象，然后一一配置，上面講了配置全局header也是這樣處理的，所以這里我將其使用分成了三步：

這里首先要配三個庫（retrofit庫，json轉(zhuǎn)化庫，log的截斷器庫）：

compile 'com.squareup.retrofit2:retrofit:2.1.0'
compile 'com.squareup.retrofit2:converter-gson:2.1.0'
compile 'com.squareup.okhttp3:logging-interceptor:3.4.0-RC1'
  1. 構(gòu)建OkHttpClient實例（配置一些請求的全局參數(shù)）：
 private static void initHttpClient() {
        OkHttpClient.Builder httpClientBuilder = new OkHttpClient.Builder();
        httpClientBuilder.hostnameVerifier(new HostnameVerifier() {
            @Override
            public boolean verify(String hostname, SSLSession session) {
                return true;
            }
        });
        //處理攔截器，主要是做了個header和連接超時、讀取超時設(shè)置，我項目里header放了些簽名信息，主要是這里能拿到整個請求的所有參數(shù)，做任何想做的事，而且是全局動態(tài)處理
        if (httpClientBuilder.interceptors() != null) {
            httpClientBuilder.interceptors().clear();
        }
        httpClientBuilder.addInterceptor(new Interceptor() {
            @Override
            public Response intercept(Chain chain) throws IOException {
                Request request = chain.request();
                String path = request.url().encodedPath();
                Log.d("AppClient", path + ">>>path");
                String query = request.url().query();
                if (BuildConfig.DEBUG){
                    Log.d("AppClient", query + ">>>query");
                }
                Map<String, Object> queryParam = null;
                if (query != null){
                    queryParam = new HashMap();
                    String queryEntries[] = query.split("&");
                    for (int i = 0; i < queryEntries.length; i ++){
                        queryParam.put(queryEntries[i].split("=")[0], queryEntries[i].split("=")[1]);
                    }
                }
                if (BuildConfig.DEBUG){
                    Log.d("AppClient", "queryParam:" + queryParam + ">>>queryParam");
                }
                String signature = makeSignature_v3(path, queryParam);

                Request interRequest = chain.request().newBuilder()
                        .headers(Headers.of(getHeaders(signature)))
                        .build();
                return chain.proceed(interRequest);
            }
        })
                .connectTimeout(10, TimeUnit.SECONDS)
                .readTimeout(10, TimeUnit.SECONDS);
         //在debug模式下我使用了一個他家公司的一個log攔截器
        if (BuildConfig.DEBUG) {
            HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
            httpClientBuilder.addInterceptor(loggingInterceptor);
        }
        //通過build模式構(gòu)建實例
        mOkHttpClient = httpClientBuilder.build();
    }

這里做了四件事：

  • httpClientBuilder.hostnameVerifier這里是針對我公司的Https證書問題，詳情看這里：https證書問題

  • 通過攔截器設(shè)置header，可以看上面參數(shù)設(shè)置那里的講解

  • 設(shè)置請求超時時間和讀取數(shù)據(jù)時間

.connectTimeout(10, TimeUnit.SECONDS)
.readTimeout(10, TimeUnit.SECONDS);
  • 設(shè)置log攔截器，這里設(shè)置之后可以在logcat中看到每個網(wǎng)絡(luò)請求的請求參數(shù)和返回結(jié)果以及請求時長，非常好用，當(dāng)然先要配置下上面我配置的第三個庫；
  1. 構(gòu)建retrofit實例：
public static Retrofit retrofit() {
        if (mRetrofit == null) {
            initHttpClient();
            mRetrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .client(mOkHttpClient)
                    .addConverterFactory(GsonConverterFactory.create())                 .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                    .build();
        }
        return mRetrofit;
    }

這里配置可以看出，Retrofit內(nèi)部也是封了一個Okhttp的實例，這里做了四件事：

  • 設(shè)置了baseurl參數(shù)，可以看我上面參數(shù)配置的講解；

  • 設(shè)置了OkHttpClient實例；

  • gson轉(zhuǎn)化工廠：addConverterFactory(GsonConverterFactory.create())，這里Retrofit內(nèi)部會根據(jù)這個轉(zhuǎn)換工廠及返回數(shù)據(jù)所指定的泛型實現(xiàn)直接轉(zhuǎn)換；

  • 網(wǎng)絡(luò)請求的適配器工廠：addCallAdapterFactory(RxJavaCallAdapterFactory.create())，這個可以忽略暫時，因為我項目里使用了RXjava和Retrofit，后續(xù)我會寫一篇MVP+RXjava+Retrofit的封裝使用

  1. 構(gòu)建call，開始網(wǎng)絡(luò)請求并實現(xiàn)回調(diào)：

這里先要配置請求參數(shù)，我封了個類專門用來設(shè)置請求接口：

public interface ApiStores {
    //POST登錄
    String RES_USERS_LOGIN = "users/login";
    //POST注冊
    String RES_USERS_REGISTER = "users";

    @POST(RES_USERS_LOGIN)
    Observable<Map> login(@Body Map<String, String> body);
    
    @POST(RES_USERS_REGISTER)
    Observable<Map> register(@Body Map<String, String> body);

}

構(gòu)建call實例對象，開始網(wǎng)絡(luò)請求并實現(xiàn)回調(diào)：

public void login(String cityId, final String cityName, final String mobile, String password, final OnLoginListener listener) {
        Map<String, String> body = new HashMap<>();
        body.put("mobile", mobile);
        body.put("password", password);
        body.put("city", cityId);
        body.put("embed", "home");       
        ApiStores apiStores = AppClient.retrofit().create(ApiStores.class);
        //這里通過指定Map泛型集合上面的Gson轉(zhuǎn)換工廠實現(xiàn)返回數(shù)據(jù)json轉(zhuǎn)換成Map
        Call<Map> call = apiStores.login(body);
        call.enqueue(new Callback<Map>() {
            @Override
            public void onResponse(Call<Map> call, Response<Map> response) {
                //請求成功做的事情，這里兩個參數(shù)：call是請求時候的call實例，可以拿到請求的request實例，response是服務(wù)端返回的參數(shù)，里面包含了code和body(這里的body類型是通過call指定的泛型和Gson轉(zhuǎn)換工廠實現(xiàn)的)，message一系列數(shù)據(jù)。
            }

            @Override
            public void onFailure(Call<Map> call, Throwable t) {
                //請求失敗做的事情，call和上面一樣，外加一個Throwable
            }
        });

小結(jié)

Retrofit這個庫將ResfulApi的幾種請求都通過注解進行了一系列封裝，整個請求流程比OkHttp簡潔了很多，同時它可以通過設(shè)置GSON轉(zhuǎn)換工廠內(nèi)部實現(xiàn)返回數(shù)據(jù)的轉(zhuǎn)化，使用過程非常簡潔清晰，同時可以配合現(xiàn)在流行的RXjava一起使用，下面我準備搞一篇MVP+RX+Retrofit的封裝使用，Okhttp可以換啦！

具體代碼請看我的github:Android練習(xí)小項目

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 179,230評論 25贊 708
  • 準備工作 1. 了解RESTful Api： 看下面設(shè)計的三個刪除評論的 api http://test.net/...
    jacky123閱讀 305評論 0贊 0
  • 整體Retrofit內(nèi)容如下： 1、Retrofit解析1之前哨站——理解RESTful2、Retrofit解析2...
    隔壁老李頭閱讀 15,406評論 4贊 39
  • #微寫作#004 原來反思要從每一件小事做起，我們的任何一個舉動都是我們想法的直接感受從而造成的直接做法。那些我們...
    曉茜自留地閱讀 683評論 0贊 0
  • 測試的時候可以看看你的咪咪好大了嗎老婆我好想你我好想你好想你們都在睡覺嗎哦你現(xiàn)在是不是覺得
    香香豬_3862閱讀 53評論 0贊 0

友情鏈接更多精彩內(nèi)容