-
-
Notifications
You must be signed in to change notification settings - Fork 302
/
ProgressOperation.kt
453 lines (396 loc) · 12.4 KB
/
ProgressOperation.kt
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
package dev.http.progress
import android.os.Handler
import dev.http.progress.operation.BaseOperation
import dev.http.progress.operation.IOperation
import dev.http.progress.operation.OperationPlanA
import dev.http.progress.operation.OperationPlanB
import dev.utils.common.assist.url.UrlExtras
import okhttp3.OkHttpClient
/**
* detail: Progress Operation
* @author Ttt
* 通过 key 区分, 支持不同组件模块化网络进度监听
* 支持上行、下行、上下行三种类型, 内部拦截器监听回调
* <p></p>
* 注意事项:
* 绑定监听事件是通过 url 进行绑定的
* 例 url 为 https://developer.android.com/docs?type=1&abc=afkt
* 会统一处理成 https://developer.android.com/docs 作为 key
* 而其他信息通过 [Progress.Extras] 进行获取请求方法、请求头信息
* 以及 url 携带参数解析 [Progress.Extras.getUrlExtras]
* 具体参数信息拆分获取可通过 [UrlExtras] 进行获取
* 并自行根据 Request 信息进行判断处理回调事件
* <p></p>
* 因通知回调功能支持方式不同, 选择的技术方案不同, 各有利弊
* 已提供切换实现方式方法 [setPlanType]
* =
* 方式二: [OperationPlanB]
* 在创建 [wrapRequestBody]、[wrapResponseBody] 时, 创建一个新的 Callback
* 并把 listener map 对应 url 监听的 Callback List toArray 传入进行通知使用
* 优点: 可以对 List 进行弱引用处理, 会自动进行释放资源
* 缺点: 对 listener map 新增 url key add listener 在请求之后添加
* 则会无法触发 ( 因为在请求拦截时候就已传入 Callback List toArray )
* =
* 方式一 ( 默认 ): [OperationPlanA]
* 在创建 [wrapRequestBody]、[wrapResponseBody] 时, 使用统一回调 [OperationPlanA.innerCallback] 无需每次 new Callback
* 在统一回调内获取 listener map 对应 url 监听的 Callback List 并进行通知
* 优点: 支持实时 add listener 并进行通知回调
* 缺点: 实时通知可能因绑定顺序差异, 需自行根据 [Progress.Extras.getUrlExtras] 进行判断是否需要处理该通知
* listener map 中的 Callback 需要手动进行释放
* 针对该缺点提供了两个解决方案
* 1.[Progress.Callback] 提供 isAutoRecycle 方法 ( 默认销毁 ) 可自行判断是否需要销毁
* 2.提供 [recycleListener] 方法可在 Callback onEnd 中直接调用释放资源无需实现逻辑
*/
class ProgressOperation private constructor(
private val key: String,
// 全局默认操作对象
private val globalDefault: Boolean,
// 内部拦截器监听类型
private val type: Int,
) : IOperation {
companion object {
// ==================
// = 内部拦截器监听类型 =
// ==================
// 监听上下行类型
internal const val TYPE_ALL = 0
// 监听上行
internal const val TYPE_REQUEST = 1
// 监听下行
internal const val TYPE_RESPONSE = 2
// =============
// = 实现方式类型 =
// =============
// 实现方式一 ( 默认使用 )
const val PLAN_A = 1
// 实现方式二
const val PLAN_B = 2
// ==========
// = create =
// ==========
/**
* 创建 Progress Operation
* @param key Key
* @param globalDefault 全局默认操作对象
* @param type 内部拦截器监听类型
* @return Progress Operation
*/
internal fun get(
key: String,
globalDefault: Boolean,
type: Int
): ProgressOperation {
return ProgressOperation(key, globalDefault, type)
}
}
// 实现方式类型
private var mPlanType: Int = PLAN_A
// Progress Operation 方案实现
private val IMPL: BaseOperation by lazy {
when (mPlanType) {
PLAN_B -> OperationPlanB(key, globalDefault, type)
else -> OperationPlanA(key, globalDefault, type)
}
}
// =============
// = 对外公开方法 =
// =============
/**
* 设置 Progress Operation 实现方式类型
* @param planType 实现方式类型 [ProgressOperation.PLAN_A]、[ProgressOperation.PLAN_B]
* @return IOperation
* 在没调用 IOperation 接口任何方法前, 调用该方法切换才有效
*/
fun setPlanType(planType: Int): IOperation {
mPlanType = when (planType) {
PLAN_B -> planType
else -> PLAN_A
}
return this
}
// ==========
// = 内部方法 =
// ==========
/**
* 释放资源方法
*/
internal fun recycle(): ProgressOperation {
IMPL.markDeprecated()
return this
}
// ==============
// = IOperation =
// ==============
// ============
// = 初始化方法 =
// ============
/**
* 进行拦截器包装 ( 必须调用 )
* @param builder Builder
* @return Builder
* 必须进行调用, 否则无法进行拦截监听
* 推荐在 OkHttpClient Builder 最后一步调用
* 防止中间有其他拦截器导致获取为旧数据
* 例:
* val okhttpClient = wrap(builder).build()
*/
override fun wrap(builder: OkHttpClient.Builder): OkHttpClient.Builder {
return IMPL.wrap(builder)
}
// =============
// = 对外公开方法 =
// =============
/**
* 是否已调用 wrap 方法
* @return `true` yes, `false` no
*/
override fun isUseWrap(): Boolean {
return IMPL.isUseWrap()
}
/**
* 是否废弃不用状态
* @return `true` yes, `false` no
*/
override fun isDeprecated(): Boolean {
return IMPL.isDeprecated()
}
/**
* 是否全局默认操作对象
* @return `true` yes, `false` no
*/
override fun isDefault(): Boolean {
return IMPL.isDefault()
}
/**
* 是否监听上下行
* @return `true` yes, `false` no
*/
override fun isTypeAll(): Boolean {
return IMPL.isTypeAll()
}
/**
* 是否监听上行
* @return `true` yes, `false` no
*/
override fun isTypeRequest(): Boolean {
return IMPL.isTypeRequest()
}
/**
* 是否监听下行
* @return `true` yes, `false` no
*/
override fun isTypeResponse(): Boolean {
return IMPL.isTypeResponse()
}
// ===========
// = get/set =
// ===========
/**
* 获取 Progress Operation 实现方式类型
* @return 实现方式类型
*/
override fun getPlanType(): Int {
return IMPL.getPlanType()
}
// =
/**
* 获取回调刷新时间 ( 毫秒 )
* @return 回调刷新时间 ( 毫秒 )
*/
override fun getRefreshTime(): Long {
return IMPL.getRefreshTime()
}
/**
* 设置回调刷新时间 ( 毫秒 )
* @param refreshTime 回调刷新时间 ( 毫秒 )
* @return IOperation
*/
override fun setRefreshTime(refreshTime: Long): IOperation {
return IMPL.setRefreshTime(refreshTime)
}
/**
* 重置回调刷新时间 ( 毫秒 )
* @return IOperation
*/
override fun resetRefreshTime(): IOperation {
return IMPL.resetRefreshTime()
}
// =
/**
* 获取全局 Progress Callback
* @return Progress Callback
*/
override fun getCallback(): Progress.Callback? {
return IMPL.getCallback()
}
/**
* 设置全局 Progress Callback
* @param callback Progress Callback
* @return IOperation
*/
override fun setCallback(callback: Progress.Callback?): IOperation {
return IMPL.setCallback(callback)
}
/**
* 移除全局 Progress Callback
* @return IOperation
*/
override fun removeCallback(): IOperation {
return IMPL.removeCallback()
}
// =
/**
* 获取回调 UI 线程通知 Handler
* @return 回调 UI 线程通知 Handler
*/
override fun getHandler(): Handler? {
return IMPL.getHandler()
}
/**
* 设置回调 UI 线程通知 Handler
* @param handler 回调 UI 线程通知 Handler
* @return IOperation
*/
override fun setHandler(handler: Handler?): IOperation {
return IMPL.setHandler(handler)
}
/**
* 重置回调 UI 线程通知 Handler
* @return IOperation
*/
override fun resetHandler(): IOperation {
return IMPL.resetHandler()
}
// ====================
// = 操作方法 - 对外公开 =
// ====================
/**
* 移除自身在 Manager Map 中的对象值, 并且标记为废弃状态
* 会释放所有数据、监听事件且不处理任何监听
*/
override fun removeSelfFromManager() {
return IMPL.removeSelfFromManager()
}
/**
* 释放指定监听事件
* @param progress Progress
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun recycleListener(
progress: Progress,
callback: Progress.Callback
): Boolean {
return IMPL.recycleListener(progress, callback)
}
// ====================
// = Request Listener =
// ====================
/**
* 添加指定 url 上行监听事件
* @param url 请求 url
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun addRequestListener(
url: String,
callback: Progress.Callback
): Boolean {
return IMPL.addRequestListener(url, callback)
}
/**
* 清空指定 url 上行所有监听事件
* @param url 请求 url
* @return `true` success, `false` fail
*/
override fun clearRequestListener(url: String): Boolean {
return IMPL.clearRequestListener(url)
}
/**
* 清空指定 url 上行所有监听事件
* @param progress Progress
* @return `true` success, `false` fail
*/
override fun clearRequestListener(progress: Progress?): Boolean {
return IMPL.clearRequestListener(progress)
}
/**
* 移除指定 url 上行监听事件
* @param url 请求 url
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun removeRequestListener(
url: String,
callback: Progress.Callback
): Boolean {
return IMPL.removeRequestListener(url, callback)
}
/**
* 移除指定 url 上行监听事件
* @param progress Progress
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun removeRequestListener(
progress: Progress?,
callback: Progress.Callback
): Boolean {
return IMPL.removeRequestListener(progress, callback)
}
// =====================
// = Response Listener =
// =====================
/**
* 添加指定 url 下行监听事件
* @param url 请求 url
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun addResponseListener(
url: String,
callback: Progress.Callback
): Boolean {
return IMPL.addResponseListener(url, callback)
}
/**
* 清空指定 url 下行所有监听事件
* @param url 请求 url
* @return `true` success, `false` fail
*/
override fun clearResponseListener(url: String): Boolean {
return IMPL.clearResponseListener(url)
}
/**
* 清空指定 url 下行所有监听事件
* @param progress Progress
* @return `true` success, `false` fail
*/
override fun clearResponseListener(progress: Progress?): Boolean {
return IMPL.clearResponseListener(progress)
}
/**
* 移除指定 url 下行监听事件
* @param url 请求 url
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun removeResponseListener(
url: String,
callback: Progress.Callback
): Boolean {
return IMPL.removeResponseListener(url, callback)
}
/**
* 移除指定 url 下行监听事件
* @param progress Progress
* @param callback 上传、下载回调接口
* @return `true` success, `false` fail
*/
override fun removeResponseListener(
progress: Progress?,
callback: Progress.Callback
): Boolean {
return IMPL.removeResponseListener(progress, callback)
}
}