ContiNew Admin 前后端开发技能

👤 user_1b5ae5cf 📦 v1.0.0 ⭐ 4.6 ⬇️ 361 下载
💻 开发编程 免费

📖 技能介绍


name: continew-admin description: ContiNew Admin 开发技能 - 后端Java技术栈、模块结构、开发模式、代码模板和最佳实践 metadata: type: project version: 4.2.0 technology: Java Spring Boot author: seewe created: 2024-06-09 tags: [backend, java, spring-boot, admin-system, mvc, mybatis-plus, sa-token]


ContiNew Admin 开发技能

ContiNew Admin 是一个持续迭代优化的前后端分离中后台管理系统框架,基于 Spring Boot 3.x 构建,提供企业级的功能模块和开发体验。

概述

本技能包提供完整的开发指导、代码模板和最佳实践,帮助开发者快速上手和高效开发 ContiNew Admin 项目。

核心信息

  • 版本: 4.2.0-SNAPSHOT
  • 框架: continew-starter 2.15.0
  • Java: 17+
  • 技术栈: Spring Boot 3.x + MyBatis-Plus + Sa-Token

技能包内容

📚 开发指南 (development-guide.md)

全面介绍项目的架构、技术栈、模块结构、开发模式和最佳实践。

主要内容: - 项目概述和技术栈 - 模块结构和职责 - MVC + Service 分层架构 - CRUD 注解驱动开发 - 权限控制和认证授权 - Model 层设计(四层模型) - 配置管理 - 常用工具和注解 - 开发工作流 - 调试和测试 - 性能优化 - 最佳实践

适用场景: - 了解项目整体架构 - 学习开发模式和规范 - 新手入门指导 - 代码审查参考


🛠️ 代码模板 (code-templates.md)

提供快速开发使用的代码模板、脚本和工作流程。

主要内容: - 完整的 CRUD 模块模板 - 数据库迁移脚本模板 - 常用工具方法 - 开发流程检查清单 - 常见问题解决 - 工具和脚本

适用场景: - 快速创建新模块 - 代码生成参考 - 开发规范检查 - 问题排查


🎨 frontend-standards.md

前端开发范式,基于 Vue 3 + TypeScript + Arco Design + Vite。

主要内容: - 项目概述和技术栈 - 项目结构说明 - 组件开发模式 - API 调用模式 - 状态管理模式 - 自定义 Hooks 模式 - 权限控制模式 - HTTP 请求模式 - 路由配置模式 - 组件使用示例 - 配置管理 - 样式管理 - 最佳实践

适用场景: - 前端开发参考 - 组件开发指导 - 状态管理规范 - API 调用规范


📦 dependencies.md

依赖引用规范,优先使用 continew-starter 内置模块和 Hutool 工具类。

主要内容: - 依赖引用核心原则 - Continew-Starter 模块清单(40+ 个模块) - Hutool 工具类优先规范 - 第三方依赖推荐(WxJava、支付宝等) - 依赖管理最佳实践

适用场景: - 选择依赖时参考 - 工具类使用规范 - 版本管理指导


📊 response-format.md

详细的响应格式说明,包括通用响应和分页响应。

主要内容: - R 类结构和字段说明 - PageResp 类结构和字段说明 - 配置来源和使用示例 - 常见错误和正确格式 - 异常响应格式

适用场景: - 理解响应格式 - 接口开发参考 - 前后端联调


📖 参考手册 (reference.md)

技能索引和快速参考,便于快速查阅。

主要内容: - 技术栈详情 - 开发指南快速参考 - 命名规范 - 权限标识规范 - 接口规范 - 常见问题

适用场景: - 快速查阅 - 规范参考 - 新手入门

技术栈详情

核心依赖

用途 技术 说明
基础框架 Spring Boot 3.x 容器和应用框架
ORM MyBatis-Plus 数据库访问和 CRUD 操作
认证授权 Sa-Token JWT Token 和权限管理
接口文档 SpringDoc 2.x OpenAPI 3.0 文档生成
工具库 Hutool 5.x 常用工具类集合
代码简化 Lombok 简化 JavaBean 编写
缓存 JetCache 方法级缓存管理
文件存储 x-file-storage 统一文件上传接口
ID 生成 CosId 分布式 ID 生成方案
链路追踪 TLog 日志和链路追踪

支持的数据库

  • MySQL 8.x
  • PostgreSQL(兼容)

快速开始

1. 了解项目架构

# 阅读完整的开发指南
cat development-guide.md

2. 创建新模块

# 参考代码模板
cat code-templates.md

3. 查看快速参考

