Appearance
技术架构
整体架构
日志APP采用前后端分离的架构设计,Android原生客户端 + Node.js后端服务。
┌─────────────────────────────────────────────────────────┐
│ Android Client │
│ (Jetpack Compose + MVVM + Clean Architecture) │
└────────────────┬────────────────────────────────────────┘
│
│ HTTP/HTTPS (Retrofit)
│ WebSocket (Real-time)
│
┌────────────────┴────────────────────────────────────────┐
│ Backend Server │
│ (Node.js + Express.js) │
├──────────────────────────────────────────────────────────┤
│ ┌─────────────┐ ┌──────────────┐ ┌────────────────┐ │
│ │ API │ │ WebSocket │ │ Push Service │ │
│ │ Routes │ │ Server │ │ (Firebase) │ │
│ └─────────────┘ └──────────────┘ └────────────────┘ │
└────────────────┬────────────────────────────────────────┘
│
│ MySQL Protocol
│
┌────────────────┴────────────────────────────────────────┐
│ MySQL Database (阿里云RDS) │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ users │ │ logs │ │ tasks │ │ messages │ │
│ └──────────┘ └──────────┘ └──────────┘ └──────────┘ │
└──────────────────────────────────────────────────────────┘Android端架构
Clean Architecture
采用经典的Clean Architecture分层架构:
android_app/
├── core/ # 核心模块
│ ├── common/ # 通用工具类
│ ├── di/ # 依赖注入配置
│ ├── navigation/ # 导航配置
│ ├── push/ # 推送服务
│ ├── theme/ # 星空主题
│ │ └── components/ # 自定义UI组件
│ └── ui/ # 通用UI组件
│
├── data/ # 数据层
│ ├── api/ # API服务接口定义
│ ├── datastore/ # DataStore本地存储
│ ├── local/ # Room数据库
│ │ ├── dao/ # 数据访问对象
│ │ └── entity/ # 数据库实体
│ ├── model/ # 数据模型
│ ├── remote/ # 网络数据源
│ └── repository/ # Repository实现
│
├── domain/ # 领域层
│ ├── model/ # 领域模型
│ ├── repository/ # Repository接口
│ └── usecase/ # 用例/业务逻辑
│
└── features/ # 功能模块
├── admin/ # 管理员功能
├── auth/ # 认证登录
├── log_edit/ # 日志编辑
├── log_view/ # 日志查看
├── message/ # 消息功能
├── project/ # 项目管理
├── settings/ # 设置
└── statistics/ # 统计分析数据流向
User Action (Composable)
↓
ViewModel.handleAction()
↓
UseCase.execute()
↓
Repository.getData()
↓
DataSource (Remote/Local)
↓
Repository returns Flow/Result
↓
UseCase processes data
↓
ViewModel updates State
↓
Composable recomposes with new State核心技术栈
| 技术 | 用途 | 版本 |
|---|---|---|
| Kotlin | 开发语言 | 1.9.0 |
| Jetpack Compose | UI框架 | 1.5.0 |
| Hilt | 依赖注入 | 2.48 |
| Room | 本地数据库 | 2.6.0 |
| Retrofit | 网络请求 | 2.9.0 |
| OkHttp | HTTP客户端 | 4.11.0 |
| Coroutines | 异步编程 | 1.7.3 |
| Flow | 响应式流 | 内置 |
| DataStore | 数据存储 | 1.0.0 |
| Navigation | 导航组件 | 2.7.0 |
| Coil | 图片加载 | 2.4.0 |
推送通知架构
多厂商推送服务集成:
kotlin
PushManager
├── FirebasePushService # Firebase推送
├── HuaweiPushService # 华为HMS推送
├── XiaomiPushService # 小米推送
├── OppoPushService # OPPO推送
├── VivoPushService # Vivo推送
└── HonorPushService # 荣耀推送特点:
- 自动检测设备厂商
- 智能选择推送通道
- 统一的Token管理
- 推送消息去重
实时通讯架构
WebSocket连接管理:
kotlin
WebSocketManager
├── ConnectionManager # 连接管理
├── MessageHandler # 消息处理
├── HeartbeatManager # 心跳机制
└── ReconnectStrategy # 重连策略功能:
- 自动连接和重连
- 心跳保活
- 消息队列
- 离线消息处理
后端架构
项目结构
backend/
├── src/
│ ├── api/ # API路由
│ │ ├── auth.js # 认证接口
│ │ ├── logs.js # 日志接口
│ │ ├── tasks.js # 任务接口
│ │ ├── projects.js # 项目接口
│ │ ├── messages.js # 消息接口
│ │ ├── users.js # 用户接口
│ │ ├── vehicles.js # 车辆接口
│ │ └── statistics.js # 统计接口
│ │
│ ├── config/ # 配置文件
│ │ ├── database.js # 数据库配置
│ │ └── firebase.js # Firebase配置
│ │
│ ├── services/ # 业务服务
│ │ ├── dingTalkService.js # 钉钉服务
│ │ ├── vehicleService.js # 车辆服务
│ │ └── pushService.js # 推送服务
│ │
│ ├── websocket/ # WebSocket
│ │ ├── socketServer.js # Socket.IO服务
│ │ └── wsServer.js # 原生WebSocket
│ │
│ ├── middleware/ # 中间件
│ │ ├── auth.js # 认证中间件
│ │ └── errorHandler.js # 错误处理
│ │
│ ├── utils/ # 工具函数
│ ├── app.js # Express应用
│ └── server.js # 服务入口
│
├── scripts/ # 脚本工具
│ └── update_database_docs.js # 更新数据库文档
│
├── docs/ # 文档
│ └── database_schema.md # 数据库表结构
│
├── .env # 环境变量
└── package.json # 依赖配置核心技术栈
| 技术 | 用途 | 版本 |
|---|---|---|
| Node.js | 运行环境 | 18.x |
| Express.js | Web框架 | 4.18.0 |
| MySQL | 数据库 | 8.0 |
| Socket.IO | WebSocket | 4.6.0 |
| JWT | 身份验证 | 9.0.0 |
| Multer | 文件上传 | 1.4.5 |
| Firebase Admin | 推送服务 | 11.x |
| Axios | HTTP客户端 | 1.4.0 |
API设计规范
RESTful风格:
GET /api/logs # 获取日志列表
GET /api/logs/:id # 获取单个日志
POST /api/logs # 创建日志
PUT /api/logs/:id # 更新日志
DELETE /api/logs/:id # 删除日志响应格式:
json
{
"success": true,
"data": { },
"message": "操作成功"
}错误响应:
json
{
"success": false,
"error": "错误信息",
"code": "ERROR_CODE"
}WebSocket通讯协议
连接认证:
javascript
socket.emit('authenticate', { token: 'JWT_TOKEN' })消息格式:
javascript
{
type: 'message',
from: 'user_id',
to: 'user_id',
content: '消息内容',
timestamp: 1234567890
}系统事件:
connect- 连接成功disconnect- 断开连接message- 新消息read- 消息已读typing- 正在输入
数据库设计
核心表结构
users (用户表)
sql
CREATE TABLE users (
id VARCHAR(50) PRIMARY KEY,
username VARCHAR(100),
password VARCHAR(255),
avatar TEXT,
role ENUM('admin', 'user'),
created_at TIMESTAMP
)logs (工作日志表)
sql
CREATE TABLE logs (
id INT AUTO_INCREMENT PRIMARY KEY,
user_id VARCHAR(50),
today_work TEXT,
tomorrow_plan TEXT,
project_id INT,
receiver_ids TEXT,
visibility ENUM('private', 'public', 'specified'),
created_at TIMESTAMP
)tasks (任务表)
sql
CREATE TABLE tasks (
id INT AUTO_INCREMENT PRIMARY KEY,
user_id VARCHAR(50),
title VARCHAR(255),
content TEXT,
project_id INT,
status ENUM('todo', 'planned', 'in_progress', 'completed'),
priority ENUM('low', 'medium', 'high'),
due_date DATETIME,
estimated_hours DECIMAL(5,2),
created_at TIMESTAMP
)messages (消息表)
sql
CREATE TABLE messages (
id VARCHAR(100) PRIMARY KEY,
from_user_id VARCHAR(50),
to_user_id VARCHAR(50),
content TEXT,
is_read BOOLEAN DEFAULT FALSE,
created_at TIMESTAMP
)更多表结构详见: 数据库表结构文档
部署架构
服务器环境
阿里云ECS服务器
├── CentOS 7
├── Node.js 18.x
├── Nginx (反向代理)
├── PM2 (进程管理)
└── 阿里云RDS MySQL部署流程
- 后端部署
bash
# 上传代码到服务器
scp -r backend/ root@8.147.129.77:/var/www/
# 安装依赖
npm install --production
# 使用nohup启动
nohup /usr/bin/node server.js > server.log 2>&1 &- Android部署
bash
# 编译APK
./gradlew assembleRelease
# 上传到服务器
./deploy-android.sh [version] "[description]"- 域名配置
- 主域名: bjbmkj.cn
- API地址: http://8.147.129.77:3003/api/
- 文档站点: docs.bjbmkj.cn (待配置)
安全机制
认证授权
- JWT Token认证
- Token过期自动刷新
- 角色权限控制(RBAC)
数据安全
- HTTPS加密传输
- 密码BCrypt加密
- SQL注入防护
- XSS攻击防护
文件安全
- 文件类型验证
- 文件大小限制
- 文件名安全处理
- 存储路径隔离
性能优化
前端优化
- 图片智能压缩 (最大600KB)
- 分页加载数据
- 本地数据缓存
- LazyColumn虚拟列表
- 图片懒加载
后端优化
- 数据库连接池
- SQL查询优化
- Redis缓存(计划中)
- API响应压缩
- 静态资源CDN(计划中)
网络优化
- HTTP/2支持
- Gzip压缩
- 请求合并
- 智能重试机制
