network

基于OkHttp3网络框架

mavenCentral迁移指南

一、依赖导入

项目根目录

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

模块目录

dependencies {
	implementation 'com.github.lavalike:network:0.0.3'
}

二、初始化配置

请在合适的地方进行初始化：

Network.init(NetConfig.Builder().baseUrl(YOUR_BASE_URL).build());

也支持开箱即用，即：忽略初始化配置，但需要在发起请求时指定完整 URL。

NetConfig支持的方法：

public static class Builder {
    public Builder baseUrl(String baseUrl);
    public Builder netInterceptor(Interceptor interceptor);
    public Builder interceptor(Interceptor interceptor);
    public CookieJar cookieJar;
    public Builder retryOnConnectionFailure(boolean retry);
    public Builder connectTimeout(long connectTimeout);
    public Builder readTimeout(long readTimeout);
    public Builder writeTimeout(long writeTimeout);
    public Builder debug(boolean debug);
    public NetConfig build();
}

三、请求类型

类型	继承关系
GET	GetTask
POST_JSON	PostJsonTask
POST_FORM	PostFormTask
UPLOAD	UploadTask

网络请求Task支持方法

public interface Task {
    String getApi();
    Task put(String key, Object value);
    Task putFile(String key, String filePath);
    Task addHeader(String name, String value);
    Task setTag(Object tag);
    Task setLoadingPage(LoadingPage page);
    Call exe();
    Call retry();
}

四、创建请求

4.1 普通请求

传入LoadingCallback即可满足大部分场景。

TestTask(object : LoadingCallback<String>() {
    override fun onSuccess(data: String) {
    
    }
}).exe()

4.2 带进度请求

传入ProgressCallback即可监听请求进度，如：监听文件上传。

TestTask(object : ProgressCallback<String>() {
    override fun onProgress(progress: Int) {
    
    }
    override fun onSuccess(data: String) {
    
    }
}).exe()

4.3 传递参数

方法	说明
put	传入普通参数
putFile	传入文件路径
addHeader	添加请求头

五、设置加载页

setLoadingPage(LoadingPage page)

注意：
需要在LoadingPage中传入有效的布局才能成功显示Loading效果

1、使用默认加载页 DefaultLoadingPage

TestTask(object : LoadingCallback<String>() {
    override fun onSuccess(data: String) {
    }
}).setLoadingPage(new DefaultLoadingPage(recycler)).exe()

2、LoadingPage自定义成功延迟回调与加载时长

DefaultLoadingPage(recycler).setDelay(3000).setDuration(2000)

3、自定义加载页

继承 AbsLoadingPage 实现自定义加载 UI，控制逻辑参考：DefaultLoadingPage

六、请求管理

6.1 取消请求

请求 Task 的 setTag 方法支持传入 object，用于取消指定 tag 标记的请求：

// 请求设置tag
TestTask(object : LoadingCallback<String>() {
    override fun onSuccess(data: String) {
    }
}).setTag(tag).exe()

// 取消请求
CallManager.get().cancel(tag)

6.2 请求重试

执行 Task 的 retry 方法可实现请求一键重试。

val task = TestTask(object : LoadingCallback<String>() {
    override fun onSuccess(data: String) {
    }
}).setTag(tag).exe()

// 请求重试
task.retry()

6.3 生命周期

网络请求默认不与生命周期绑定，如果想实现请求跟随生命周期控制，可以通过 setTag 方法传入 Activity 实例 或 任意 View 即可：

val task = TestTask(object : LoadingCallback<String>() {
    override fun onSuccess(data: String) {
    }
}).setTag(this | view).exe()

七、其他配置

初始化配置时，debug 默认为 false，输出较为友好的统一提示，配置为 true 可输出具体错误信息

Network.init(new NetConfig.Builder()
        .debug(true)
        .build());