Skip to content

Commit d2c319c

Browse files
author
Ttt
committed
1.更新 API 文档
Former-commit-id: e3a99ad Former-commit-id: 5277337
1 parent 4046bb2 commit d2c319c

File tree

3 files changed

+90
-8
lines changed

3 files changed

+90
-8
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
351e806a45201567d487af4d2338d5c31fcee535
1+
60e27da933a8049cdf6e20acc994774ec3c83124

lib/DevAssist/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,6 @@ implementation 'com.afkt:DevAssist:1.0.4'
114114
| initPageConfig | 初始化全局分页配置 |
115115
| getPageNum | 获取当前请求页数 |
116116
| setPageNum | 设置当前请求页数 |
117-
| getPageNumReady | 获取当前 ( 正在 / 准备 ) 请求的页数 |
118-
| setPageNumReady | 设置当前 ( 正在 / 准备 ) 请求的页数 |
119117
| getPageSize | 获取每页请求条数 |
120118
| setPageSize | 设置每页请求条数 |
121119
| getTotalRow | 获取数据总条数 |
@@ -126,8 +124,6 @@ implementation 'com.afkt:DevAssist:1.0.4'
126124
| isAllowNextPage | 判断是否允许请求下一页 |
127125
| getNextPage | 获取下一页页数 |
128126
| nextPage | 设置下一页页数 |
129-
| getNextPageReady | 获取下一页页数 ( 预加载页数 ) |
130-
| nextPageReady | 设置下一页页数 ( 预加载页数 ) |
131127
| isLessThanPageSize | 判断是否小于每页请求条数 |
132128
| reset | 重置操作 |
133129

