快速上手新项目不完全指北

运行项目

配置本地环境

启动项目

理解项目设计

业务架构设计

理解项目的整体结构和业务功能

• 业务流程: 了解项目中各个功能之间的关系和流程，以及用户如何使用这些功能

• 业务功能结构: 了解项目中各个功能的划分和组织方式

• 应用架构设计: 了解项目的应用架构是单体架构还是微服务架构或者其他架构

• 系统分层: 了解项目是如何进行水平分层（前端、中间层、后端）和垂直分层（子系统）的

技术架构设计

理解项目的实现方式和技术难点

• 技术栈: 了解项目中所使用的编程语言、应用框架、数据库、中间件等技术

• 各层技术: 了解项目中不同层（持久层、数据层、逻辑层、应用层、视图层）所采用的技术方案

数据库设计

理解业务数据的组织方式和访问方法

• 数据库结构: 了解项目中数据库的表结构、字段含义、数据类型及表关联关系等

• 数据关系: 了解项目中不同表之间的数据关系

接口设计

理解数据的流转和交互方式

• 接口定义: 了解项目中各接口的名称、参数、返回值和错误码等

• 接口文档: 了解项目中接口文档的编写方式和内容

核心功能实现

数据访问

理解数据的读写过程和数据存储的位置

• 数据源配置: 了解项目中数据源的配置方式，例如数据库连接字符串、用户名和密码等

• 数据访问封装: 了解项目中如何对数据访问进行封装，以提高代码的复用性和可维护性

• 缓存使用: 了解项目中是否使用缓存（Redis），以及缓存的配置和使用方式

• CRUD 实现：了解项目中的数据操作逻辑

系统核心功能

快速掌握项目的核心业务逻辑。

• 用户管理：了解用户、角色、权限和菜单的管理方式

• 登录认证和授权：理解登录认证流程和授权机制

• 异常处理：学习系统的异常处理机制，以便快速定位和解决问题

• 日志记录：了解日志记录的格式和存储方式，方便问题排查

• 文件上传和下载：掌握文件上传和下载的 API 或工具的使用方法

• 数据导入和导出：了解数据导入和导出的方式，方便数据迁移和备份

• 定时任务：学习定时任务的配置和管理方式，确保任务正常执行

• 国际化：掌握多语言支持的实现方式，以便支持不同语言的用户

• 代码生成：了解代码生成工具的使用，提高开发效率

• ……

开发流程

代码管理

• 项目大多使用 Git 进行代码管理

• 了解 Git 工作流，commit 规范等

项目文件结构

• 熟悉项目文件结构，了解各个目录和文件的含义

• 学习代码风格指南，保证代码的可读性和一致性

模块开发

• 需求分析：仔细阅读需求文档，理解模块功能需求和技术要求

• 开发规范：遵循项目开发规范，包括代码格式、命名规则和注释规范等

• 创建数据库表：根据需求设计数据库表结构，并使用数据库管理工具创建表

• 编写代码：编写模块源代码，实现功能逻辑

• 测试：完成模块开发后，进行单元测试和集成测试，确保功能正常

• 运行项目：重新运行项目，验证模块功能是否正常

• 测试功能：使用测试用例测试模块功能，确认功能正确性

图像示例