|
|
@@ -0,0 +1,192 @@
|
|
|
+# 新大洲智能车控 Android 应用
|
|
|
+
|
|
|
+## 项目简介
|
|
|
+
|
|
|
+新大洲智能车控是一款基于 Android 平台的智能车辆控制应用，采用现代化的 MVVM 架构和 Clean Architecture 设计理念开发。
|
|
|
+
|
|
|
+## 技术栈
|
|
|
+
|
|
|
+- **开发语言**: Kotlin
|
|
|
+- **架构模式**: MVVM + Clean Architecture
|
|
|
+- **UI 框架**: AndroidX + Material Design
|
|
|
+- **网络请求**: Retrofit + OkHttp
|
|
|
+- **异步处理**: Coroutines + Flow
|
|
|
+- **导航**: Navigation Component
|
|
|
+- **依赖注入**: 手动依赖注入（Factory 模式）
|
|
|
+
|
|
|
+## 项目结构
|
|
|
+
|
|
|
+```
|
|
|
+xdz_android/
|
|
|
+├── app/ # 应用主模块
|
|
|
+├── base-core/ # 核心基础模块（日志、存储、工具等）
|
|
|
+├── base-common/ # 通用基础模块（网络、配置等）
|
|
|
+├── capability-ble/ # BLE 蓝牙能力模块
|
|
|
+├── capability-nfc/ # NFC 能力模块
|
|
|
+├── capability-push/ # 推送能力模块（极光推送）
|
|
|
+├── capability-qrcode/ # 二维码能力模块
|
|
|
+├── capability-share/ # 分享能力模块（友盟分享）
|
|
|
+└── capability-socketio/ # Socket.IO 能力模块
|
|
|
+```
|
|
|
+
|
|
|
+## 功能特性
|
|
|
+
|
|
|
+### 已实现功能
|
|
|
+
|
|
|
+- ✅ 用户系统（登录、注册、Token 管理）
|
|
|
+- ✅ 版本更新检查
|
|
|
+- ✅ 分享功能（微信、QQ、微博等）
|
|
|
+- ✅ 推送功能（极光推送）
|
|
|
+- ✅ BLE 蓝牙通信
|
|
|
+- ✅ NFC 功能
|
|
|
+- ✅ 二维码扫描
|
|
|
+- ✅ Socket.IO 实时通信
|
|
|
+
|
|
|
+### 分享功能
|
|
|
+
|
|
|
+支持分享到以下平台：
|
|
|
+- 微信（好友、朋友圈）
|
|
|
+- QQ（好友、空间）
|
|
|
+- 微博
|
|
|
+- 系统分享
|
|
|
+
|
|
|
+### 推送功能
|
|
|
+
|
|
|
+集成极光推送 SDK，支持：
|
|
|
+- 消息推送
|
|
|
+- 通知栏推送
|
|
|
+- 自定义消息处理
|
|
|
+
|
|
|
+## 快速开始
|
|
|
+
|
|
|
+### 环境要求
|
|
|
+
|
|
|
+- Android Studio Hedgehog | 2023.1.1 或更高版本
|
|
|
+- JDK 17
|
|
|
+- Android SDK API 26+
|
|
|
+- Gradle 8.0+
|
|
|
+
|
|
|
+### 配置步骤
|
|
|
+
|
|
|
+1. **克隆项目**
|
|
|
+ ```bash
|
|
|
+ git clone https://git.flowbb.top/humuyu/xdz-app.git
|
|
|
+ cd xdz-app
|
|
|
+ ```
|
|
|
+
|
|
|
+2. **配置本地 SDK 路径**
|
|
|
+
|
|
|
+ 在项目根目录创建或编辑 `local.properties` 文件：
|
|
|
+ ```properties
|
|
|
+ sdk.dir=/path/to/your/android/sdk
|
|
|
+ ```
|
|
|
+
|
|
|
+3. **配置应用密钥**
|
|
|
+
|
|
|
+ 编辑 `app/src/main/res/values/strings.xml`，配置以下密钥：
|
|
|
+ ```xml
|
|
|
+ <!-- 极光推送配置 -->
|
|
|
+ <string name="jpush_app_key">your_jpush_appkey_here</string>
|
|
|
+
|
|
|
+ <!-- 友盟分享配置 -->
|
|
|
+ <string name="share_umeng_app_key">your_umeng_appkey_here</string>
|
|
|
+
|
|
|
+ <!-- 微信分享配置 -->
|
|
|
+ <string name="share_wechat_app_id">your_wechat_appid_here</string>
|
|
|
+ <string name="share_wechat_app_secret">your_wechat_appsecret_here</string>
|
|
|
+
|
|
|
+ <!-- QQ 分享配置 -->
|
|
|
+ <string name="share_qq_app_id">your_qq_appid_here</string>
|
|
|
+ <string name="share_qq_app_key">your_qq_appkey_here</string>
|
|
|
+
|
|
|
+ <!-- 微博分享配置 -->
|
|
|
+ <string name="share_weibo_app_key">your_weibo_appkey_here</string>
|
|
|
+ <string name="share_weibo_app_secret">your_weibo_appsecret_here</string>
|
|
|
+ ```
|
|
|
+
|
|
|
+4. **同步项目**
|
|
|
+
|
|
|
+ 在 Android Studio 中打开项目，等待 Gradle 同步完成。
|
|
|
+
|
|
|
+5. **运行应用**
|
|
|
+
|
|
|
+ 连接 Android 设备或启动模拟器，点击运行按钮。
|
|
|
+
|
|
|
+## 模块说明
|
|
|
+
|
|
|
+### base-core
|
|
|
+
|
|
|
+核心基础模块，提供：
|
|
|
+- 日志系统（ILog）
|
|
|
+- 存储接口（IStorage）
|
|
|
+- 工具类接口（IUtil）
|
|
|
+- 执行器接口（IExecutor）
|
|
|
+- 配置接口（IConfig）
|
|
|
+- 桥接接口（IBridge）
|
|
|
+
|
|
|
+### base-common
|
|
|
+
|
|
|
+通用基础模块，提供：
|
|
|
+- 网络请求（HttpApiClient）
|
|
|
+- 服务器配置管理（ServerConfigManager）
|
|
|
+- API 响应解析（ApiResponseParser）
|
|
|
+
|
|
|
+### capability-share
|
|
|
+
|
|
|
+分享能力模块，基于友盟分享 SDK：
|
|
|
+- 支持多平台分享
|
|
|
+- 自动处理回调
|
|
|
+- 统一的分享接口
|
|
|
+
|
|
|
+详细文档请参考：[capability-share/集成说明.md](capability-share/集成说明.md)
|
|
|
+
|
|
|
+### capability-push
|
|
|
+
|
|
|
+推送能力模块，基于极光推送 SDK：
|
|
|
+- 消息推送
|
|
|
+- 通知栏推送
|
|
|
+- 自定义消息处理
|
|
|
+
|
|
|
+详细文档请参考：[capability-push/集成说明.md](capability-push/集成说明.md)
|
|
|
+
|
|
|
+## 开发规范
|
|
|
+
|
|
|
+### 代码规范
|
|
|
+
|
|
|
+- 遵循 Kotlin 官方编码规范
|
|
|
+- 使用有意义的变量和函数名
|
|
|
+- 添加必要的注释和文档
|
|
|
+- 保持代码简洁和可读性
|
|
|
+
|
|
|
+### 提交规范
|
|
|
+
|
|
|
+使用 Conventional Commits 规范：
|
|
|
+
|
|
|
+- `feat`: 新功能
|
|
|
+- `fix`: 修复 bug
|
|
|
+- `docs`: 文档更新
|
|
|
+- `style`: 代码格式调整
|
|
|
+- `refactor`: 代码重构
|
|
|
+- `test`: 测试相关
|
|
|
+- `chore`: 构建/工具相关
|
|
|
+
|
|
|
+示例：
|
|
|
+```bash
|
|
|
+git commit -m "feat: 添加分享功能"
|
|
|
+git commit -m "fix: 修复登录失败问题"
|
|
|
+```
|
|
|
+
|
|
|
+## 文档
|
|
|
+
|
|
|
+- [项目结构文档](PROJECT_STRUCTURE.md)
|
|
|
+- [开发指南](DEVELOPMENT_GUIDE.md)
|
|
|
+- [MVVM 架构文档](MVVM_ARCHITECTURE.md)
|
|
|
+
|
|
|
+## 许可证
|
|
|
+
|
|
|
+Copyright © 2024 新大洲本田
|
|
|
+
|
|
|
+## 联系方式
|
|
|
+
|
|
|
+如有问题或建议，请联系开发团队。
|
|
|
+
|
wangmeng