lyzsys/lyzsys_backend
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
master
lyzsys_backend/doc/README.md

7.7 KiB
Raw Permalink Blame History

Lyzsys 项目文档导航

欢迎使用 Lyzsys 企业级后台管理系统！本文档导航将帮助您快速找到所需的文档资源。

📚 文档目录

🚀 快速开始

文档 说明 适用人群
项目介绍 项目概述、技术栈、核心特性 所有人
部署指南 环境搭建、安装部署、配置说明 运维、开发
常见问题 FAQ、故障排查、解决方案 所有人

🏗️ 架构设计

文档 说明 适用人群
架构设计 系统架构、技术选型、设计思路 架构师、开发
数据库设计 数据库表结构、字段说明、ER图 开发、DBA

💻 开发文档

文档 说明 适用人群 重要程度
后端开发文档 后端开发指南、核心功能、代码示例 后端开发 ⭐⭐⭐⭐⭐
前端开发文档 前端开发指南、组件使用、最佳实践 前端开发 ⭐⭐⭐⭐⭐
编码规范 命名规范、代码规范、最佳实践 所有开发 ⭐⭐⭐⭐⭐
新模块开发指南 新模块开发完整教程（含 Demo 示例） 所有开发 ⭐⭐⭐⭐⭐

🎯 按场景查找文档

场景 1：我是新加入的开发人员

推荐阅读顺序：

  1. 项目介绍 - 了解项目概况
  2. 部署指南 - 搭建开发环境
  3. 编码规范 - 熟悉编码规范 ⚠️ 必读
  4. 后端开发文档 或 前端开发文档 - 根据岗位选择
  5. 新模块开发指南 - 学习如何开发新功能

场景 2：我要开发一个新的业务模块

推荐步骤：

  1. 必读 → 编码规范 - 了解命名规范和菜单结构规范
  2. 必读 → 新模块开发指南 - 按照步骤创建模块
  3. 参考 → Demo 模块代码（lyzsys-module-demo）- 作为实现参考
  4. 参考 → 后端开发文档 - 查阅具体技术实现
  5. 参考 → 前端开发文档 - 前端页面开发

场景 3：我遇到了问题

查找方式：

  1. 常见问题 - 先查看 FAQ
  2. 后端开发文档 - 查看附录的常见问题
  3. GitHub Issues - 搜索或提交问题

场景 4：我要了解系统架构

推荐阅读：

  1. 项目介绍 - 快速了解
  2. 架构设计 - 详细架构说明
  3. 数据库设计 - 数据模型
  4. 后端开发文档 - 核心功能实现

📖 重点文档说明

🔥 编码规范（必读）

文件：编码规范.md

核心内容：

  • ⚠️ 驼峰命名规范：第一个单词不能只有一个字母（重要！）
  • 📋 菜单结构规范：业务菜单优先，系统管理放最后
  • 🏗️ 代码结构规范：Controller-Service-DAL 三层架构
  • 💾 数据库设计规范：表名、字段名、索引规范
  • 🔌 API 接口规范：RESTful 风格、统一响应格式
  • 🎨 前端开发规范：组件规范、权限控制

为什么重要：

  • 避免 MyBatis Plus 字段映射问题
  • 提高代码可读性和可维护性
  • 统一团队开发风格

🚀 新模块开发指南（必读）

文件：新模块开发指南.md

核心内容：

  • ✅ 完整的开发流程（从数据库设计到前端页面）
  • 📝 逐步操作指南（包含完整代码示例）
  • 🎯 以 Demo 模块为参考案例
  • ✔️ 开发检查清单

包含内容：

  1. 创建后端模块（Maven 配置、实体类、Service、Controller）
  2. 创建前端页面（API 接口、列表页、表单组件）
  3. 配置菜单权限（一级菜单、二级菜单、按钮权限）
  4. 常见问题解决

📦 Demo 示例模块

模块位置：

  • 后端：lyzsys_backend/lyzsys-module-demo
  • 前端：lyzsys-ui-admin/src/views/demo/project
  • SQL：lyzsys_backend/sql/mysql/demo_*.sql

功能展示：

  • ✅ 项目管理的完整 CRUD 功能
  • ✅ 分页查询、批量删除、Excel 导出
  • ✅ 遵循所有编码规范的标准实现
  • ✅ 前后端完整联调示例

如何使用：

  1. 查看 Demo 模块的代码结构
  2. 参考其命名方式和代码风格
  3. 复制并修改为自己的业务模块
  4. 详细步骤见 新模块开发指南

📂 文档结构

doc/
├── README.md                  # 📖 本文档（文档导航）
├── 编码规范.md                # ⭐⭐⭐⭐⭐ 命名规范、开发规范
├── 新模块开发指南.md          # ⭐⭐⭐⭐⭐ 新模块开发教程
├── 后端开发文档.md            # 后端开发指南
├── 前端开发文档.md            # 前端开发指南
├── 项目介绍.md                # 项目概述
├── 架构设计.md                # 架构设计文档
├── 数据库设计.md              # 数据库设计文档
├── 部署指南.md                # 部署运维文档
└── 常见问题.md                # FAQ 文档

🔑 关键规范速查

驼峰命名规范

⚠️ 核心原则：第一个单词不能只有一个字母

// ✅ 正确
projectId, projectName, establishDate

// ❌ 错误
pId, pName, eDate

详细说明：编码规范 - 命名规范

菜单结构规范

1-90.  业务菜单（优先展示）
98.    系统管理
99.    基础设施

详细说明：编码规范 - 菜单结构规范

权限标识格式

{模块名}:{业务}:{操作}

示例：
demo:project:query
demo:project:create
demo:project:update

详细说明：编码规范 - 菜单配置规范

🛠️ 开发工具推荐

后端开发

  • IDE：IntelliJ IDEA（推荐）
  • JDK：1.8+
  • Maven：3.6+
  • 数据库工具：Navicat、DataGrip

前端开发

  • IDE：VSCode、WebStorm
  • Node.js：16+
  • 包管理器：npm、pnpm

版本管理

  • Git 客户端：Git、SourceTree、GitKraken
  • 代码托管：GitHub、GitLab

📞 获取帮助

文档问题

技术支持

  • 提交 GitHub Issue
  • 联系开发团队

参与贡献

  • Fork 项目
  • 提交 Pull Request
  • 完善文档

📝 文档更新记录

日期 版本 更新内容 作者
2024-01 v1.0 创建文档导航，新增编码规范和新模块开发指南 开发团队
2024-01 v1.0 添加 Demo 示例模块说明 开发团队

🎉 开始使用

如果您是第一次使用 Lyzsys，建议按以下顺序阅读文档：

  1. ✅ 项目介绍 - 5分钟了解项目
  2. ✅ 部署指南 - 搭建开发环境
  3. ✅ 编码规范 - 必读，熟悉编码规范
  4. ✅ 新模块开发指南 - 开发第一个模块
  5. ✅ 后端开发文档 / 前端开发文档 - 深入学习

祝您使用愉快！🚀

文档维护：Lyzsys 开发团队 最后更新：2024年 文档版本：v1.0