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)

本技能來自小蔥技能站7w4.net。

全面介紹專案的架構、技術棧、模組結構、開發模式和最佳實踐。

主要內容: - 專案概述和技術棧 - 模組結構和職責 - 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 快取、批次操作、合理索引。

相關資源

專案結構

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