# FuYu.Docs

**Repository Path**: me860/fuyu-docs

## Basic Information

- **Project Name**: FuYu.Docs
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-31
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FuYu GitLab 项目文档中心

本文档集合用于记录各个项目的技术说明，方便AI跨项目开发时快速了解项目结构和技术栈。

## 系统架构总览

```
┌─────────────────────────────────────────────────────────────────────────────────────┐
│                                    前端应用层                                        │
├──────────────────┬──────────────────┬──────────────────┬───────────────────────────┤
│   studentCard    │    FuYu.Admin    │   fuyu-plus      │      Web Applications     │
│   (微信小程序)    │   (Vue管理后台)   │  (Spring Boot)   │                           │
└────────┬─────────┴────────┬─────────┴────────┬─────────┴─────────────┬─────────────┘
         │                  │                  │                       │
         ▼                  ▼                  ▼                       ▼
┌─────────────────────────────────────────────────────────────────────────────────────┐
│                                   API 网关层                                         │
│                            (OAuth 统一认证入口)                                       │
└─────────────────────────────────────────────────────────────────────────────────────┘
         │                  │                  │                       │
         ▼                  ▼                  ▼                       ▼
┌─────────────────────────────────────────────────────────────────────────────────────┐
│                                   业务服务层                                         │
├──────────────┬──────────────┬──────────────┬──────────────┬─────────────────────────┤
│  FuYu.OAuth  │  FuYu.Edu    │ FuYu.EShop   │ FuYu.CardApp │ FuYu.Platform.Management│
│  (认证服务)   │  (教育服务)   │  (电商服务)   │  (卡应用)    │      (平台管理)          │
├──────────────┼──────────────┼──────────────┼──────────────┼─────────────────────────┤
│   devices    │  FuYu.Ai     │fuyu-plus-data│question-bank │  FuYu.WeChatManagement  │
│  (设备服务)   │  (AI服务)    │  (数据服务)   │  (题库中心)   │      (微信管理)          │
└──────────────┴──────────────┴──────────────┴──────────────┴─────────────────────────┘
         │                  │                  │                       │
         ▼                  ▼                  ▼                       ▼
┌─────────────────────────────────────────────────────────────────────────────────────┐
│                                  基础模块层                                          │
├───────────────────────┬───────────────────────┬─────────────────────────────────────┤
│    FuYu.AbpModules    │    FuYu.Abp.MIOT      │        FuYu.IOTs.OneLink            │
│    (ABP通用模块库)     │    (米家物联网模块)     │        (中移物联网模块)              │
├───────────────────────┴───────────────────────┴─────────────────────────────────────┤
│                               spec-kit (规格工具库)                                  │
└─────────────────────────────────────────────────────────────────────────────────────┘
         │                  │                  │                       │
         ▼                  ▼                  ▼                       ▼
┌─────────────────────────────────────────────────────────────────────────────────────┐
│                                  基础设施层                                          │
├────────────┬────────────┬────────────┬────────────┬────────────┬───────────────────┤
│   MySQL    │   Redis    │ RabbitMQ   │   MQTT     │Elasticsearch│   腾讯云COS       │
│  (主数据库)  │  (缓存)     │ (消息队列)  │ (物联网通信) │  (搜索引擎)  │  (对象存储)        │
└────────────┴────────────┴────────────┴────────────┴────────────┴───────────────────┘
```

## 技术栈概览

### 后端技术栈

| 分类 | .NET 项目 | Java 项目 |
|------|-----------|-----------|
| **核心框架** | ABP Framework 8.2.1 | Spring Boot 2.7.3 |
| **运行时** | .NET 8.0 | JDK 1.8 |
| **ORM框架** | Entity Framework Core | MyBatis-Plus 3.5.2 |
| **数据库** | MySQL 8.0 | MySQL 8.0 |
| **缓存** | Redis + StackExchange.Redis | Redis + Redisson |
| **消息队列** | RabbitMQ + DotNetCore.CAP | RabbitMQ + Spring AMQP |
| **搜索引擎** | Elasticsearch 7.x (NEST) | Elasticsearch 7.x |
| **认证授权** | IdentityServer / OpenIddict | - |
| **API文档** | Swagger | Knife4j 4.3.0 |
| **物联网** | MQTT (MQTTnet) | MQTT (Eclipse Paho) |

