Commit 36c8b761 by 郑娜伟

添加文档 README.md

parent e0e643ed
模块化测试项目
##模块说明
1、sobot_gson json数据模块,目前工单SDK使用,主要用于json数据处理。
2、sobot_pictureframe 图片框架模块,目前工单SDK使用,主要用于图片加载显示。
3、sobot_network 网络请求模块,目前客户SDK,工单SDK,客服APP使用;基础网络请求。
4、sobot_utils 工具模块,目前客户SDK,工单SDK使用;包含时间日期、常用工具方法。
5、sobot_common:基础模块,把1-4的模块整合为一个统一的,并且包含基础的baseactivity和头部界面。
6、sobot_widget 自定义控件模块,目前工单SDK使用;包含下拉控件、加载过程变化控件、图片放大展示控件。
## 模块使用方法
```
引用方式 依赖方式
api 'com.sobot.library:模块名字:版本号'
例如
api 'com.sobot.library:sobotcommon:1.1.8'
api 'com.sobot.library:utils:1.1.1'
api 'com.sobot.library:picture:1.1'
api 'com.sobot.library:net:1.1.1'
api 'com.sobot.library:gson:1.1.1'
api 'com.sobot.library:widget:0.6'
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
子module --> sobot-xx-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> 选择模块 --> Tasks --> build --> assemble
//发布
Gradle窗口 --> 模块 --> Tasks --> build --> publishing --> 点击publishReleasePublicationToXXXXXRepository 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
智齿基础模块
图片库、网络库、工具库、Gson库的整合,并且包含基础的baseactivity和头部界面
##集成方法
```
依赖方式
api 'com.sobot.library:sobotcommon:xxx'
例如
api 'com.sobot.library:sobotcommon:1.1.8'
```
##版本说明
###1.1.8
1、正式使用版本
###1.0
首次发布
##使用方法
```
// 初始化
SobotCommonApi.init(application);
// 日志显示开关
SobotCommonApi.setShowLogDebug(true);
// 设置开关状态 横竖屏,刘海屏
SobotCommonApi.setSwitchMarkStatus(SobotMarkConfig.LANDSCAPE_SCREEN,true);
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
子module --> sobot-xx-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> 选择模块 --> Tasks --> build --> assemble
//发布
Gradle窗口 --> 模块 --> Tasks --> build --> publishing --> 点击publishReleasePublicationToXXXXXRepository 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
##发布注意事项
基础模块有两个版本需要发布,support和androidX ,发布时注释不需要,然后推送
```
//support
api 'com.sobot.library:utils:1.1.1'
api 'com.sobot.library:picture:1.1'
api 'com.sobot.library:net:1.1.1'
api 'com.sobot.library:gson:1.1.1'
//androidX
// api 'com.sobot.library:utils:1.1.1'
// api 'com.sobot.library:picture_x:1.1'
// api 'com.sobot.library:net:1.1.1'
// api 'com.sobot.library:gson:1.1.1'
```
智齿json数据解析模块
主要用于数据处理:json格式的数据的解析转换
##集成方法
```
依赖方式
api 'com.sobot.library:gson:xxx'
例如
api 'com.sobot.library:gson:1.1.1'
```
##版本说明
###1.1.1
1、正式使用版本
###1.0
首次发布
##使用方法
```
// 将对象转成json格式
SobotGsonUtil.beanToJson();
// 将 json 转成特定的 cls 的对象
SobotGsonUtil.jsonToBean();
// 将 json 转成特定的 cls 的对象,解决对象使用泛型的问题
SobotGsonUtil.jsonToBeans();
// json字符串转成list
SobotGsonUtil.jsonToList();
// json 字符串转成 list map
SobotGsonUtil.jsonToListMaps();
// json 字符串转成 map
SobotGsonUtil.jsonToMaps();
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
sobot_gson --> sobot-gson-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> sobot_gson --> Tasks --> build --> assemble
//发布
Gradle窗口 --> sobot_gson --> Tasks --> build --> publishing --> 点击publishReleasePublicationToMavenLocal 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
智齿网络请求模块
##集成方法
```
依赖方式
api 'com.sobot.library:net:XXX'
例如
api 'com.sobot.library:net:1.1.1'
```
##版本说明
###1.1.1
1、正式使用版本
###1.0
首次发布
##使用方法
```
// 初始化 使用该网络库必须先执行初始化
SobotHttpUtils.init();
// post请求
SobotHttpUtils.doPost();
// get请求
SobotHttpUtils.doGet();
// 上传
SobotHttpUtils.uploadFile();
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
sobot_network --> sobot-network-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> sobot_network --> Tasks --> build --> assemble
//发布
Gradle窗口 --> sobot_network --> Tasks --> build --> publishing --> 点击 publishReleasePublicationToNetRepository 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
图片框架模块
支持glide、picasso、universal-image-loader图片框架
##集成方法
```
依赖方式
api 'com.sobot.library:模块名字:版本号'
例如
//support版
api 'com.sobot.library:picture:1.1'
//androidx版
api 'com.sobot.library:picture_x:1.1'
```
##版本说明
###1.1
1、正式使用版本
###1.0
首次发布
##使用方法
```
// 显示图片
SobotBitmapUtil.display();
// 指定一个你自己的SobotImageLoader,优先使用您自己的图片库
SobotBitmapUtil.setImageLoader
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
sobot_pictureframe --> sobot-picture-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> sobot_pictureframe --> Tasks --> build --> assemble
//发布
Gradle窗口 --> sobot_pictureframe --> Tasks --> build --> publishing --> 点击 publishReleasePublicationToPictureRepository 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
##发布注意事项
1、基础模块有两个版本需要发布,support和androidX ,发布时注释不需要,然后推送
```
//support
api 'com.sobot.library:picture:xxx'
//androidX
api 'com.sobot.library:picture_x:xx'
```
2、如果三个框架(glide、picasso、universal-image-loader)都引用,优先级顺序是glide <-- picasso <-- universal-image-loader,glide 优先级最高
3、 在使用4.9.0(包含4.9.0)以上版本的glide时,需额外添加依赖,之前的版本不需要
```
implementation 'com.sobot.chat:sobotsupport-glidev4:2.1'
```
4、picasso不支持显示本地图片
5、如果您先使用自己的图片库,可以设置SobotBitmapUtil.setImageLoader(自定义一个SobotImageLoader),会优先使用您自己的图片库
工具模块
##集成方法
```
依赖方式
api 'com.sobot.library:utils:xxx'
例如
api 'com.sobot.library:utils:1.1.1'
```
##版本说明
###1.1.1
1、正式使用版本
###1.0
首次发布
##工具类表
```
| 名称 | 说明 |
| :--------------- | :------------------------------------------ |
| SobotDateUtil | 日期时间工具类 |
| SobotDensityUtil | 常用单位转换的辅助类 |
| SobotFastClickUtils | 按钮防快速按钮点击 |
| SobotIOUtils | io工具类 |
| SobotLogUtils | 日志工具类 |
| SobotMD5Util | md5加密 |
| SobotNetUtils | 网络连接工具类 |
| SobotRegularUtils | 常用的正则表达式 |
| SobotSDCardUtils | SD 工具类 |
| SobotSharedPreferencesUtil | 数据保存工具类 |
| SobotSoftKeyboardUtils | 软件键盘管理工具类 |
| SobotStringUtils | 字符串工具类 |
| SobotSystemUtils | 软件系统参数工具类 |
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
sobot_utils --> sobot-utils-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> sobot_utils --> Tasks --> build --> assemble
//发布
Gradle窗口 --> sobot_utils --> Tasks --> build --> publishing --> 点击 publishReleasePublicationToMavenLocal 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
自定义控件模块
包含下拉控件、加载过程变化控件、图片放大展示控件
##集成方法
```
依赖方式
api 'com.sobot.library:widget:xxx'
例如
api 'com.sobot.library:widget:0.6'
```
##版本说明
###0.6
1、正式使用版本
##自定义控件表
```
//可放大移动的图片控件
<com.sobot.widget.image.photoview>
//加载过程 加载中、空数据,加载失败,加载完成显示内容
<com.sobot.widget.loading.SobotLoadingLayout>
//下拉控件
<com.sobot.widget.refresh.layout.SobotRefreshLayout>
```
## 模块发布方法
* 提交代码
* 打包aar
* 推送到maven
* 发布
```
//修改版本号
sobot_widget --> sobot-widget-publish-mavencentral.gradle --> 修改PUBLISH_VERSION对应的值
//打包生成aar
Gradle窗口 --> sobot_widget --> Tasks --> build --> assemble
//发布
Gradle窗口 --> sobot_widget --> Tasks --> build --> publishing --> 点击 publishReleasePublicationToSobotwidgetRepository 推送
推送成功后登录https://s01.oss.sonatype.org 发布
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment