Skip to content

Commit

Permalink
docs: 更新部分版本信息、忽略配置
Browse files Browse the repository at this point in the history
  • Loading branch information
@afkT
afkT committed Sep 15, 2022
1 parent 699943a commit a081d91
Show file tree
Hide file tree
Showing 14 changed files with 324 additions and 229 deletions.
49 changes: 45 additions & 4 deletions API/lib/DevApp/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ implementation 'io.github.afkt:DevAppX:2.4.1'
- sort | 各种类型比较器排序实现
- encrypt | 加密工具类
- file | 文件分片相关
- format | 格式化相关
- random | 随机概率算法工具类
- thread | 线程相关
- validator | 数据校验工具类
Expand Down Expand Up @@ -142,6 +143,7 @@ DevUtils.openDebug();
- [sort](#devutilscommoncomparatorsort) | 各种类型比较器排序实现
- [encrypt](#devutilscommonencrypt) | 加密工具类
- [file](#devutilscommonfile) | 文件分片相关
- [format](#devutilscommonformat) | 格式化相关
- [random](#devutilscommonrandom) | 随机概率算法工具类
- [thread](#devutilscommonthread) | 线程相关
- [validator](#devutilscommonvalidator) | 数据校验工具类
Expand Down Expand Up @@ -1858,6 +1860,7 @@ DevUtils.openDebug();
| getUriForFileToName | 获取 FileProvider File Path Uri ( 自动添加包名 ${applicationId} ) |
| getUriForString | 通过 String 获取 Uri |
| fromFile | 通过 File Path 创建 Uri |
| ofUri | 通过 String 获取 Uri |
| isUri | 判断是否 Uri |
| getUriScheme | 获取 Uri Scheme |
| isUriExists | 判断 Uri 路径资源是否存在 |
Expand Down Expand Up @@ -5281,6 +5284,15 @@ DevUtils.openDebug();
| getFileMD5ToHexString | 获取文件 MD5 值 |


* **格式化工具类 ->** [FormatUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/FormatUtils.java)

| 方法 | 注释 |
| :- | :- |
| format | 字符串格式化 |
| unitSpanOf | 获取 UnitSpanFormatter |
| argsOf | 获取 ArgsFormatter |


* **循环工具类 ->** [ForUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/ForUtils.java)

| 方法 | 注释 |
Expand Down Expand Up @@ -5401,9 +5413,10 @@ DevUtils.openDebug();
| :- | :- |
| addZero | 补 0 处理 ( 小于 10, 则自动补充 0x ) |
| subZeroAndDot | 去掉结尾多余的 . 与 0 |
| calculateUnit | 计算指定单位倍数 |
| calculateUnitD | 计算指定单位倍数 |
| calculateUnitI | 计算指定单位倍数 |
| calculateUnitL | 计算指定单位倍数 |
| calculateUnitF | 计算指定单位倍数 |
| percentD | 计算百分比值 ( 最大 100% ) |
| percentI | 计算百分比值 ( 最大 100% ) |
| percentL | 计算百分比值 ( 最大 100% ) |
Expand Down Expand Up @@ -5591,9 +5604,8 @@ DevUtils.openDebug();
| checkValue | 检查字符串 |
| checkValues | 检查字符串 ( 多个值 ) |
| checkValuesSpace | 检查字符串 ( 多个值, 删除前后空格对比判断 ) |
| getFormatString | 获取格式化后的字符串 |
| getAutoFormatString | 获取自动数量格式化后的字符串 ( 可变参数 ) |
| getAutoFormatString2 | 获取自动数量格式化后的字符串 ( 可变参数 ) |
| format | 字符串格式化 |
| argsFormat | 根据可变参数数量自动格式化 |
| concat | 字符串连接, 将参数列表拼接为一个字符串 |
| concatSpiltWith | 字符串连接, 将参数列表拼接为一个字符串 |
| concatSpiltWithIgnoreLast | 字符串连接, 将参数列表拼接为一个字符串 ( 最后一个不追加间隔 ) |
Expand Down Expand Up @@ -6346,6 +6358,35 @@ DevUtils.openDebug();
| fileSplitMerge | 分片合并 |


## <span id="devutilscommonformat">**`dev.utils.common.format`**</span>


* **可变数组格式化 ->** [ArgsFormatter.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/format/ArgsFormatter.java)

| 方法 | 注释 |
| :- | :- |
| get | 获取 ArgsFormatter |
| getStartSpecifier | 获取开始占位说明符 |
| getMiddleSpecifier | 获取中间占位说明符 |
| getEndSpecifier | 获取结尾占位说明符 |
| isThrowError | 是否抛出异常 |
| getDefaultValue | 获取格式化异常默认值 |
| format | 根据可变参数数量自动格式化 |
| formatByArray | 根据可变参数数量自动格式化 |


* **单位数组范围格式化 ->** [UnitSpanFormatter.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/format/UnitSpanFormatter.java)

| 方法 | 注释 |
| :- | :- |
| get | 获取 UnitSpanFormatter |
| getPrecision | 获取单位格式化精度 |
| isAppendZero | 是否自动补 0 |
| getDefaultValue | 获取格式化异常默认值 |
| format | 格式化 |
| formatBySpan | 计算指定单位倍数格式化 |


## <span id="devutilscommonrandom">**`dev.utils.common.random`**</span>


Expand Down
2 changes: 2 additions & 0 deletions API/lib/DevAssist/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,8 @@ implementation 'io.github.afkt:DevAssist:1.3.7'
| setActivity | 设置 Activity |
| parentContext | 通过 ViewGroup 设置 Context |
| getItemCount | getItemCount |
| onAttachedToRecyclerView | onAttachedToRecyclerView |
| onDetachedFromRecyclerView | onDetachedFromRecyclerView |
| getRecyclerView | getRecyclerView |
| setRecyclerView | setRecyclerView |
| bindAdapter | bindAdapter |
Expand Down
123 changes: 47 additions & 76 deletions API/lib/DevHttpCapture/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,28 +23,17 @@ implementation 'io.github.afkt:DevHttpCapture:1.1.2'
### 使用示例

```java
```kotlin
// 添加 Http 抓包拦截处理
DevHttpCapture.addInterceptor(
OkHttpClient.Builder, moduleName
);

// 添加 Http 抓包拦截处理
DevHttpCapture.addInterceptor(
OkHttpClient.Builder, moduleName, isCapture
);

// 添加 Http 抓包拦截处理
DevHttpCapture.addInterceptor(
OkHttpClient.Builder, moduleName,
encrypt, httpFilter, isCapture
);
)

// 移除对应 Module Http 抓包拦截
DevHttpCapture.removeInterceptor(moduleName);
DevHttpCapture.removeInterceptor(moduleName)

// 更新对应 Module Http 抓包拦截处理
DevHttpCapture.updateInterceptor(moduleName, isCapture);
DevHttpCapture.updateInterceptor(moduleName, capture)
```

## 事项
Expand All @@ -59,13 +48,13 @@ DevHttpCapture.updateInterceptor(moduleName, isCapture);


- dev | 根目录
- [capture](#devcapture) | Http 抓包实现代码
- [capture](#devcapture) | Http 抓包实现代码


## <span id="dev">**`dev`**</span>


* **OkHttp 抓包工具库 ->** [DevHttpCapture.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/DevHttpCapture.java)
* **OkHttp 抓包工具库 ->** [DevHttpCapture.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/DevHttpCapture.kt)

| 方法 | 注释 |
| :- | :- |
Expand All @@ -74,26 +63,38 @@ DevHttpCapture.updateInterceptor(moduleName, isCapture);
| getDevAppVersionCode | 获取 DevApp 版本号 |
| getDevAppVersion | 获取 DevApp 版本 |
| addInterceptor | 添加 Http 抓包拦截处理 |
| isContainsModule | 是否存在对应 Module Http 抓包拦截 |
| containsInterceptor | 是否存在对应 Module Http 抓包拦截 |
| removeInterceptor | 移除对应 Module Http 抓包拦截 |
| updateInterceptor | 更新对应 Module Http 抓包拦截处理 |
| getModulePath | 获取指定模块抓包存储路径 |
| getModuleHttpCaptures | 获取指定模块所有抓包数据 |
| getAllModule | 获取全部模块所有抓包数据 |
| utils | 对外公开快捷工具类 ( UtilsPublic ) |


## <span id="devcapture">**`dev.capture`**</span>


* **Http 抓包拦截器 ( 无存储逻辑, 进行回调通知 ) ->** [CallbackInterceptor.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/CallbackInterceptor.java)
* **Http 抓包拦截器 ( 无存储逻辑, 进行回调通知 ) ->** [CallbackInterceptor.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/CallbackInterceptor.kt)
* **Http 抓包拦截器 ( 存在存储抓包数据逻辑 ) ->** [HttpCaptureInterceptor.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/HttpCaptureInterceptor.kt)


* **对外公开快捷方法 ->** [UtilsPublic.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Utils.kt)

| 方法 | 注释 |
| :- | :- |
| intercept | intercept |
| innerResponse | 内部抓包方法 |
| getStoragePath | 获取抓包存储路径 |
| getModulePath | 获取指定模块抓包存储路径 |
| getAllModuleName | 获取全部模块名 |
| getAllModule | 获取全部模块所有抓包数据 |
| deleteModule | 删除指定模块抓包数据 |
| deleteAllModule | 删除全部模块抓包数据 |
| getModuleFileSize | 获取指定模块抓包文件大小 |
| getAllModuleFileSize | 获取全部模块抓包文件大小 |
| getModuleFileLength | 获取指定模块抓包文件大小 |
| getAllModuleFileLength | 获取全部模块抓包文件大小 |


* **抓包存储文件 ->** [CaptureFile.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/CaptureFile.java)
* **抓包存储文件 ->** [CaptureFile.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Model.kt#L103)

| 方法 | 注释 |
| :- | :- |
Expand All @@ -103,52 +104,36 @@ DevHttpCapture.updateInterceptor(moduleName, isCapture);
| getTime | getTime |
| getFileName | getFileName |
| getModuleName | getModuleName |
| getHttpCaptureData | getHttpCaptureData |
| getHttpCaptureData | 获取请求数据 ( 抓包数据 ) |
| getCaptureInfo | 获取抓包信息封装类 |
| toJson | 将对象转换为 JSON String |
| deleteFile | 删除该对象抓包存储文件 |
| getFile | 获取该对象抓包存储文件 |
| getDataFile | 获取该对象抓包数据存储文件 |


* **抓包信息封装类 ->** [CaptureInfo.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/CaptureInfo.java)
* **抓包信息封装类 ->** [CaptureInfo.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Model.kt#L67)

| 方法 | 注释 |
| :- | :- |
| getRequestUrl | getRequestUrl |
| getRequestMethod | getRequestMethod |
| getRequestHeader | getRequestHeader |
| getRequestBody | getRequestBody |
| getResponseStatus | getResponseStatus |
| getResponseHeader | getResponseHeader |
| getResponseBody | getResponseBody |
| requestUrl | 请求链接 |
| requestMethod | 请求方法 |
| requestHeader | 请求头信息 |
| requestBody | 请求数据 |
| responseStatus | 响应状态 |
| responseHeader | 响应头信息 |
| responseBody | 响应数据 |
| toJson | 将对象转换为 JSON String |


* **抓包存储 Item ->** [CaptureItem.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/CaptureItem.java)

| 方法 | 注释 |
| :- | :- |
| getYyyyMMdd | getYyyyMMdd |
| getData | getData |


* **Http 抓包拦截器 ( 存在存储抓包数据逻辑 ) ->** [HttpCaptureInterceptor.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/HttpCaptureInterceptor.java)
* **Http 拦截过滤器 ->** [IHttpFilter.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Interface.kt)

| 方法 | 注释 |
| :- | :- |
| getModuleName | getModuleName |
| getEncrypt | getEncrypt |
| getHttpFilter | getHttpFilter |
| isCapture | isCapture |
| setCapture | setCapture |
| getModulePath | getModulePath |
| getModuleHttpCaptures | getModuleHttpCaptures |
| intercept | intercept |
| innerResponse | 内部抓包方法 |
| filter | 是否过滤该 Http 请求不进行抓包存储 |


* **Http 抓包接口信息获取 ->** [IHttpCapture.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/IHttpCapture.java)
* **Http 抓包接口信息获取 ->** [IHttpCapture.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Interface.kt#L31)

| 方法 | 注释 |
| :- | :- |
Expand All @@ -157,35 +142,21 @@ DevHttpCapture.updateInterceptor(moduleName, isCapture);
| getHttpFilter | 获取 Http 拦截过滤器 |
| isCapture | 是否进行 Http 抓包拦截 |
| setCapture | 设置是否进行 Http 抓包拦截 |
| captureRedact | 获取抓包信息隐藏字段 |
| getModulePath | 获取模块抓包存储路径 |
| getModuleHttpCaptures | 获取模块所有抓包数据 |


* **Http 抓包成功回调接口 ->** [IHttpCaptureCallback.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/IHttpCaptureCallback.java)

| 方法 | 注释 |
| :- | :- |
| callback | 抓包成功回调 |


* **Http 拦截过滤器 ->** [IHttpFilter.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/IHttpFilter.java)

| 方法 | 注释 |
| :- | :- |
| filter | 是否过滤该 Http 请求不进行抓包存储 |


* ** ->** [UtilsPublic.java](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/UtilsPublic.java)
* **Http 抓包事件回调 ->** [IHttpCaptureEvent.kt](https://github.com/afkT/DevUtils/blob/master/lib/DevHttpCapture/src/main/java/dev/capture/Interface.kt#L94)

| 方法 | 注释 |
| :- | :- |
| getStoragePath | 获取抓包存储路径 |
| getModulePath | 获取指定模块抓包存储路径 |
| getAllModuleName | 获取全部模块名 |
| getAllModule | 获取全部模块所有抓包数据 |
| deleteModule | 删除指定模块抓包数据 |
| deleteAllModule | 删除全部模块抓包数据 |
| getModuleFileSize | 获取指定模块抓包文件大小 |
| getAllModuleFileSize | 获取全部模块抓包文件大小 |
| getModuleFileLength | 获取指定模块抓包文件大小 |
| getAllModuleFileLength | 获取全部模块抓包文件大小 |
| callRequestUrl | 生成请求链接字符串 |
| callRequestMethod | 生成请求方法字符串 |
| callRequestHeaders | 生成请求头信息 Map |
| callRequestBody | 生成请求体信息 Map |
| callResponseStatus | 生成响应状态 Map |
| callResponseHeaders | 生成响应头信息 Map |
| callResponseBodyFailed | 生成错误响应体信息 |
| callResponseBody | 生成响应体信息 Map |
| callEnd | 抓包结束 |
Loading

0 comments on commit a081d91

Please sign in to comment.