### 前端技术栈

| 项目 | 技术栈 | 说明 |
|------|--------|------|
| studentCard | 微信小程序 + TypeScript | 学生卡移动端应用 |
| FuYu.Admin | Vue 3 + Element Plus | 管理后台前端 |
| spec-kit | TypeScript + Vitest | 规格工具库 |

## 项目分类

### 🔐 认证与授权

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| FuYu.OAuth | 统一认证授权服务，支持OAuth2.0/OIDC | ABP + IdentityServer | [查看](./FuYu.OAuth/README.md) |
| FuYu.WeChatManagement | 微信公众号/小程序集成管理 | ABP Framework | [查看](./FuYu.WeChatManagement/README.md) |

### 📚 核心业务服务

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| FuYu.Edu | 教育业务服务（学生、班级、宿舍等） | ABP Framework | [查看](./FuYu.Edu/README.md) |
| FuYu.EShop | 电商服务（商品、订单、支付、物流） | ABP Framework | [查看](./FuYu.EShop/README.md) |
| FuYu.CardApp | 一卡通应用（考勤、亲情号、即时通讯） | ABP Framework | [查看](./FuYu.CardApp/README.md) |
| devices | 设备管理服务（设备、定位、围栏、会员） | ABP Framework | [查看](./devices/README.md) |

### 📊 数据服务

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| fuyu-plus | 前端业务服务（音频、任务、积分） | Spring Boot | [查看](./fuyu-plus/README.md) |
| fuyu-plus-data | 数据统计服务（音频、播放、统计） | Spring Boot | [查看](./fuyu-plus-data/README.md) |
| question-bank-center | 题库中心（题目、组卷、练习） | Spring Boot | [查看](./question-bank-center/README.md) |

### 🤖 AI服务

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| FuYu.Ai | AI对话、语音处理、命令执行 | .NET Aspire + Semantic Kernel | [查看](./FuYu.Ai/README.md) |

### 🔧 物联网服务

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| FuYu.Abp.MIOT | 米家物联网平台集成 | ABP Framework | [查看](./FuYu.Abp.MIOT/README.md) |
| FuYu.IOTs.OneLink | 中移OneLink物联网卡管理 | ABP Framework | [查看](./FuYu.IOTs.OneLink/README.md) |

### 🛠️ 基础设施

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| FuYu.AbpModules | ABP通用模块库（AI、告警、验证码等） | ABP Framework | [查看](./FuYu.AbpModules/README.md) |
| FuYu.Platform.Management | 平台统一管理后台 | ABP Framework | [查看](./FuYu.Platform.Management/README.md) |
| spec-kit | TypeScript规格工具库 | TypeScript | [查看](./spec-kit/README.md) |

### 📱 前端应用

| 项目 | 说明 | 技术栈 | 文档 |
|------|------|--------|------|
| studentCard | 学生卡微信小程序 | 微信小程序 + TypeScript | [查看](./studentCard/README.md) |

## 跨项目依赖关系图