# 查看参考手册
cat reference.md

使用场景

🎯 场景一:新手入门

  1. 阅读 development-guide.md 了解项目架构
  2. 学习模块结构和分层设计
  3. 实践标准的开发流程
  4. 参考最佳实践编写代码

🎯 场景二:快速开发

  1. 查阅 code-templates.md 获取代码模板
  2. 复制并修改相关模板
  3. 按照开发流程检查清单操作
  4. 验证代码质量和规范

🎯 场景三:代码审查

  1. 使用开发指南中的规范进行代码审查
  2. 检查命名规范、注解使用、权限配置等
  3. 参考最佳实践进行改进建议
  4. 确保代码符合项目标准

🎯 场景四:问题排查

  1. 查看常见问题解决方案
  2. 检查配置文件和参数
  3. 查看日志和调试信息
  4. 参考官方文档和社区资源

核心概念

分层架构

Controller (API 层)
    ↓
Service (业务层)
    ↓
Mapper (数据访问层)
    ↓
Database (数据库)

Model 四层模型

Entity (实体) - 映射数据库表
Query (查询) - 查询参数
Req (请求) - 创建/更新请求
Resp (响应) - 列表/详情响应

权限标识

模块:资源:操作
system:user:create  # 创建用户
system:user:update  # 更新用户
system:user:delete  # 删除用户

最佳实践速查

✅ 推荐

  • 使用 @RequiredArgsConstructor 进行依赖注入
  • 使用 @Validated 进行参数校验
  • 使用 @CrudRequestMapping 快速定义 CRUD 接口
  • 使用四层模型设计 DTO
  • 使用逻辑删除而不是物理删除
  • 使用分布式 ID 生成器
  • 遵循命名规范

❌ 避免

  • 不要在 Controller 中直接访问数据库
  • 不要省略参数校验
  • 不要在 Service 中直接返回 Entity
  • 不要忽略权限检查
  • 不要在生产环境开启 SQL 日志
  • 不要硬编码配置参数

开发流程

需求分析
    ↓
数据库设计
    ↓
代码生成
    ↓
业务实现
    ↓
权限配置
    ↓
测试验证
    ↓
部署上线

常见问题

Q: 如何快速创建一个 CRUD 模块?

A: 参考 code-templates.md 中的完整模板。

Q: 如何添加新的权限码?

A: 在数据库 sys_menu 表中配置,使用 @SaCheckPermission 注解。

Q: 如何配置多数据源?

A: 在 application.yml 中配置 spring.datasource.dynamic

Q: 如何进行性能优化?

A: 使用 JetCache 缓存、批量操作、合理索引。

相关资源

项目结构

本技能来自小葱技能站7w4.net。

continew-admin-skill/
├── SKILL.md                 # 本文件 - 技能说明
├── development-guide.md     # 完整开发指南
├── code-templates.md        # 代码模板集合
├── response-format.md       # 响应格式说明
├── dependencies.md          # 依赖引用规范
├── frontend-standards.md    # 前端开发范式
└── reference.md             # 参考手册

更新日志

2024-06-09

  • ✨ 创建初始技能包
  • 📝 添加完整的开发指南
  • 🛠️ 添加代码模板集合
  • 📊 添加响应格式说明(修正了响应格式描述)
  • 📦 添加依赖引用规范(优先使用 continew-starter 和 Hutool)
  • 🎨 添加前端开发范式(Vue3 + TypeScript + Arco Design)
  • 📖 创建参考手册

贡献

如有改进建议或发现问题,欢迎提交 Issue 或 Pull Request。

许可证

MIT License


创建时间: 2024-06-09 维护者: seewe 版本: 1.0.0 技能包格式: 标准 SKILL.md 格式

🤖 AI 评测

这个技能包质量不错,内容非常全面,既包含后端开发指南也包含前端开发指南,代码模板可以直接参考使用。文档分类清晰,查找起来很方便。对于需要学习这个项目的开发者来说很有帮助。主要问题是部分文档内容有重复,看起来不够精简;前端相关的说明篇幅太长,读起来有点吃力。瑕不掩瑜,是一个值得推荐的好技能包。

📊 多维度评分

适应性3.9
规范性4.6
有效性4.7
可靠性4.5
可信度5

📁 包含文件 (8 个)

📄 README.md 9.4 KB
📄 SKILL.md 8.1 KB
📄 code-templates.md 13.6 KB
📄 dependencies.md 17.4 KB
📄 development-guide.md 13.6 KB
📄 frontend-standards.md 52.6 KB
📄 reference.md 11.6 KB
📄 response-format.md 7 KB