Retrofit的優點
- 可以配置不同HTTP client來實現網絡請求，如okhttp、httpclient等
- 將接口的定義與使用分離開來，實現結構。
- 支持多種返回數據解析的Converter可以快速進行數據轉換。
- 和RxJava集成的很好
- 因為容易和RxJava結合使用，所以對於異步請求，同步請求也不需要做額外的工作。
- Retrofit是基於OKHttp
簡單使用
配置依賴
在module的build.gradle中添加
// Retrofit api "com.squareup.retrofit2:retrofit:2.3.0" api "com.squareup.retrofit2:converter-gson:2.3.0" api "com.squareup.retrofit2:adapter-rxjava2:2.3.0" // OkHttp3 api "com.squareup.okhttp3:okhttp:3.10.0" api "com.squareup.okhttp3:logging-interceptor:3.10.0" // RxJava2 api "io.reactivex.rxjava2:rxjava:2.1.9" api "io.reactivex.rxjava2:rxandroid:2.0.2" // RxLifecycle api "com.trello.rxlifecycle2:rxlifecycle:2.2.1" api "com.trello.rxlifecycle2:rxlifecycle-android:2.2.1" api "com.trello.rxlifecycle2:rxlifecycle-components:2.2.1" 定義Retrofit單例
在Application中初始化Retrofit，因為一個Retrofit對象本身就包含一個線程池，所以我們可以初始化一個Retrofit對象，並將其做成一個全局單例對象
/** * Retrofit單例管理 * Created by Leon.W on 2019/4/28 */ public class RetrofitManager { private final String BASE_URL = "https://api.github.com"; private static RetrofitManager sInstance; private Retrofit mRetrofit; public static RetrofitManager getInstance() { if (null == sInstance) { synchronized (RetrofitManager.class) { if (null == sInstance) { sInstance = new RetrofitManager(); } } } return sInstance; } public void init() { if(mRetrofit == null) { //初始化一個OkHttpClient OkHttpClient.Builder builder = new OkHttpClient.Builder() .connectTimeout(30000, TimeUnit.MILLISECONDS) .readTimeout(30000, TimeUnit.MILLISECONDS) .writeTimeout(30000, TimeUnit.MILLISECONDS); builder.addInterceptor(new LoggingInterceptor()); OkHttpClient okHttpClient = builder.build(); //使用該OkHttpClient創建一個Retrofit對象 mRetrofit = new Retrofit.Builder() //添加Gson數據格式轉換器支持 .addConverterFactory(GsonConverterFactory.create()) //添加RxJava語言支持 .addCallAdapterFactory(RxJava2CallAdapterFactory.create()) //指定網絡請求client .client(okHttpClient) .baseUrl(BASE_URL) .build(); } } public Retrofit getRetrofit() { if(mRetrofit == null) { throw new IllegalStateException("Retrofit instance hasn't init!"); } return mRetrofit; } } 定義ApiService
//ApiService.java public interface ApiService { @GET("/TP_S/BookList") Observable<JsonArrayBase<Book>> queryBookList(); } 定義接口方法實現方法
//GithubAPI.java public class GithubAPI { Observable<GithubUserInfo> queryJakeWhartonInfo() { return RetrofitManager.getInstance().getRetrofit() //動態代理創建GithubAPI對象 .create(ApiService.class) .queryJakeWhartonInfo() //指定上游發送事件線程 .subscribeOn(Schedulers.computation()) //指定下游接收事件線程 .observeOn(AndroidSchedulers.mainThread()); } } 定義返回數據實體類
public class GithubUserInfo { String login,url,name,company; int id,public_repos,followers; @Override public String toString() { return "GithubUserInfo{" + "login='" + login + '\'' + ", url='" + url + '\'' + ", name='" + name + '\'' + ", company='" + company + '\'' + ", id=" + id + ", public_repos=" + public_repos + ", followers=" + followers + '}'; } } 調用接口
new GithubAPI().queryJakeWhartonInfo().subscribe(new Observer<GithubUserInfo>() { @Override public void onSubscribe(Disposable d) { } @Override public void onNext(GithubUserInfo githubUserInfo) { Log.d(TAG,githubUserInfo.toString()); } @Override public void onError(Throwable e) { e.printStackTrace(); Log.e(TAG,e.getMessage()); } @Override public void onComplete() { } }); >>>輸出： D/TestRetrofit: GithubUserInfo{login='JakeWharton', url='https://api.github.com/users/JakeWharton', name='Jake Wharton', company='Google, Inc.', id=66577, public_repos=102, followers=52467} 異常處理
請求過程中的異常一般分為2種類型，一種是類似網絡異常、服務器這種環境問題；另一種比如請求參數錯誤、登錄超時、Token失效等異常。分別做如下處理
環境問題
環境異常諸如404、500、502等服務器狀態異常，或者設備本身網路異常造成的，這種時候的Exception會在onError方法中得到響應。
數據問題
數據問題諸如請求參數異常、對象為空、登錄超時等數據相關異常，這種情況Response還是會走onNext方法，只是我們需要在里面根據自定義的code，來處理各種數據異常。
下面是一個具體的基礎Observer類，在其onNext中解析
一般服務器接口返回數據會約定一個簡單的格式：
{ code:int, msg:String, data:{} //可能是對象，有可能是數組data:[] } 對應的建議解析類，一般當接口返回先解析其code是否為成功，如果不是，那看看是否是特定的錯誤碼，把錯誤碼code和錯誤信息msg包裝成一個自定義的Exception進行處理。如果成功，則對返回結果進行進一步的解析，針對不同的接口解析成“對象”或者“數組”。
//JsonBase.java，解析code和msg public class JsonBase implements Serializable{ private static final long serialVersionUID = -6182189632617616248L; @SerializedName("msg") private String msg; private int code = -1; public int getCode() { return code; } public void setCode(int code) { this.code = code; } public String getMsg() { return msg; } public void setMsg(String msg) { this.msg = msg; } } //JsonArrayBase.java，解析數組類型 public class JsonArrayBase<T> extends JsonBase { @SerializedName("data") List<T> data; public List<T> getData() { return data; } public void setData(List<T> data) { this.data = data; } @Override public String toString() { StringBuilder sb = new StringBuilder(); for(int i = 0; i< data.size(); i++) { sb.append(data.get(i).toString()); } return sb.toString(); } } //JsonObjBase.java，解析對象類型 public class JsonObjBase<T> extends JsonBase { @SerializedName("data") T data; public T getData() { return data; } public void setData(T data) { this.data = data; } } 基礎Observer，用於處理數據異常(即code不是SUCC的情況)；網絡異常(在onError方法中進行toast提示)，具體使用界面可以通過重寫onError來得到回調(比如分頁加載失敗，需要隱藏加載進度條，此時需要得到失敗回調)
//BaseObserver.java public abstract class BaseObserver<T> implements Observer<T> { private String TAG = "BaseObserver"; @Override public void onNext(T t) { if (t == null) { onError(HttpCode.ERROR_EMPTY_OBJ, getErrorMessage(HttpCode.ERROR_EMPTY_OBJ)); } else { onSuccess(t); } } /** * 外部想要處理異常(比如分頁加載失敗，需要隱藏加載中效果)時，可以重寫該方法 */ public void onError(int errorCode, String message) { } /** * 外部重寫，接受數據 * @param t */ public abstract void onSuccess(T t); /** * 不顯示服務器返回錯誤信息(部分接口返回不規范) */ public boolean isShowErrorToast() { return true; } @Override public void onError(Throwable e) { int errorCode = -1; String errMsg = ""; //自定義異常 if (e instanceof MyException) { MyException exception = (MyException) e; errorCode = exception.getErrorCode(); errMsg = exception.getMessage(); handleIybErrorCode(errorCode); if (isShowErrorToast()) { Toast.makeText(TestAPP.getInstance().getApplicationContext(), errMsg,Toast.LENGTH_LONG).show(); } } else if (e instanceof NullPointerException) { // RxJava2 發送值為null時，不執行 onNext，直接走 onError errorCode = HttpCode.ERROR_EMPTY_OBJ; errMsg = getErrorMessage(HttpCode.ERROR_EMPTY_OBJ); } else if (e instanceof SocketTimeoutException) { errorCode = HttpCode.ERROR_TIMEOUT; errMsg = getErrorMessage(HttpCode.ERROR_TIMEOUT); Toast.makeText(TestAPP.getInstance().getApplicationContext(), errMsg,Toast.LENGTH_LONG).show(); } else if (e instanceof NetworkErrorException) { errorCode = HttpCode.ERROR_NETWORK; errMsg = getErrorMessage(HttpCode.ERROR_NETWORK