```
                                    ┌─────────────────┐
                                    │   FuYu.OAuth    │
                                    │   (认证中心)     │
                                    └────────┬────────┘
                                             │
                    ┌────────────────────────┼────────────────────────┐
                    │                        │                        │
                    ▼                        ▼                        ▼
           ┌───────────────┐        ┌───────────────┐        ┌───────────────┐
           │  FuYu.Edu     │        │  FuYu.EShop   │        │   devices     │
           │  (教育服务)    │        │  (电商服务)    │        │  (设备服务)    │
           └───────┬───────┘        └───────┬───────┘        └───────┬───────┘
                   │                        │                        │
                   │         ┌──────────────┼──────────────┐         │
                   │         │              │              │         │
                   ▼         ▼              ▼              ▼         ▼
           ┌───────────────────────────────────────────────────────────────┐
           │                       FuYu.CardApp                            │
           │                       (一卡通服务)                              │
           └───────────────────────────────┬───────────────────────────────┘
                                           │
                   ┌───────────────────────┼───────────────────────┐
                   │                       │                       │
                   ▼                       ▼                       ▼
        ┌─────────────────┐     ┌─────────────────┐     ┌─────────────────┐
        │   fuyu-plus     │     │ fuyu-plus-data  │     │ question-bank   │
        │  (前端服务)      │     │   (数据服务)     │     │   (题库中心)     │
        └────────┬────────┘     └────────┬────────┘     └─────────────────┘
                 │                       │
                 │       ┌───────────────┘
                 │       │
                 ▼       ▼
        ┌─────────────────────┐
        │    FuYu.Ai          │
        │    (AI服务)          │
        └─────────────────────┘


物联网依赖链:
┌─────────────────┐      ┌─────────────────────┐      ┌─────────────────┐
│    devices      │─────>│   FuYu.Abp.MIOT     │─────>│ 米家云平台       │
│   (设备服务)     │      │   (米家物联网)        │      │                 │
└─────────────────┘      └─────────────────────┘      └─────────────────┘
         │
         │               ┌─────────────────────┐      ┌─────────────────┐
         └──────────────>│ FuYu.IOTs.OneLink   │─────>│ 中移OneLink     │
                         │   (物联网卡)         │      │                 │
                         └─────────────────────┘      └─────────────────┘


微信生态依赖:
┌─────────────────┐      ┌─────────────────────┐      ┌─────────────────┐
│   studentCard   │─────>│FuYu.WeChatManagement│─────>│   FuYu.OAuth    │
│   (微信小程序)   │      │   (微信管理)          │      │   (统一认证)     │
└─────────────────┘      └─────────────────────┘      └─────────────────┘


基础模块依赖:
┌─────────────────────────────────────────────────────────────────────────┐
│                          所有 .NET 业务项目                              │
│  (FuYu.OAuth, FuYu.Edu, FuYu.EShop, FuYu.CardApp, devices, FuYu.Ai)    │
└─────────────────────────────────────┬───────────────────────────────────┘
                                      │
                                      ▼
                           ┌─────────────────────┐
                           │   FuYu.AbpModules   │
                           │   (通用模块库)        │
                           └─────────────────────┘
```

## 通信协议与集成方式

### 服务间通信

| 通信方式 | 使用场景 | 相关项目 |
|----------|----------|----------|
| **HTTP/REST** | 同步API调用 | 所有项目 |
| **gRPC** | 高性能内部服务调用 | devices, FuYu.Ai |
| **RabbitMQ** | 异步消息、分布式事件 | 所有后端项目 |
| **MQTT** | 设备实时通信 | devices, fuyu-plus, fuyu-plus-data |
| **SignalR** | 实时Web通信 | FuYu.CardApp (即时通讯) |
| **Feign** | Java服务间调用 | fuyu-plus, fuyu-plus-data |

### 主要消息队列

| 队列/交换机 | 用途 | 生产者 | 消费者 |
|------------|------|--------|--------|
| FuYu.Edu.Events | 教育业务事件 | FuYu.Edu | FuYu.CardApp, devices |
| FuYu.EShop.Orders | 订单事件 | FuYu.EShop | fuyu-plus, devices |
| FuYu.Device.Location | 设备位置上报 | devices | fuyu-plus-data |
| FuYu.Audio.Statistics | 音频统计 | fuyu-plus | fuyu-plus-data |
| FuYu.ScoreFlow.update | 积分流水 | fuyu-plus | fuyu-plus-data |

