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);

Retrofit的优点

Retrofit的优点

简单使用

配置依赖

定义Retrofit单例

定义ApiService

定义接口方法实现方法

定义返回数据实体类

调用接口

异常处理

环境问题

数据问题

相关推荐