苏分宝项目知识库 (RepoWiki)

苏分宝项目知识库 (RepoWiki)

本目录包含苏分宝电商导购返利项目的完整知识库文档,涵盖前端、后端、管理后台、API 接口、数据库设计、部署运维等全方位内容。

📚 文档结构

复制代码
.qoder/repowiki/
└── zh/
    ├── content/                    # 文档内容
    │   ├── 项目概述.md              # 项目整体介绍与架构总览
    │   ├── 快速开始.md              # 环境搭建与快速入门指南
    │   ├── 前端架构设计/            # Flutter 前端架构设计
    │   │   ├── 前端架构设计.md
    │   │   ├── Flutter 应用架构.md
    │   │   ├── 核心功能模块.md
    │   │   ├── 状态管理机制.md
    │   │   ├── 路由导航系统.md
    │   │   └── 网络层设计.md
    │   ├── 后端架构设计/            # Spring Boot 后端架构设计
    │   │   ├── 后端架构设计.md
    │   │   ├── Spring Boot 模块架构/
    │   │   ├── 核心业务服务/
    │   │   ├── 数据访问层设计.md
    │   │   ├── 安全认证机制.md
    │   │   ├── 第三方服务集成/
    │   │   └── API 设计规范.md
    │   ├── 数据库设计/              # 数据库架构与数据模型
    │   │   ├── 数据库架构设计.md
    │   │   ├── 核心数据模型/
    │   │   ├── 表关系设计.md
    │   │   └── 数据访问层设计.md
    │   ├── API 接口文档/            # REST API 接口说明
    │   │   ├── API 接口文档.md
    │   │   ├── 用户认证 API.md
    │   │   ├── 商品查询 API/
    │   │   ├── 订单管理 API.md
    │   │   ├── 支付相关 API.md
    │   │   ├── 营销活动 API.md
    │   │   ├── 个人中心 API.md
    │   │   └── 系统配置 API.md
    │   ├── 管理后台系统/            # Vue.js 管理后台文档
    │   │   ├── 管理后台系统.md
    │   │   ├── Vue.js 管理后台架构.md
    │   │   ├── 核心管理功能模块/
    │   │   ├── 权限控制系统.md
    │   │   ├── UI 组件库与工具.md
    │   │   ├── 数据表格与表单系统.md
    │   │   └── API 接口集成.md
    │   ├── 第三方集成/              # 第三方服务集成文档
    │   │   ├── 第三方集成.md
    │   │   ├── 支付平台集成/
    │   │   ├── 电商平台集成/
    │   │   └── 其他服务集成/
    │   ├── 部署与运维/              # 部署与运维指南
    │   │   ├── 部署与运维.md
    │   │   ├── 前端部署.md
    │   │   ├── 后端部署.md
    │   │   └── 运维监控.md
    │   ├── 测试策略/                # 测试与质量保证
    │   │   ├── 测试策略.md
    │   │   ├── 单元测试.md
    │   │   ├── 集成测试.md
    │   │   ├── API 接口测试.md
    │   │   ├── 性能测试.md
    │   │   └── Flutter 组件测试.md
    │   ├── 开发规范/                # 开发规范与流程
    │   │   ├── 开发规范.md
    │   │   ├── 代码规范.md
    │   │   ├── Git 工作流程.md
    │   │   ├── 项目结构规范.md
    │   │   └── 开发工具配置.md
    │   ├── 扩展开发/                # 扩展开发与升级指南
    │   │   ├── 扩展开发.md
    │   │   ├── 功能扩展/
    │   │   ├── 技术升级/
    │   │   ├── 插件开发.md
    │   │   └── 架构演进.md
    │   └── 故障排除/                # 故障排查与调试
    │       ├── 故障排除.md
    │       ├── 前端问题排查.md
    │       ├── 后端服务排查.md
    │       ├── 数据库问题排查.md
    │       ├── 第三方集成问题.md
    │       ├── 调试技巧与工具.md
    │       └── 应急响应与预案.md
    └── meta/                        # 元数据
        └── repowiki-metadata.json   # 知识库元数据

🎯 文档概览

1. 项目概述

  • 项目简介: 苏分宝是一套面向中国电商生态的跨平台导购与返利解决方案
  • 技术栈 :
    • 前端:Flutter 3.0+ (Android/iOS/Web)
    • 后端:Spring Boot 2.6.7
    • 管理后台:Vue 2.7.16 + Element UI
  • 核心能力: 商品搜索与比价、优惠券聚合、智能转链、订单与佣金管理、社交电商与分销体系

2. 快速开始

  • 环境要求与安装步骤
  • 项目克隆与依赖安装
  • 环境变量配置
  • 运行与构建命令
  • 故障排查指南

3. 前端架构设计 (Flutter)

  • MVVM 架构: 视图层、模型层、视图模型层职责划分
  • Provider 状态管理: 全局状态与局部状态协同
  • 模块化设计: 按功能域划分模块 (index/search/tao/jd/pdd/dy/vip/order/me)
  • 路由导航: 集中式路由映射与命名路由
  • 网络层: Dio 封装、统一鉴权、错误处理
  • 本地存储: SharedPreferences + SQLite 策略