## 数据库规划

| 数据库 | 所属项目 | 说明 |
|--------|----------|------|
| fuyu_oauth | FuYu.OAuth | 认证授权数据 |
| fuyu_edu | FuYu.Edu | 教育业务数据 |
| fuyu_eshop | FuYu.EShop | 电商业务数据 |
| fuyu_cardapp | FuYu.CardApp | 一卡通数据 |
| fuyu_devices | devices | 设备管理数据 |
| fuyu_onelink | FuYu.IOTs.OneLink | 物联网卡数据 |
| fuyu_plus | fuyu-plus | 前端业务数据 |
| fuyu_plus_data | fuyu-plus-data | 数据统计 |
| fuyu_question | question-bank-center | 题库数据 |
| fuyu_ai | FuYu.Ai | AI服务数据 |
| fuyu_management | FuYu.Platform.Management | 平台管理数据 |

## 部署环境

| 环境 | 说明 | 配置文件后缀 |
|------|------|-------------|
| dev | 开发环境 | -dev |
| test | 测试环境 | -test |
| stag | 预发布环境 | -stag |
| prod | 生产环境 | -prod |

## AI跨项目开发指南

### 快速定位项目

1. **需要认证授权** → 查看 [FuYu.OAuth](./FuYu.OAuth/README.md)
2. **教育相关业务** → 查看 [FuYu.Edu](./FuYu.Edu/README.md)
3. **电商/订单/支付** → 查看 [FuYu.EShop](./FuYu.EShop/README.md)
4. **学生卡/考勤** → 查看 [FuYu.CardApp](./FuYu.CardApp/README.md)
5. **设备管理/定位** → 查看 [devices](./devices/README.md)
6. **音频/任务/积分** → 查看 [fuyu-plus](./fuyu-plus/README.md)
7. **数据统计分析** → 查看 [fuyu-plus-data](./fuyu-plus-data/README.md)
8. **AI对话/语音** → 查看 [FuYu.Ai](./FuYu.Ai/README.md)
9. **物联网设备** → 查看 [FuYu.Abp.MIOT](./FuYu.Abp.MIOT/README.md)
10. **物联网SIM卡** → 查看 [FuYu.IOTs.OneLink](./FuYu.IOTs.OneLink/README.md)
11. **微信集成** → 查看 [FuYu.WeChatManagement](./FuYu.WeChatManagement/README.md)
12. **题库/练习** → 查看 [question-bank-center](./question-bank-center/README.md)
13. **通用ABP模块** → 查看 [FuYu.AbpModules](./FuYu.AbpModules/README.md)
14. **平台管理后台** → 查看 [FuYu.Platform.Management](./FuYu.Platform.Management/README.md)

### 跨项目开发注意事项

1. **租户隔离**: 所有业务数据都有 TenantId，跨项目查询需要注意租户上下文
2. **认证统一**: 所有服务通过 FuYu.OAuth 进行统一认证
3. **事件驱动**: 跨服务数据同步优先使用 RabbitMQ 事件
4. **API版本**: 注意各项目的API版本控制
5. **数据库隔离**: 每个服务独立数据库，避免直接跨库查询

## 文档规范

每个项目文档应包含以下内容：

1. **项目概述** - 项目的目的和主要功能
2. **技术栈** - 使用的框架、库和工具
3. **项目结构** - 主要目录和文件说明
4. **核心模块** - 核心业务模块说明
5. **核心流程** - 主要业务流程图（时序图）
6. **数据模型** - 主要实体和数据库表
7. **API接口** - 主要API端点说明
8. **配置说明** - 环境配置和参数说明
9. **跨项目依赖** - 与其他项目的关联关系

## 更新日志

- 2025-12-31: 增强文档，添加系统架构图、技术栈概览、项目分类、依赖关系图
- 2025-12-31: 为所有项目添加核心业务流程图
- 2025-12-31: 初始化文档结构