forked from troyzhxu/okhttps
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathHTTP.java
More file actions
516 lines (439 loc) · 14.2 KB
/
HTTP.java
File metadata and controls
516 lines (439 loc) · 14.2 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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
package com.ejlchina.okhttps;
import com.ejlchina.okhttps.internal.*;
import okhttp3.*;
import okhttp3.WebSocket;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.*;
import java.util.concurrent.Executor;
/**
* HTTP 客户端接口
*
* @author 15735
*/
public interface HTTP {
String GET = "GET";
String HEAD = "HEAD";
String POST = "POST";
String PUT = "PUT";
String PATCH = "PATCH";
String DELETE = "DELETE";
/**
* 同步请求
* @param url 请求地址
* @return 同步HTTP任务
*/
SyncHttpTask sync(String url);
/**
* 异步请求
* @param url 请求地址
* @return 异步HTTP任务
*/
AsyncHttpTask async(String url);
/**
* Websocket 连接
* @param url 连接地址
* @return WebSocket 任务
*/
WebSocketTask webSocket(String url);
/**
* 根据标签取消HTTP任务，只要任务的标签包含指定的Tag就会被取消
* 从 v1.0.2 开始支持取消同步请求
* @param tag 标签
* @return 被取消的任务数量
*/
int cancel(String tag);
/**
* @since 1.0.2
* 取消所有HTTP任务，包括同步和异步
*/
void cancelAll();
/**
* OkHttp 的 HTTP 原生请求 （该请求不经过 预处理器）
* @param request 请求
* @return Call
*/
Call request(Request request);
/**
* OkHttp 的 Websocket 原生请求（该请求不经过 预处理器）
* @param request 请求
* @param listener 监听器
* @return Websocket
*/
WebSocket webSocket(Request request, WebSocketListener listener);
/**
* 获取任务执行器
* @return TaskExecutor
*/
TaskExecutor executor();
/**
* 新的构建器
* @return Builder
*/
Builder newBuilder();
/**
* HTTP 构建器
* @return HTTP 构建器
*/
static Builder builder() {
return new Builder();
}
/**
* Http 配置器
*
*/
interface OkConfig {
/**
* 使用 builder 配置 HttpClient
* @param builder OkHttpClient 构建器
*/
void config(OkHttpClient.Builder builder);
}
class Builder {
private OkHttpClient okClient;
private String baseUrl;
private Map<String, String> mediaTypes;
private List<String> contentTypes;
private OkConfig config;
private Executor mainExecutor;
private Scheduler taskScheduler;
private List<Preprocessor> preprocessors;
private DownListener downloadListener;
private TaskListener<HttpResult> responseListener;
private TaskListener<IOException> exceptionListener;
private TaskListener<HttpResult.State> completeListener;
private List<MsgConvertor> msgConvertors;
private int preprocTimeoutTimes = 10;
private Charset charset = StandardCharsets.UTF_8;
private String bodyType = OkHttps.FORM;
public Builder() {
mediaTypes = new HashMap<>();
mediaTypes.put("*", "application/octet-stream");
mediaTypes.put("png", "image/png");
mediaTypes.put("jpg", "image/jpeg");
mediaTypes.put("jpeg", "image/jpeg");
mediaTypes.put("wav", "audio/wav");
mediaTypes.put("mp3", "audio/mp3");
mediaTypes.put("mp4", "video/mpeg4");
mediaTypes.put("txt", "text/plain");
mediaTypes.put("xls", "application/x-xls");
mediaTypes.put("xml", "text/xml");
mediaTypes.put("apk", "application/vnd.android.package-archive");
mediaTypes.put("doc", "application/msword");
mediaTypes.put("pdf", "application/pdf");
mediaTypes.put("html", "text/html");
contentTypes = new ArrayList<>();
contentTypes.add("application/x-www-form-urlencoded");
contentTypes.add("application/json");
contentTypes.add("application/xml");
contentTypes.add("application/x-protobuf");
preprocessors = new ArrayList<>();
msgConvertors = new ArrayList<>();
}
public Builder(HttpClient hc) {
okClient = hc.okClient();
baseUrl = hc.baseUrl();
mediaTypes = hc.mediaTypes();
preprocessors = new ArrayList<>();
Collections.addAll(preprocessors, hc.preprocessors());
TaskExecutor executor = hc.executor();
contentTypes = new ArrayList<>();
Collections.addAll(contentTypes, executor.getContentTypes());
mainExecutor = executor.getMainExecutor();
taskScheduler = executor.getTaskScheduler();
downloadListener = executor.getDownloadListener();
responseListener = executor.getResponseListener();
exceptionListener = executor.getExceptionListener();
completeListener = executor.getCompleteListener();
msgConvertors = new ArrayList<>();
Collections.addAll(msgConvertors, executor.getMsgConvertors());
preprocTimeoutTimes = hc.preprocTimeoutTimes();
bodyType = hc.bodyType();
charset = hc.charset();
}
/**
* 配置 OkHttpClient
* @param config 配置器
* @return Builder
*/
public Builder config(OkConfig config) {
this.config = config;
return this;
}
/**
* 设置 baseUrl
* @param baseUrl 全局URL前缀
* @return Builder
*/
public Builder baseUrl(String baseUrl) {
if (baseUrl != null) {
this.baseUrl = baseUrl.trim();
}
return this;
}
/**
* 配置媒体类型
* @param mediaTypes 媒体类型
* @return Builder
*/
public Builder mediaTypes(Map<String, String> mediaTypes) {
if (mediaTypes != null) {
this.mediaTypes.putAll(mediaTypes);
}
return this;
}
/**
* 配置媒体类型
* @param key 媒体类型KEY
* @param value 媒体类型VALUE
* @return Builder
*/
public Builder mediaTypes(String key, String value) {
if (key != null && value != null) {
this.mediaTypes.put(key, value);
}
return this;
}
/**
* 配置支持的报文体类型
* @param contentTypes 报文体类型列表
* @return Builder
*/
public Builder contentTypes(List<String> contentTypes) {
if (contentTypes != null) {
this.contentTypes.addAll(contentTypes);
}
return this;
}
/**
* 配置支持的报文体类型
* @param contentType 报文体类型
* @return Builder
*/
public Builder contentTypes(String contentType) {
if (contentType != null) {
this.contentTypes.add(contentType);
}
return this;
}
/**
* 设置回调执行器，例如实现切换线程功能，只对异步请求有效
* @param executor 回调执行器
* @return Builder
*/
public Builder callbackExecutor(Executor executor) {
this.mainExecutor = executor;
return this;
}
/**
* 配置 任务调度器，可用的调度由 {@link WebSocketTask#heatbeat(int, int) } 指定的心跳任务
* 若不配置，则生成一个 线程容量为 1 的 ScheduledThreadPoolExecutor 调度器
* @since v2.3.0
* @param scheduler 调度器
* @return Builder
*/
public Builder taskScheduler(Scheduler scheduler) {
this.taskScheduler = scheduler;
return this;
}
/**
* 添加可并行处理请求任务的预处理器
* @param preprocessor 预处理器
* @return Builder
*/
public Builder addPreprocessor(Preprocessor preprocessor) {
if (preprocessor != null) {
preprocessors.add(preprocessor);
}
return this;
}
/**
* 添加串行预处理器
* @param preprocessor 预处理器
* @return Builder
*/
public Builder addSerialPreprocessor(Preprocessor preprocessor) {
if (preprocessor != null) {
preprocessors.add(new HttpClient.SerialPreprocessor(preprocessor));
}
return this;
}
/**
* 清空预处理器（包括串行预处理器）
* @since v2.5.0
* @return Builder
*/
public Builder clearPreprocessors() {
preprocessors.clear();
return this;
}
/**
* 最大预处理时间（倍数，相当普通请求的超时时间）
* @param times 普通超时时间的倍数，默认为 10
* @return Builder
*/
public Builder preprocTimeoutTimes(int times) {
if (times > 0) {
preprocTimeoutTimes = times;
}
return this;
}
/**
* 设置全局响应监听
* @param listener 监听器
* @return Builder
*/
public Builder responseListener(TaskListener<HttpResult> listener) {
responseListener = listener;
return this;
}
/**
* 设置全局异常监听
* @param listener 监听器
* @return Builder
*/
public Builder exceptionListener(TaskListener<IOException> listener) {
exceptionListener = listener;
return this;
}
/**
* 设置全局完成监听
* @param listener 监听器
* @return Builder
*/
public Builder completeListener(TaskListener<HttpResult.State> listener) {
completeListener = listener;
return this;
}
/**
* 设置下载监听器
* @param listener 监听器
* @return Builder
*/
public Builder downloadListener(DownListener listener) {
downloadListener = listener;
return this;
}
/**
* @since v2.0.0
* 添加消息转换器
* @param msgConvertor JSON 服务
* @return Builder
*/
public Builder addMsgConvertor(MsgConvertor msgConvertor) {
if (msgConvertor != null) {
msgConvertors.add(msgConvertor);
}
return this;
}
/**
* 清空消息转换器
* @since v2.5.0
* @return Builder
*/
public Builder clearMsgConvertors() {
msgConvertors.clear();
return this;
}
/**
* @since v2.0.0
* 设置默认编码格式
* @param charset 编码
* @return Builder
*/
public Builder charset(Charset charset) {
if (charset != null) {
this.charset = charset;
}
return this;
}
/**
* @since v2.0.0
* 设置默认请求体类型
* @param bodyType 请求体类型
* @return Builder
*/
public Builder bodyType(String bodyType) {
if (bodyType != null) {
this.bodyType = bodyType.toLowerCase();
}
return this;
}
/**
* 构建 HTTP 实例
* @return HTTP
*/
public HTTP build() {
if (config != null || okClient == null) {
OkHttpClient.Builder builder;
if (okClient != null) {
builder = okClient.newBuilder();
} else {
builder = new OkHttpClient.Builder();
}
if (config != null) {
config.config(builder);
}
// fix issue: https://github.com/ejlchina/okhttps/issues/8
if (needCopyInterceptor(builder.interceptors())) {
builder.addInterceptor(new CopyInterceptor());
}
okClient = builder.build();
} else if (needCopyInterceptor(okClient.interceptors())) {
okClient = okClient.newBuilder()
.addInterceptor(new CopyInterceptor())
.build();
}
return new HttpClient(this);
}
private boolean needCopyInterceptor(List<Interceptor> list) {
return mainExecutor != null && Platform.ANDROID_SDK_INT > 24 && CopyInterceptor.notIn(list);
}
public OkHttpClient okClient() {
return okClient;
}
public String baseUrl() {
return baseUrl;
}
public Map<String, String> getMediaTypes() {
return mediaTypes;
}
public Executor mainExecutor() {
return mainExecutor;
}
public Preprocessor[] preprocessors() {
return preprocessors.toArray(new Preprocessor[0]);
}
public DownListener downloadListener() {
return downloadListener;
}
public TaskListener<HttpResult> responseListener() {
return responseListener;
}
public TaskListener<IOException> exceptionListener() {
return exceptionListener;
}
public TaskListener<HttpResult.State> completeListener() {
return completeListener;
}
public MsgConvertor[] msgConvertors() {
return msgConvertors.toArray(new MsgConvertor[0]);
}
public Scheduler taskScheduler() {
return taskScheduler;
}
public String[] contentTypes() {
return contentTypes.toArray(new String[0]);
}
public int preprocTimeoutTimes() {
return preprocTimeoutTimes;
}
public Charset charset() {
return charset;
}
public String bodyType() {
return bodyType;
}
}
}