4. 后端架构设计 (Spring Boot)

  • 模块架构 :
    • mshop-admin: 管理后台 API
    • mshop-app: 移动端 API
    • mshop-shop: 商城核心业务
    • mshop-db: MyBatis-Plus 数据访问
    • mshop-redis: Redis 缓存与消息
    • mshop-log: 日志与审计
    • mshop-gen: 代码生成器
  • 核心技术: MyBatis-Plus、Redis、JWT、Spring Security、Knife4j

5. 数据库设计

  • 数据库架构: MySQL + Redis 混合存储
  • 核心数据模型 :
    • 用户域:用户信息、推广关系、余额积分
    • 商品域:商品信息、优惠券、转链记录
    • 订单域:订单信息、绑定状态、佣金结算
    • 营销域:活动信息、分销关系
    • 系统域:角色权限、系统配置

6. API 接口文档

  • 用户认证 API: 登录注册、JWT 令牌、权限验证
  • 商品查询 API :
    • 淘宝商品查询
    • 京东商品查询
    • 拼多多商品查询
    • 抖音商品查询
    • 唯品会商品查询
    • 通用商品搜索
  • 订单管理 API: 订单查询、订单绑定、佣金查询
  • 支付相关 API: 支付下单、支付回调、退款处理
  • 营销活动 API: 优惠券领取、活动报名、分销推广
  • 个人中心 API: 用户信息、收益明细、提现管理
  • 系统配置 API: 应用配置、版本更新、反馈建议

7. 管理后台系统 (Vue.js)

  • 核心功能模块 :
    • 商品管理:商品上架、下架、推荐
    • 订单管理:订单查询、异常处理
    • 用户管理:用户信息、权限管理
    • 营销管理:活动配置、优惠券发放
    • 系统配置:参数设置、菜单管理
  • 权限控制: RBAC 角色权限模型
  • UI 组件库: Element UI + 自定义组件

8. 第三方集成

  • 支付平台集成 :
    • 支付宝集成
    • 微信支付集成
    • 银行卡支付集成
    • 支付安全机制
  • 电商平台集成 :
    • 淘宝联盟 API
    • 京东联盟 API
    • 拼多多 API
    • 抖音电商 API
    • 唯品会 API
    • 饿了么美团外卖 API
  • 其他服务集成 :
    • 存储服务 (OSS/COS)
    • 短信服务
    • 快递查询
    • 推送通知
    • 地图服务

9. 部署与运维

  • 前端部署 :
    • Android/iOS 打包发布
    • Web 端 Nginx 部署
    • CDN 加速配置
  • 后端部署 :
    • Docker 容器化部署
    • 生产环境配置
    • 负载均衡配置
  • 运维监控 :
    • 日志收集与分析
    • 性能监控与告警
    • 数据库监控

10. 测试策略

  • 单元测试: JUnit + Mockito
  • 集成测试: Spring Boot Test
  • API 接口测试: Postman + Swagger
  • 性能测试: JMeter + Gatling
  • Flutter 组件测试: Flutter Test

11. 开发规范

  • 代码规范: 命名规范、注释规范、格式化规范
  • Git 工作流程: 分支管理、提交规范、Code Review
  • 项目结构规范: 目录组织、文件命名
  • 开发工具配置: IDE 配置、插件推荐

12. 扩展开发

  • 功能扩展 :
    • 电商平台集成扩展
    • 支付方式扩展
    • 营销活动扩展
    • 报表定制扩展
  • 技术升级 :
    • Flutter 版本升级
    • Spring Boot 版本升级
    • 数据库优化
    • 前端性能优化

13. 故障排除

  • 前端问题排查: Flutter 构建问题、平台兼容性问题
  • 后端服务排查: 服务启动失败、接口异常
  • 数据库问题排查: SQL 性能、连接池问题
  • 第三方集成问题: API 调用失败、回调异常
  • 调试技巧与工具: 日志调试、断点调试、性能分析

📖 阅读指南

新手入门

  1. 阅读 项目概述 了解项目整体架构
  2. 按照 快速开始 搭建开发环境
  3. 学习 前端架构设计后端架构设计
  4. 参考 [API 接口文档](./zh/content/API 接口文档/API 接口文档.md) 进行开发

进阶开发

  1. 深入研究 数据库设计
  2. 学习 第三方集成 文档
  3. 参考 扩展开发 进行功能扩展
  4. 遵循 开发规范 编写代码

运维部署

  1. 阅读 部署与运维 文档
  2. 参考 测试策略 进行测试
  3. 遇到问题时查看 故障排除

🔗 相关链接

  • 项目官网: (待补充)
  • GitHub 仓库: (待补充)
  • 开发文档: (待补充)
  • API 测试平台: (待补充)

📝 文档维护

本文档由 RepoWiki 自动生成和维护,确保文档与代码同步更新。如发现文档错误或需要补充,请及时提交 Issue 或 Pull Request。

📄 开源协议

本项目文档遵循与代码相同的开源协议。具体协议内容请查看项目根目录的 LICENSE 文件。


最后更新时间: 2026 年 3 月 20 日

文档版本: v1.0

维护团队: 苏分宝开发团队