admin123
/
shop-back-end
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
shop-back-end/doc/README.md

3.8 KiB
Raw Blame History

项目文档目录

欢迎使用 AgileBoot 电商后端系统文档。本文档提供了项目的完整说明和使用指南。

📚 文档列表

核心文档

  1. 项目概述 - 项目整体介绍、技术栈、架构特点
  2. 快速启动指南 - 快速上手，环境配置和启动步骤
  3. API接口文档 - 完整的API接口说明和使用示例

功能模块文档

  1. 企业微信集成指南 - 企业微信应用集成详细指南
  2. 微信支付集成指南 - 微信支付功能集成和使用说明
  3. 智能柜系统指南 - 智能柜设备管理和操作指南
  4. 缓存系统指南 - Caffeine缓存系统使用和优化

运维部署文档

  1. 部署运维指南 - 生产环境部署、监控和运维指南

第三方文档

  1. 第三方文档 - 第三方服务集成文档

🚀 快速开始

如果你是第一次接触本项目，建议按以下顺序阅读文档：

  1. 首先阅读: 项目概述 - 了解项目整体情况
  2. 然后阅读: 快速启动指南 - 快速搭建开发环境
  3. 接着阅读: API接口文档 - 了解系统功能接口

🔧 功能模块

电商核心功能

  • 商品管理：商品分类、商品信息、库存管理
  • 订单管理：订单创建、支付、退款、物流跟踪
  • 用户管理：微信用户信息、会员体系
  • 支付系统：微信支付集成、支付回调处理

企业微信集成

  • 企微认证：企业微信应用授权管理
  • 部门管理：企微部门同步和管理
  • 消息推送：企微应用消息发送
  • 用户同步：企微用户与系统用户关联

智能柜系统

  • 柜体管理：智能柜设备管理
  • 格口操作：柜体格口状态监控
  • 企业微信集成：支持corpid字段的企业微信对接

系统管理

  • 用户权限：RBAC权限模型
  • 数据字典：系统常量管理
  • 操作日志：完整的操作审计
  • 系统监控：缓存监控、服务状态监控

🛠️ 技术特性

架构特点

  • DDD领域驱动设计: 采用CQRS模式，分离查询和命令操作
  • 多级缓存: Caffeine本地缓存 + Redis分布式缓存
  • 权限控制: 基于注解的菜单权限和数据权限
  • 企业微信集成: 完整的企微应用集成方案
  • 微信支付: 支持JSAPI支付和退款功能

性能优化

  • Caffeine本地缓存提升访问性能
  • 数据库连接池优化
  • 异步处理耗时操作
  • 合理的索引设计

📋 环境要求

开发环境

  • JDK 1.8+
  • MySQL 8.0+
  • Redis 6.0+
  • Maven 3.6+
  • Node.js 16+ (前端)

生产环境

  • 支持Docker容器化部署
  • 支持多环境配置
  • 内置监控和健康检查

🔍 问题排查

如果在使用过程中遇到问题，可以：

  1. 查看对应模块的详细文档
  2. 检查日志文件中的错误信息
  3. 参考常见问题解决方案
  4. 联系技术支持

📞 技术支持

  • 项目地址: [GitHub Repository]
  • 问题反馈: 通过GitHub Issues提交问题
  • 交流群: 参考项目README中的联系方式

📄 许可证

本项目采用MIT许可证，详情请参考LICENSE文件。

最后更新: 2025-10-15

如果发现文档有误或需要补充，欢迎提交Pull Request或Issue。