Skip to content

Commit

Permalink
docs: 更新 DevUtils 所有库 API 文档
Browse files Browse the repository at this point in the history
Former-commit-id: 8271105
  • Loading branch information
afkT committed Jul 4, 2022
1 parent 3103853 commit 75b179d
Show file tree
Hide file tree
Showing 15 changed files with 301 additions and 211 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

[![GitHub](https://img.shields.io/badge/GitHub-afkT-blue.svg)](https://github.com/afkT)
[![GitHub license](https://img.shields.io/github/license/afkT/DevUtils.svg)](https://github.com/afkT/DevUtils/blob/master/LICENSE)
[![MavenCentral](https://img.shields.io/badge/DevUtils-2.3.9-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
[![MavenCentral](https://img.shields.io/badge/DevUtils-2.4.0-brightgreen.svg)](https://search.maven.org/search?q=io.github.afkt)
[![API](https://img.shields.io/badge/API-14%2B-brightgreen.svg?style=flat)](https://android-arsenal.com/api?level=14)
[![Utils](https://img.shields.io/badge/utils-200+-ff69b4.svg)](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/README.md)

Expand Down Expand Up @@ -113,44 +113,44 @@
```gradle
// DevApp - Android 工具类库
implementation 'io.github.afkt:DevAppX:2.3.9'
implementation 'io.github.afkt:DevAppX:2.4.0'
// DevAssist - 封装逻辑代码, 实现多个快捷功能辅助类、以及 Engine 兼容框架等
implementation 'io.github.afkt:DevAssist:1.3.5'
implementation 'io.github.afkt:DevAssist:1.3.6'
// DevBase - Base ( Activity、Fragment )、MVP、ViewBinding、ContentLayout 基类库
implementation 'io.github.afkt:DevBase:1.1.2'
implementation 'io.github.afkt:DevBase:1.1.3'
// DevBaseMVVM - MVVM ( ViewDataBinding + ViewModel ) 基类库
implementation 'io.github.afkt:DevBaseMVVM:1.1.0'
implementation 'io.github.afkt:DevBaseMVVM:1.1.1'
// DevEngine - 第三方框架解耦、一键替换第三方库、同类库多 Engine 组件化混合使用
implementation 'io.github.afkt:DevEngine:1.0.7'
implementation 'io.github.afkt:DevEngine:1.0.8'
// DevHttpCapture - OkHttp 抓包工具库
implementation 'io.github.afkt:DevHttpCapture:1.1.1'
implementation 'io.github.afkt:DevHttpCapture:1.1.2'
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.1'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.1'
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.2'
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.2'
// DevHttpManager - OkHttp 管理库 ( Retrofit 多 BaseUrl 管理、Progress 监听 )
implementation 'io.github.afkt:DevHttpManager:1.0.1'
implementation 'io.github.afkt:DevHttpManager:1.0.2'
// DevRetrofit - Retrofit + Kotlin Coroutines 封装
implementation 'io.github.afkt:DevRetrofit:1.0.0'
implementation 'io.github.afkt:DevRetrofit:1.0.1'
// DevWidget - 自定义 View UI 库
implementation 'io.github.afkt:DevWidgetX:1.1.8'
implementation 'io.github.afkt:DevWidgetX:1.1.9'
// DevEnvironment - Android 环境配置切换库
implementation 'io.github.afkt:DevEnvironment:1.1.0'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0' // kapt
implementation 'io.github.afkt:DevEnvironment:1.1.1'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1' // kaptDebug
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.1' // kaptRelease
//annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1' // kapt
// DevJava - Java 工具类库 ( 不依赖 android api )
implementation 'io.github.afkt:DevJava:1.4.5' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
implementation 'io.github.afkt:DevJava:1.4.6' // 用于纯 Java 开发,如果依赖了 DevApp 则不需要依赖 DevJava
```

## [APK Demo](https://github.com/afkT/Resources/blob/main/APK)
Expand Down
22 changes: 15 additions & 7 deletions lib/DevApp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
//implementation 'com.afkt:DevApp:1.9.4'
// AndroidX ( Maven Central )
implementation 'io.github.afkt:DevAppX:2.3.9'
implementation 'io.github.afkt:DevAppX:2.4.0'
```

## 目录结构
Expand Down Expand Up @@ -1858,6 +1858,10 @@ DevUtils.openDebug();
| isDownloadsDocument | 判读 Uri authority 是否为 Downloads Provider |
| isMediaDocument | 判断 Uri authority 是否为 Media Provider |
| isGooglePhotosUri | 判断 Uri authority 是否为 Google Photos Provider |
| isAndroidResourceScheme | 判断 Uri Scheme 是否 ContentResolver.SCHEME_ANDROID_RESOURCE |
| isFileScheme | 判断 Uri Scheme 是否 ContentResolver.SCHEME_FILE |
| isContentScheme | 判断 Uri Scheme 是否 ContentResolver.SCHEME_CONTENT |
| isUriScheme | 判断是否指定的 Uri Scheme |


* **版本工具类 ->** [VersionUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/app/VersionUtils.java)
Expand Down Expand Up @@ -5532,6 +5536,8 @@ DevUtils.openDebug();
| isLength | 获取字符串长度 是否等于期望长度 |
| equals | 判断两个值是否一样 |
| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
| equalsIgnoreCase | 判断两个值是否一样 ( 忽略大小写 ) |
| equalsIgnoreCaseNotNull | 判断两个值是否一样 ( 忽略大小写 ) |
| isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
| isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
| isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |
Expand Down Expand Up @@ -6417,14 +6423,16 @@ DevUtils.openDebug();
| isContainChinese | 判断字符串中包含中文、包括中文字符标点等 |


* **检验联系 ( 手机号、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)
* **检验联系 ( 手机号码、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevApp/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)

| 方法 | 注释 |
| :- | :- |
| isPhoneCheck | 中国手机号格式验证, 在输入可以调用该方法, 点击发送验证码, 使用 isPhone |
| isPhone | 是否中国手机号 |
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
| isPhoneSimple | 中国手机号码格式验证 ( 简单手机号码校验 ) |
| isPhone | 是否中国手机号码 |
| isPhoneToChinaMobile | 是否中国移动手机号码 |
| isPhoneToHkMobile | 判断是否香港手机号 |
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
| isPhoneToChinaBroadcast | 是否中国广电手机号码 |
| isPhoneToChinaVirtual | 是否中国虚拟运营商手机号码 |
| isPhoneToChinaHkMobile | 是否中国香港手机号码 |
| isPhoneCallNum | 验证电话号码的格式 |
3 changes: 2 additions & 1 deletion lib/DevAssist/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevAssist:1.3.5'
implementation 'io.github.afkt:DevAssist:1.3.6'
```

## 目录结构
Expand Down Expand Up @@ -1426,6 +1426,7 @@ implementation 'io.github.afkt:DevAssist:1.3.5'
| setConfig | 设置全局配置 |
| openCamera | 打开相册拍照 |
| openGallery | 打开相册选择 |
| openPreview | 打开相册预览 |
| deleteCacheDirFile | 删除缓存文件 |
| deleteAllCacheDirFile | 删除全部缓存文件 |
| isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |
Expand Down
2 changes: 1 addition & 1 deletion lib/DevBase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevBase:1.1.2'
implementation 'io.github.afkt:DevBase:1.1.3'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevBaseMVVM/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevBaseMVVM:1.1.0'
implementation 'io.github.afkt:DevBaseMVVM:1.1.1'
```

## 目录结构
Expand Down
70 changes: 35 additions & 35 deletions lib/DevEngine/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,23 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevEngine:1.0.7'
implementation 'io.github.afkt:DevEngine:1.0.8'
```

## 目录结构

```
- dev.engine | 根目录
- barcode | BarCode Engine 条形码、二维码处理
- cache | Cache Engine 有效期键值对缓存
- compress | Image Compress Engine 图片压缩
- image | Image Engine 图片加载、下载、转格式等
- json | JSON Engine 映射
- keyvalue | KeyValue Engine 键值对存储
- log | Log Engine 日志打印
- media | Media Selector Engine 多媒体资源选择
- luck_lib_engine | LuckSiege PictureSelector Engine 实现
- permission | Permission Engine 权限申请
- storage | Storage Engine 外部、内部文件存储
- dev.engine | 根目录
- barcode | BarCode Engine 条形码、二维码处理
- cache | Cache Engine 有效期键值对缓存
- compress | Image Compress Engine 图片压缩
- image | Image Engine 图片加载、下载、转格式等
- json | JSON Engine 映射
- keyvalue | KeyValue Engine 键值对存储
- log | Log Engine 日志打印
- media | Media Selector Engine 多媒体资源选择
- permission | Permission Engine 权限申请
- storage | Storage Engine 外部、内部文件存储
```


Expand Down Expand Up @@ -311,27 +310,26 @@ private fun initEngine(appContext: Application) {

## API

- dev | 根目录
- [engine](#devengine) | 兼容 Engine
- [analytics](#devengineanalytics) | Analytics Engine 数据统计 ( 埋点 )
- [barcode](#devenginebarcode) | BarCode Engine 条形码、二维码处理
- [listener](#devenginebarcodelistener) | 条形码、二维码操作回调事件
- [cache](#devenginecache) | Cache Engine 有效期键值对缓存
- [compress](#devenginecompress) | Image Compress Engine 图片压缩
- [listener](#devenginecompresslistener) | 图片压缩回调事件
- [image](#devengineimage) | Image Engine 图片加载、下载、转格式等
- [listener](#devengineimagelistener) | 图片加载监听事件
- [json](#devenginejson) | JSON Engine 映射
- [keyvalue](#devenginekeyvalue) | KeyValue Engine 键值对存储
- [log](#devenginelog) | Log Engine 日志打印
- [media](#devenginemedia) | Media Selector Engine 多媒体资源选择
- [permission](#devenginepermission) | Permission Engine 权限申请
- [push](#devenginepush) | Push Engine 推送平台处理
- [share](#devengineshare) | Share Engine 分享平台处理
- [listener](#devenginesharelistener) | 分享回调事件
- [storage](#devenginestorage) | Storage Engine 外部、内部文件存储
- [listener](#devenginestoragelistener) | Storage 存储结果事件

- dev | 根目录
- [engine](#devengine) | 兼容 Engine
- [analytics](#devengineanalytics) | Analytics Engine 数据统计 ( 埋点 )
- [barcode](#devenginebarcode) | BarCode Engine 条形码、二维码处理
- [listener](#devenginebarcodelistener) | 条形码、二维码操作回调事件
- [cache](#devenginecache) | Cache Engine 有效期键值对缓存
- [compress](#devenginecompress) | Image Compress Engine 图片压缩
- [listener](#devenginecompresslistener) | 图片压缩回调事件
- [image](#devengineimage) | Image Engine 图片加载、下载、转格式等
- [listener](#devengineimagelistener) | 图片加载监听事件
- [json](#devenginejson) | JSON Engine 映射
- [keyvalue](#devenginekeyvalue) | KeyValue Engine 键值对存储
- [log](#devenginelog) | Log Engine 日志打印
- [media](#devenginemedia) | Media Selector Engine 多媒体资源选择
- [permission](#devenginepermission) | Permission Engine 权限申请
- [push](#devenginepush) | Push Engine 推送平台处理
- [share](#devengineshare) | Share Engine 分享平台处理
- [listener](#devenginesharelistener) | 分享回调事件
- [storage](#devenginestorage) | Storage Engine 外部、内部文件存储
- [listener](#devenginestoragelistener) | Storage 存储结果事件



Expand Down Expand Up @@ -736,6 +734,7 @@ private fun initEngine(appContext: Application) {
| setConfig | 设置全局配置 |
| openCamera | 打开相册拍照 |
| openGallery | 打开相册选择 |
| openPreview | 打开相册预览 |
| deleteCacheDirFile | 删除缓存文件 |
| deleteAllCacheDirFile | 删除全部缓存文件 |
| isMediaSelectorResult | 是否图片选择 ( onActivityResult ) |
Expand Down Expand Up @@ -833,10 +832,11 @@ private fun initEngine(appContext: Application) {
| shareMinApp | 分享小程序 |
| shareUrl | 分享链接 |
| shareImage | 分享图片 |
| shareImageList | 分享多张图片 |
| shareText | 分享文本 |
| shareVideo | 分享视频 |
| shareMusic | 分享音乐 |
| shareEmoji | 分享表情 |
| shareText | 分享文本 |
| shareFile | 分享文件 |
| share | 分享操作 ( 通用扩展 ) |
| onActivityResult | 部分平台 Activity onActivityResult 额外调用处理 |
Expand Down
2 changes: 1 addition & 1 deletion lib/DevHttpCapture/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevHttpCapture:1.1.1'
implementation 'io.github.afkt:DevHttpCapture:1.1.2'
```

## 目录结构
Expand Down
2 changes: 1 addition & 1 deletion lib/DevHttpManager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevHttpManager:1.0.1'
implementation 'io.github.afkt:DevHttpManager:1.0.2'
```

## 目录结构
Expand Down
18 changes: 11 additions & 7 deletions lib/DevJava/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevJava:1.4.5'
implementation 'io.github.afkt:DevJava:1.4.6'
```

## 目录结构
Expand Down Expand Up @@ -924,6 +924,8 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
| isLength | 获取字符串长度 是否等于期望长度 |
| equals | 判断两个值是否一样 |
| equalsNotNull | 判断两个值是否一样 ( 非 null 判断 ) |
| equalsIgnoreCase | 判断两个值是否一样 ( 忽略大小写 ) |
| equalsIgnoreCaseNotNull | 判断两个值是否一样 ( 忽略大小写 ) |
| isEquals | 判断多个字符串是否相等, 只有全相等才返回 true ( 对比大小写 ) |
| isOrEquals | 判断多个字符串, 只要有一个符合条件则通过 |
| isContains | 判断一堆值中, 是否存在符合该条件的 ( 包含 ) |
Expand Down Expand Up @@ -1809,14 +1811,16 @@ JCLogUtils.setPrint(new JCLogUtils.Print() {});
| isContainChinese | 判断字符串中包含中文、包括中文字符标点等 |


* **检验联系 ( 手机号、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)
* **检验联系 ( 手机号码、座机 ) 工具类 ->** [ValiToPhoneUtils.java](https://github.com/afkT/DevUtils/blob/master/lib/DevJava/src/main/java/dev/utils/common/validator/ValiToPhoneUtils.java)

| 方法 | 注释 |
| :- | :- |
| isPhoneCheck | 中国手机号格式验证, 在输入可以调用该方法, 点击发送验证码, 使用 isPhone |
| isPhone | 是否中国手机号 |
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
| isPhoneSimple | 中国手机号码格式验证 ( 简单手机号码校验 ) |
| isPhone | 是否中国手机号码 |
| isPhoneToChinaMobile | 是否中国移动手机号码 |
| isPhoneToHkMobile | 判断是否香港手机号 |
| isPhoneToChinaUnicom | 是否中国联通手机号码 |
| isPhoneToChinaTelecom | 是否中国电信手机号码 |
| isPhoneToChinaBroadcast | 是否中国广电手机号码 |
| isPhoneToChinaVirtual | 是否中国虚拟运营商手机号码 |
| isPhoneToChinaHkMobile | 是否中国香港手机号码 |
| isPhoneCallNum | 验证电话号码的格式 |
2 changes: 1 addition & 1 deletion lib/DevRetrofit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
## Gradle

```gradle
implementation 'io.github.afkt:DevRetrofit:1.0.0'
implementation 'io.github.afkt:DevRetrofit:1.0.1'
```

## 框架功能介绍
Expand Down
2 changes: 1 addition & 1 deletion lib/DevWidget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

```gradle
// AndroidX
implementation 'io.github.afkt:DevWidgetX:1.1.8'
implementation 'io.github.afkt:DevWidgetX:1.1.9'
```

## README
Expand Down
2 changes: 1 addition & 1 deletion lib/DevWidget/README_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

```gradle
// AndroidX
implementation 'io.github.afkt:DevWidgetX:1.1.8'
implementation 'io.github.afkt:DevWidgetX:1.1.9'
```

## 目录结构
Expand Down
18 changes: 9 additions & 9 deletions lib/Environment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,18 @@ version | [![][maven_svg]][maven] | [![][maven_svg]][maven] | [![][maven_svg]][m
```groovy
dependencies {
// Java
implementation 'io.github.afkt:DevEnvironment:1.1.0'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0'
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0'
implementation 'io.github.afkt:DevEnvironment:1.1.1'
debugAnnotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1'
releaseAnnotationProcessor 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.1'
// 如果需要 Release 包,支持通过后台数据动态设置配置信息 则使用 debug compiler lib
// annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.0'
// annotationProcessor 'io.github.afkt:DevEnvironmentCompiler:1.1.1'
// Kotlin
implementation 'io.github.afkt:DevEnvironment:1.1.0'
kaptDebug 'io.github.afkt:DevEnvironmentCompiler:1.1.0'
kaptRelease 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.0'
implementation 'io.github.afkt:DevEnvironment:1.1.1'
kaptDebug 'io.github.afkt:DevEnvironmentCompiler:1.1.1'
kaptRelease 'io.github.afkt:DevEnvironmentCompilerRelease:1.1.1'
// 如果需要 Release 包,支持通过后台数据动态设置配置信息 则使用 debug compiler lib
// kapt 'io.github.afkt:DevEnvironmentCompiler:1.1.0'
// kapt 'io.github.afkt:DevEnvironmentCompiler:1.1.1'
}
```

Expand Down Expand Up @@ -332,7 +332,7 @@ DevEnvironment 使用:[DevEnvironmentLibActivity][DevEnvironmentLibActivity]



[maven_svg]: https://img.shields.io/badge/Maven-1.1.0-brightgreen.svg
[maven_svg]: https://img.shields.io/badge/Maven-1.1.1-brightgreen.svg
[maven]: https://search.maven.org/search?q=io.github.afkt
[包目录]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironmentBase/src/main/java/dev/environment
[@Module]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironmentBase/src/main/java/dev/environment/annotation/Module.java
Expand Down
Loading

0 comments on commit 75b179d

Please sign in to comment.