設計指引範本 Prompt 目標 指導 AI 進行軟體設計,建立符合設計原則、易於維護且可擴展的軟體設計。
角色設定 你是一位資深軟體設計師,具備豐富的軟體設計經驗,熟悉設計模式、SOLID 原則和軟體工程最佳實務。
任務描述 請協助我完成 {專案名稱} 的軟體設計工作。
專案設計背景 專案名稱: {填入專案名稱} 設計範圍: {填入設計範圍,如:核心模組、特定功能} 技術棧: {填入使用的技術棧} 設計約束: {填入設計限制和約束} 品質要求: {填入品質屬性要求} 設計要求 請按照以下結構進行設計:
1. 領域建模 核心領域識別 實體和值物件設計 聚合設計 領域服務設計 2. 架構設計 分層架構設計 模組劃分 依賴關係設計 介面設計 3. 詳細設計 類別設計 方法設計 資料結構設計 演算法設計 4. 設計模式應用 創建型模式 結構型模式 行為型模式 架構模式 5. 設計原則遵循 SOLID 原則 DRY 原則 KISS 原則 YAGNI 原則 輸出格式 # {專案名稱} 軟體設計文件 ## 1. 設計概述 ### 1.1 設計目標 **主要目標:** - {目標1} - {目標2} - {目標3} **品質屬性:** - **可維護性:** {可維護性要求} - **可擴展性:** {可擴展性要求} - **可重用性:** {可重用性要求} - **可測試性:** {可測試性要求} ### 1.2 設計約束 **技術約束:** - 程式語言: {程式語言} - 框架: {使用的框架} - 資料庫: {資料庫類型} - 部署環境: {部署環境} **業務約束:** - 效能要求: {效能指標} - 安全要求: {安全等級} - 相容性要求: {相容性需求} ## 2. 領域建模 ### 2.1 領域識別 #### 核心領域 (Core Domain) **領域名稱:** {核心業務領域} **複雜度:** 高 **業務價值:** 高 **描述:** {領域描述} **主要概念:** - {概念1}: {概念描述} - {概念2}: {概念描述} - {概念3}: {概念描述} #### 支援領域 (Supporting Domain) **領域名稱:** {支援領域} **複雜度:** 中 **業務價值:** 中 **描述:** {領域描述} #### 通用領域 (Generic Domain) **領域名稱:** {通用領域} **複雜度:** 低 **業務價值:** 低 **解決方案:** {現成解決方案或第三方服務} ### 2.2 實體設計 (Entity) #### 實體: {實體名稱} ```java /** * {實體描述} * 不變量: {業務規則和約束} */ public class {實體名稱} { // 唯一識別碼 private {ID類型} id; // 業務屬性 private {屬性類型} {屬性名稱}; // 建構子 public {實體名稱}({參數列表}) { // 驗證業務規則 validateBusinessRules(); this.{屬性} = {值}; } // 業務方法 public {返回類型} {業務方法名稱}({參數列表}) { // 業務邏輯實作 return {結果}; } // 不變量驗證 private void validateBusinessRules() { if ({條件}) { throw new {例外類型}("{錯誤訊息}"); } } // equals 和 hashCode 基於 ID @Override public boolean equals(Object obj) { if (this == obj) return true; if (!(obj instanceof {實體名稱})) return false; {實體名稱} other = ({實體名稱}) obj; return Objects.equals(id, other.id); } @Override public int hashCode() { return Objects.hash(id); } } 2.3 值物件設計 (Value Object) 值物件: {值物件名稱} /** * {值物件描述} * 特性: 不可變、值相等、自驗證 */ public final class {值物件名稱} { private final {屬性類型} {屬性名稱}; public {值物件名稱}({參數類型} {參數名稱}) { validate({參數名稱}); this.{屬性名稱} = {參數名稱}; } public {屬性類型} get{屬性名稱}() { return {屬性名稱}; } private void validate({參數類型} value) { if ({驗證條件}) { throw new IllegalArgumentException("{錯誤訊息}"); } } @Override public boolean equals(Object obj) { if (this == obj) return true; if (!(obj instanceof {值物件名稱})) return false; {值物件名稱} other = ({值物件名稱}) obj; return Objects.equals({屬性名稱}, other.{屬性名稱}); } @Override public int hashCode() { return Objects.hash({屬性名稱}); } @Override public String toString() { return "{值物件名稱}{" + "{屬性名稱}=" + {屬性名稱} + '}'; } } 2.4 聚合設計 (Aggregate) 聚合: {聚合名稱} /** * {聚合描述} * 聚合根: {聚合根實體} * 邊界: {聚合邊界說明} */ public class {聚合名稱} { // 聚合根 private {實體類型} {聚合根}; // 聚合內實體 private List<{實體類型}> {內部實體列表}; // 聚合建構 public {聚合名稱}({參數列表}) { this.{聚合根} = new {實體類型}({參數}); this.{內部實體列表} = new ArrayList<>(); } // 業務操作 public void {業務操作名稱}({參數列表}) { // 驗證聚合不變量 validateAggregateInvariants(); // 執行業務邏輯 {聚合根}.{業務方法}({參數}); // 發布領域事件 publishDomainEvent(new {事件類型}({事件資料})); } // 聚合不變量驗證 private void validateAggregateInvariants() { if ({不變量條件}) { throw new {例外類型}("{違反不變量訊息}"); } } // 取得聚合根 ID public {ID類型} getId() { return {聚合根}.getId(); } } 2.5 領域服務設計 領域服務: {服務名稱} /** * {服務描述} * 使用場景: {使用場景說明} */ @DomainService public class {服務名稱} { private final {依賴類型} {依賴名稱}; public {服務名稱}({依賴類型} {依賴名稱}) { this.{依賴名稱} = {依賴名稱}; } /** * {業務操作描述} * @param {參數} {參數描述} * @return {返回值描述} */ public {返回類型} {業務操作}({參數列表}) { // 前置條件檢查 validatePreconditions({參數}); // 業務邏輯執行 {返回類型} result = executeBusinessLogic({參數}); // 後置條件檢查 validatePostconditions(result); return result; } } 3. 架構設計 3.1 分層架構 四層架構設計 ┌─────────────────────────────────────┐ │ 展示層 (Presentation) │ ├─────────────────────────────────────┤ │ 應用層 (Application) │ ├─────────────────────────────────────┤ │ 領域層 (Domain) │ ├─────────────────────────────────────┤ │ 基礎設施層 (Infrastructure) │ └─────────────────────────────────────┘ 展示層 (Presentation Layer) 職責:
...