android Retrofit2網絡請求封裝介紹

Posted on by

1. Retrofit使用

Retrofit是一個現在網絡請求框架，先來說一下怎麼使用

網絡權限（添加到AndroidManifest.xml）

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

gradle依賴（添加到build.gradle）

    implementation("com.squareup.okhttp3:okhttp:4.9.2")
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
    implementation 'com.squareup.retrofit2:converter-scalars:2.9.0'

定義接口,網絡請求的方法

public interface Request {
 
    @GET("/xx/xx")
    Call<ResponseBody> get();
 
}

實例化Retrofit

Retrofit retrofit = new Retrofit.Builder().baseUrl("BASE_URL").build();

通過Retrofit實例創建接口服務對象

Request request = retrofit.create(Request.class);

調用接口中的方法

Call<ResponseBody> call = request.get();

執行異步請求（同步請求需要創建一個新的線程去執行）

call.enqueue(new retrofit2.Callback<ResponseBody>() {
            @Override
            public void onResponse(retrofit2.Call<ResponseBody> call, retrofit2.Response<ResponseBody> response) {
 
            }
 
            @Override
            public void onFailure(retrofit2.Call<ResponseBody> call, Throwable t) {
 
            }
});

2. Retrofit封裝

以上可以看出Retrofit是個好東西，可是用起來是比較麻煩的，所有在實際使用中對Retrofit進行一下小小的封裝是很有必要的。

定義接口（所有的請求參數都是以map的形式）

public interface Request {
 
    /**
     * 不帶參數的get請求
     * @param url
     * @return
     */
    @GET()
    Call<ResponseBody> get(@Url String url);
 
    /**
     * 帶參數的get請求
     * @param url
     * @param map 參數默認是map
     * @return
     */
    @GET()
    Call<ResponseBody> get(@Url String url, @QueryMap Map<String,String> map);
 
    /**
     * 不帶參數的post請求
     * @param url
     * @return
     */
    @POST()
    Call<ResponseBody> post(@Url String url);
 
    /**
     * 帶參數的post請求
     * @param url
     * @param map
     * @return
     */
    @POST()
    @FormUrlEncoded
    Call<ResponseBody> post(@Url String url, @FieldMap Map<String,String> map);
 
    
}

定義RetrofitManager，以單例模式獲取Retrofit實例

public enum RetrofitManager {
 
    /**
     * RetrofitManager的實例
     */
    INSTANCE;
 
    /**
     *
     * 後端接口的baseUrl，且隻考慮一個url的情況（ip+端口，或者域名）
     */
    private static final String BASE_URL = " Your BASE_URL";
 
    private Retrofit retrofit;
 
    /**
     * 返回Retrofit實例，不添加轉換器
     * @return
     */
    public Retrofit getRetrofit(){
        if(retrofit == null){
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .build();
        }
        return retrofit;
    }
}

自定義的RetrofitCallback,在發送請求時，通過匿名對象作為參數獲取後端的響應結果。

public abstract class RetrofitCallback {
 
 
    /**
     * 開始執行的方法
     */
    public void onStart(){
        //開啟loading
    }
 
    /**
     * 結束執行的方法
     */
    public void onCompleted(){
        //關閉loading
    }
 
    /**
     * 執行成功
     * @param resultJsonString  返回的json字符串
     */
    public abstract void onSuccess(String resultJsonString);
 
    /**
     * 失敗
     * @param t 異常
     */
    public abstract void onError(Throwable t);
 
    /**
     * 提示：服務異常
     */
    public void serverErrMsg(){
        //xxx
    }
 
    /**
     * 提示：請求失敗
     */
    public void reqErrMsg(){
        //xxx
    }
 
 
    /**
     * 提示：成功
     */
    public void okMsg(){
        //xxx
    }
 
}

定義RetrofitUtil,封裝get和post方法。將RetrofitCallback作為請求參數，在發送請求時重寫onSuccess和onError方法，執行具體的操作。

public class RetrofitUtil {
 
    private Retrofit(){}
 
    /**
     * 無參的get請求
     * @param url
     * @param callback
     */
    public static void get(String url, RetrofitCallback callback){
        sendRequest(getRequest().get(url),callback);
    }
 
    /**
     * 有參的get請求
     * @param url  請求的url
     * @param map  參數
     * @param callback  請求結束的回調
     */
    public static void get(String url, Map<String,String> map, RetrofitCallback callback){
        sendRequest(getRequest().get(url,map),callback);
    }
 
    /**
     * 無參的post請求
     * @param url
     * @param callback
     */
    public static void post(String url, RetrofitCallback callback){
        sendRequest(getRequest().post(url), callback);
    }
 
    /**
     * 有參的post請求
     * @param url
     * @param map
     * @param callback
     */
    public static void post(String url, Map<String,String> map, RetrofitCallback callback){
        sendRequest(getRequest().post(url,map), callback);
    }
 
 
    /**
     * 獲取Request實例
     * @return
     */
    private static Request getRequest(){
        Retrofit retrofit = RetrofitManager.INSTANCE.getRetrofit();
        return retrofit.create(Request.class);
    }
 
    /**
     * 發送請求的共通方法，並對響應結果進行處理
     * @param call
     * @param callback 自定義的Callback
     */
    private void sendRequest(Call<ResponseBody> call,RetrofitCallback callback){
 
        //開啟loading
        callback.onStart();
        //異步請求
        call.enqueue(new Callback<ResponseBody>() {
            @Override
            public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
                //關閉loading
                callback.onCompleted();
                if(response.isSuccessful()){
                    //執行RetrofitCallback的onSuccess方法，獲取響應結果的json字符串
                    try {
                        String result = response.body().string();
                        callback.onSuccess(result);
                        //響應成功
                        if(StringUtils.equals(result, Constant.SUCCESS)){
                            callback.okMsg();
                        }
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                }else{
                    //服務異常
                    callback.serverErrMsg();
                }
            }
 
            @Override
            public void onFailure(Call<ResponseBody> call, Throwable t) {
                callback.onCompleted();
                //請求失敗
                callback.onError(t);
 
                callback.reqErrMsg();
               }
            }
        });
    }
}

3. RetrofitUtil使用

get無參請求

RetrofitUtil.get("/xx/xx", new RetrofitCallback() {
    @Override
    public void onSuccess(String resultJsonString) {
                
    }
 
    @Override
    public void onError(Throwable t) {
 
    }
});

get有參請求

Map<String,String> map = new HashMap<>(16);
map.put("key","value");
//xxx
RetrofitUtil.get("/xx/xx", map,new RetrofitCallback() {
    @Override
    public void onSuccess(String resultJsonString) {
        xxxx
    }
 
    @Override
    public void onError(Throwable t) {
        xxxx
    }
});

post請求和get的使用方法相似

最後

本次隻對get和post進行瞭封裝，項目中隻用到瞭這些就沒有對文件上傳下載以及別的請求方式進行封裝。且沒有添加轉換器，可在RetrofitManager的getRetrofit()方法中自行添加。大概的封裝思路就是這樣的，可以自行發揮。

此文也隻是在記錄項目中對Retrofit的使用，對Retrofit的原理並沒有較深的瞭解。

到此這篇關於android Retrofit2網絡請求封裝介紹的文章就介紹到這瞭,更多相關android Retrofit2網絡封裝內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：