forked from troyzhxu/okhttps
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHttpResult.java
More file actions
262 lines (220 loc) · 5.23 KB
/
HttpResult.java
File metadata and controls
262 lines (220 loc) · 5.23 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
package cn.zhxu.okhttps;
import cn.zhxu.data.ListMap;
import cn.zhxu.okhttps.internal.RealHttpResult;
import okhttp3.Headers;
import okhttp3.MediaType;
import okhttp3.Response;
import java.io.File;
import java.io.IOException;
import java.util.List;
import java.util.function.Consumer;
/**
* Http 执行结果
*/
public interface HttpResult {
/**
* 构造一个 HttpResult
* 此方法构造的 HttpResult 不可设置进度回调，不可进行下载操作！
* 若需要，请使用方法： {@link #of(Response, TaskExecutor)}
* @param response Response
* @return HttpResult
*/
static HttpResult of(Response response) {
return of(response, null);
}
/**
* 构造一个 HttpResult
* @param response Response
* @param taskExecutor 任务执行器, 可通过方法 {@link HTTP#executor()} 获得
* @return HttpResult
*/
static HttpResult of(Response response, TaskExecutor taskExecutor) {
if (response != null) {
return new RealHttpResult(null, response, taskExecutor);
}
throw new IllegalArgumentException("response 不能为空");
}
/**
* 构造一个 HttpResult
* @param task HttpTask
* @param response Response
* @return HttpResult
*/
static HttpResult of(HttpTask<?> task, Response response) {
if (task != null && response != null) {
return new RealHttpResult(task, response, task.httpClient.executor());
}
throw new IllegalArgumentException("task 与 response 不能为空");
}
/**
* HTTP 任务执行状态
*/
enum State {
/**
* 执行异常
*/
EXCEPTION,
/**
* 请求被取消
*/
CANCELED,
/**
* 请求已响应
*/
RESPONSED,
/**
* 网络超时
*/
TIMEOUT,
/**
* 网络出错
*/
NETWORK_ERROR
}
/**
* HTTP响应报文体
*/
interface Body extends Toable {
/**
* will be removed in next version
* @return 媒体类型
*/
@Deprecated
MediaType getType();
/**
* 依赖于 Content-Length 响应头
* @return 报文体字节长度
*/
long getLength();
/**
* 在IO线程执行
* @return Body
*/
Body nextOnIO();
/**
* 设置报文体接收进度回调
* @param onProcess 进度回调函数
* @return Body
*/
Body setOnProcess(Consumer<Process> onProcess);
/**
* 设置进度回调的步进字节，默认 8K（8192）
* 表示每接收 stepBytes 个字节，执行一次进度回调
* @param stepBytes 步进字节
* @return Body
*/
Body stepBytes(long stepBytes);
/**
* 设置进度回调的步进比例
* 表示每接收 stepRate 比例，执行一次进度回调
* @param stepRate 步进比例
* @return Body
*/
Body stepRate(double stepRate);
/**
* 设置进度回调忽略响应的Range头信息，即进度回调会从0开始
* @return Body
*/
Body setRangeIgnored();
/**
* 下载到指定路径
* 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
* @param filePath 目标路径
* @return 下载过程 #Download
*/
Download toFile(String filePath);
/**
* 下载到指定文件
* 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
* @param file 目标文件
* @return 下载过程 #Download
*/
Download toFile(File file);
/**
* 下载到指定文件夹
* 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
* @param dirPath 目标目录
* @return 下载过程 #Download
*/
Download toFolder(String dirPath);
/**
* 下载到指定文件夹
* 同一个 Body 对象的 toXXX 类方法只可使用一个并且只能调用一次
* @param dir 目标目录
* @return 下载过程 #Download
*/
Download toFolder(File dir);
/**
* 缓存自己，缓存后可 重复使用 toXXX 类方法
* @return Body
*/
Body cache();
/**
* 关闭报文体
* 未对报文体做任何消费时使用，比如只读取长度
* @return Body
*/
Body close();
}
/**
* @return 执行状态
*/
State getState();
/**
* @return HTTP状态码
*/
int getStatus();
/**
* WebSocket 返回 101 也返回 true (since v3.5.1)
* @return 是否响应成功，状态码在 [200..300) 之间
*/
boolean isSuccessful();
/**
* will be removed in next version
* @return 响应头
* @see #allHeaders()
*/
@Deprecated
Headers getHeaders();
/**
* @return 所有响应头
* @since v3.5.0
*/
ListMap<String> allHeaders();
/**
* @param name 头名称
* @return 响应头
*/
List<String> getHeaders(String name);
/**
* @param name 头名称
* @return 响应头
*/
String getHeader(String name);
/**
* 获取响应报文体长度（从请求头内提取）
* 在 HEAD 请求时，该方法返回不为 0，但{@link Body#getLength()} 将返回 0
* @return 长度
*/
long getContentLength();
/**
* @return 响应报文体
*/
Body getBody();
/**
* 获取所属的请求任务
* @since 2.5.0
* @return HttpTask
*/
HttpTask<?> getTask();
/**
* @return 执行中发生的异常
*/
IOException getError();
/**
* 关闭报文
* 未对报文体做任何消费时使用，比如只读取报文头
* @return HttpResult
*/
HttpResult close();
}