JPwise-Java-Boot 后端开发文档

📚 文档体系

📘 开发指南

• 基础继承指南 - Basic继承体系开发，快速CRUD实现
• 手动开发指南 - 纯手工开发方式，精细业务控制
• 工具使用指南 - 工具类完整使用手册

📖 参考文档

• 架构参考 - 系统架构设计与技术栈详解
• 数据库参考 - 数据库操作与MyBatis-Flex使用
• 实体参考 - 实体类设计与注解使用
• 钩子参考 - 钩子方法与扩展点

📏 开发标准

• API标准 - RESTful API设计规范
• 编码标准 - 代码风格与质量要求
• 导入标准 - 包导入规范与依赖管理
• 命名规范 - 类、方法、变量命名规则

🔧 故障排除

• 常见错误 - 开发中的常见问题与解决方案
• 解决方案 - 疑难问题解决方法集

🚀 学习路径

新手开发者（1周）

1. 第一天：阅读架构参考，了解系统整体架构
2. 第二天：学习工具使用指南，掌握核心工具类
3. 第三天：选择开发方式：
   • 标准CRUD → 基础继承指南
   • 复杂业务 → 手动开发指南
4. 第四天：学习编码标准和命名规范
5. 第五天：实践开发，参考常见错误解决问题

进阶开发者

• 深入研究数据库参考，掌握MyBatis-Flex高级特性
• 学习钩子参考，实现业务扩展
• 阅读API标准，设计规范的接口
• 优化代码质量，遵循编码标准

🔍 快速查找

常用功能

需求	文档位置	关键内容
创建CRUD	基础继承指南	继承BaseService
数据查询	工具使用指南	QueryWrapper使用
分页查询	数据库参考	分页实现
事务处理	数据库参考	@Transactional
权限控制	工具使用指南	@SaCheckPermission
数据导入	工具使用指南	ImportUtils

开发场景

场景	推荐文档	备注
新建模块	基础继承指南 → 命名规范	标准化开发流程
复杂查询	数据库参考 → 工具使用指南	MyBatis-Flex查询
文件处理	工具使用指南	FileUtil、UploadUtil
异常处理	编码标准 → 常见错误	统一异常处理
接口设计	API标准 → 实体参考	RESTful规范

💡 核心工具类速览

基础工具

• JpwiseUser - 用户信息获取
• RandomUtil - 随机数生成
• DateUtil - 日期时间处理
• FileUtil - 文件操作

数据处理

• ImportUtils - Excel导入
• ExportUtil - 数据导出
• QueryBuilderUtil - 查询构建
• PageUtil - 分页处理

业务工具

• WorkflowUtil - 工作流处理
• PermissionUtil - 权限验证
• DynamicTaskUtil - 定时任务
• WebSocketUtil - WebSocket通信

📈 版本信息

• 文档版本：v2.0
• 更新日期：2025-01-22
• 适用版本：JPwise v3.4.2+
• 技术栈：Spring Boot 3.2.4 + MyBatis-Flex + Sa-Token

🛠️ 技术栈参考

• Spring Boot 3.2.4 文档
• MyBatis-Flex 文档
• Sa-Token 文档
• Hutool 文档

🤝 贡献指南

欢迎改进文档：

1. 补充缺失的API说明
2. 添加实际开发案例
3. 完善错误解决方案
4. 分享最佳实践经验

---

💡 提示：使用 IDE 的全局搜索功能（Ctrl+Shift+F）快速查找相关内容。