# E-Structure

**Repository Path**: mrfire/e-structure

## Basic Information

- **Project Name**: E-Structure
- **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-11-23
- **Last Updated**: 2026-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# EStructure 项目文档导航

> EStructure 是基于 .NET Framework 的企业级配置化表单系统，采用三层架构：数据模型层 → 表单设计层 → 表单渲染层

## 📚 文档索引

### 🚀 快速开始

| 文档 | 适合人群 | 说明 |
|------|---------|------|
| [CLAUDE.md](./CLAUDE.md) | **AI助手/快速查阅** | 项目概览、快速参考（英文） |
| [项目架构与开发规范](./docs/01-基础/项目架构与开发规范.md) | **新手/架构师** | 项目架构总览、开发模式对比、核心概念 |

### 📖 开发指南

#### CodeFirst 模式（新功能开发）

| 文档 | 说明 |
|------|------|
| [CodeFirst快速开发指南](./docs/02-CodeFirst/CodeFirst快速开发指南.md) | **⭐ 推荐** - CodeFirst 完整操作手册，3步完成 CRUD |

#### 深度技术文档

| 文档 | 说明 |
|------|------|
| [ConfigUI表单渲染原理深度解析](./docs/03-深度指南/ConfigUI表单渲染原理深度解析.md) | 表单渲染架构、控件工厂、数据流转原理 |
| [EntityFormController业务扩展指南](./docs/03-深度指南/EntityFormController业务扩展指南.md) | 生命周期钩子、业务逻辑定制、实战示例 |
| [表单控件详细说明](./docs/03-深度指南/表单控件详细说明.md) | 15种控件类型、配置参数、使用示例 |

---

## 🎯 按角色选择文档

### 👶 我是新手
1. 先看 [CLAUDE.md](./CLAUDE.md) 了解项目概览（5分钟）
2. 再看 [项目架构与开发规范](./docs/01-基础/项目架构与开发规范.md) 理解架构（15分钟）
3. 跟着 [CodeFirst快速开发指南](./docs/02-CodeFirst/CodeFirst快速开发指南.md) 完成第一个功能（30分钟）

### 👨‍💻 我要开发新功能
1. 使用 [CodeFirst快速开发指南](./docs/02-CodeFirst/CodeFirst快速开发指南.md) 创建实体和表单
2. 参考 [表单控件详细说明](./docs/03-深度指南/表单控件详细说明.md) 选择合适的控件
3. 如需业务定制，查看 [EntityFormController业务扩展指南](./docs/03-深度指南/EntityFormController业务扩展指南.md)

### 🔧 我要深入理解技术原理
1. [ConfigUI表单渲染原理深度解析](./docs/03-深度指南/ConfigUI表单渲染原理深度解析.md) - 渲染机制
2. [EntityFormController业务扩展指南](./docs/03-深度指南/EntityFormController业务扩展指南.md) - 扩展机制
3. [项目架构与开发规范](./docs/01-基础/项目架构与开发规范.md) - 整体架构

### 🤖 我是 AI 助手（Claude/GPT）
- 优先阅读 [CLAUDE.md](./CLAUDE.md) 获取项目核心信息
- 需要详细规范时查阅 [项目架构与开发规范](./docs/01-基础/项目架构与开发规范.md)
- CodeFirst 开发流程参考 [CodeFirst快速开发指南](./docs/02-CodeFirst/CodeFirst快速开发指南.md)

---

## 📂 文档目录结构

```
e-structure/
├── README.md                    # 📖 你在这里 - 文档导航
├── CLAUDE.md                    # 🤖 AI 助手快速参考
│
├── docs/                        # 📚 文档库
│   ├── 01-基础/
│   │   └── 项目架构与开发规范.md
│   ├── 02-CodeFirst/
│   │   └── CodeFirst快速开发指南.md
│   └── 03-深度指南/
│       ├── ConfigUI表单渲染原理深度解析.md
│       ├── EntityFormController业务扩展指南.md
│       └── 表单控件详细说明.md
│
└── archive/                     # 📦 历史备份
    └── EStructure开发指南_v2.0_backup.md
```

---

## 📋 快速参考

### 核心开发流程

**CodeFirst 模式（推荐用于新功能）：**
```
1. 创建实体类 (Entity)
   → 2. 运行 T4 模板
   → 3. 执行 SQL 配置脚本
   → 完成！
```

**DbFirst 模式（用于维护现有系统）：**
```
1. 创建数据库表
   → 2. 运行 T4 模板
   → 3. 配置表单
   → 完成！
```

### 关键规范速查

| 规范 | 说明 |
|------|------|
| **文件编码** | 所有 `.cs` 和 `.sql` 文件必须使用 **UTF-8 with BOM** |
| **SQL 中文** | 中文字符串必须使用 `N'中文'` 前缀 |
| **执行脚本** | `sqlcmd -S [server] -U sa -P [pwd] -i "script.sql" -f 65001` |
| **实体基类** | CodeFirst: `Entity` / DbFirst: `DBFirstEntity` |
| **FormConfig** | `UseAsContainer = 0`, `GroupSetting = N'[]'` |

### 常用路径

| 用途 | 路径 |
|------|------|
| 实体类 | `EStructure_Monitor/Model/[Module]/[Entity].cs` |
| T4 模板（CodeFirst） | `EStructure_Monitor/T4/CodeFirst/BaseDbContext.tt` |
| T4 模板（DbFirst） | `MF_Log/T4/DBFirst/DBGenerateModel.tt` |
| 配置脚本 | `EStructure/Scripts/[Entity]_FormConfig.sql` |

---

## 🔗 相关链接

- **项目主目录**: `F:\Work\EStructure\e-structure`
- **主应用**: `http://localhost/ConfigUI/Form/PageView?uiCode=[Entity]_Form`
- **表单设计器**: `http://localhost/ConfigUIDef/Form/Basic`

---

## 📌 文档维护

- **最后更新**: 2025-11-29
- **维护者**: 开发团队
- **文档版本**: v1.1

**文档修订历史**：
- v1.1 (2025-11-29): 创建 docs/ 目录，按分类整理文档
- v1.0 (2025-11-29): 文档整理，创建导航索引，精简重复内容