lib/DevOther/README.md

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
- assist | 常用辅助类封装
88
- other | 第三方库封装工具类
99
- okgo | OkGo 网络请求
10+
- retrofit | Retrofit 网络请求
11+
- response | 请求响应解析
12+
- subscriber | 请求响应处理
1013
- receiver | BroadcastReceiver 监听相关
1114
- service | Service 相关
1215
- temp | 临时快捷调用工具类
@@ -25,6 +28,9 @@
2528
- [assist](#devassist) | 常用辅助类封装
2629
- [other](#devother) | 第三方库封装工具类
2730
- [okgo](#devotherokgo) | OkGo 网络请求
31+
- [retrofit](#devotherretrofit) | Retrofit 网络请求
32+
- [response](#devotherretrofitresponse) | 请求响应解析
33+
- [subscriber](#devotherretrofitsubscriber) | 请求响应处理
2834
- [receiver](#devreceiver) | BroadcastReceiver 监听相关
2935
- [service](#devservice) | Service 相关
3036
- [temp](#devtemp) | 临时快捷调用工具类
@@ -281,6 +287,18 @@
281287
| stop | 停止图片加载 |
282288

283289

290+
* **Luban 工具类 ->** [LubanUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/LubanUtils.java)
291+
292+
| 方法 | 注释 |
293+
| :- | :- |
294+
| setConfig | 设置全局默认配置 |
295+
| compress | 压缩方法 |
296+
| onStart | 压缩开始前调用 |
297+
| onSuccess | 压缩成功后调用 |
298+
| onError | 当压缩过程出现问题时调用 |
299+
| onComplete | 压缩完成 |
300+
301+
284302
* **Android 平台下的图片选择器 ->** [PictureSelectorUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/PictureSelectorUtils.java)
285303

286304
| 方法 | 注释 |
@@ -352,7 +370,7 @@
352370
| intercept | intercept |
353371

354372

355-
* **OkGo 请求统一回调处理类 ->** [OkGoCallback.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/okgo/OkGoCallback.java)
373+
* **请求回调统一处理类 ->** [OkGoCallback.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/okgo/OkGoCallback.java)
356374

357375
| 方法 | 注释 |
358376
| :- | :- |
@@ -378,12 +396,12 @@
378396
| uploadImages | 上传多个文件 |
379397

380398

381-
* **请求响应解析基类 ->** [OkGoResponse.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/okgo/OkGoResponse.java)
399+
* **请求响应统一解析类 ->** [OkGoResponse.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/okgo/OkGoResponse.java)
382400

383401
| 方法 | 注释 |
384402
| :- | :- |
385403
| getDataString | 获取 Data 字符串 |
386-
| build | build BaseResponse 对象 |
404+
| build | build Response 对象 |
387405
| setData | setData |
388406
| setMessage | setMessage |
389407
| setCode | setCode |
@@ -401,6 +419,74 @@
401419
| execute | 执行请求处理 |
402420

403421

422+
## <span id="devotherretrofit">**`dev.other.retrofit`**</span>
423+
424+
425+
* **Retrofit 管理类 ->** [RetrofitManager.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/retrofit/RetrofitManager.java)
426+
427+
| 方法 | 注释 |
428+
| :- | :- |
429+
| getInstance | getInstance |
430+
| get | 通过 tag 获取 Retrofit |
431+
| put | 通过 tag 保存 Retrofit |
432+
| remove | 通过 tag 移除 Retrofit |
433+
| contains | 通过 tag 判断是否存在 Retrofit |
434+
| getRetrofitMap | 获取 Retrofit Map |
435+
| create | 创建 API Service Class |
436+
437+
438+
* **RxJava 相关管理类 ( 针对 Retrofit ) ->** [RxJavaManager.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/retrofit/RxJavaManager.java)
439+
440+
| 方法 | 注释 |
441+
| :- | :- |
442+
| getInstance | getInstance |
443+
| add | 通过 tag 将请求添加到统一管理对象中 |
444+
| remove | 通过 tag 移除请求 |
445+
| contains | 通过 tag 判断是否存在 CompositeDisposable |
446+
| getManagerMap | 获取 CompositeDisposable Map |
447+
| io_main | Flowable UI 线程 |
448+
449+
450+
## <span id="devotherretrofitresponse">**`dev.other.retrofit.response`**</span>
451+
452+
453+
* **请求响应统一解析类 ->** [BaseResponse.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/retrofit/response/BaseResponse.java)
454+
455+
| 方法 | 注释 |
456+
| :- | :- |
457+
| getOriginal | getOriginal |
458+
459+
460+
## <span id="devotherretrofitsubscriber">**`dev.other.retrofit.subscriber`**</span>
461+
462+
463+
* **服务器请求响应处理, 映射各种 JSON 实体类 ->** [BaseBeanSubscriber.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/retrofit/subscriber/BaseBeanSubscriber.java)
464+
465+
| 方法 | 注释 |
466+
| :- | :- |
467+
| onNext | onNext |
468+
| onError | onError |
469+
| onStart | onStart |
470+
| onComplete | onComplete |
471+
| onSuccessResponse | 请求响应并处理数据无误 |
472+
| onErrorResponse | 请求失败、响应错误、数据解析错误等, 都会回调该方法, UI 线程 |
473+
| getErrorMessage | 获取异常信息 |
474+
475+
476+
* **服务器请求响应处理, 映射统一标准 JSON 格式实体类 ->** [BaseResponseSubscriber.java](https://github.com/afkT/DevUtils/blob/master/lib/DevOther/src/main/java/dev/other/retrofit/subscriber/BaseResponseSubscriber.java)
477+
478+
| 方法 | 注释 |
479+
| :- | :- |
480+
| onNext | onNext |
481+
| onError | onError |
482+
| onStart | onStart |
483+
| onComplete | onComplete |
484+
| onSuccessResponse | 请求响应并处理数据无误 |
485+
| onErrorResponse | 请求失败、响应错误、数据解析错误等, 都会回调该方法, UI 线程 |
486+
| getErrorMessage | 获取异常信息 |
487+
| isSuccess | 通过 code 判断请求是否正确 |
488+
489+
404490
## <span id="devreceiver">**`dev.receiver`**</span>
405491

406492

0 commit comments

Comments
 (0)