跳至主要内容

最佳實踐總覽

本節提供使用 AppFuse Server 開發的最佳實踐指南。

核心原則​

1. 模組化設計​

按業務領域組織程式碼，而非按技術層：

✅ 推薦：

domain/
├── product/
│   ├── Product.java
│   ├── ProductRepository.java
│   └── ProductService.java
└── order/
    ├── Order.java
    ├── OrderRepository.java
    └── OrderService.java

❌ 避免：

entity/
├── Product.java
└── Order.java
repository/
├── ProductRepository.java
└── OrderRepository.java

2. 封裝與可見性​

使用 package-private 封裝內部實作：

// Product.java - package-private
@Entity
class Product {
    // 只能在 domain.product 套件內使用
}

// ProductService.java - public API
@Service
public class ProductService {
    // 對外公開的服務介面
}

3. 配置分離​

  • 共用配置 → application.yml
  • 環境特定 → application-{env}.yml
  • 敏感資訊 → 環境變數

4. 測試驅動​

  • 單元測試：測試業務邏輯
  • 整合測試：測試資料庫操作
  • API 測試：測試 REST 端點

最佳實踐主題​

  • Entity 設計 - Entity 設計模式與最佳實踐（待建立）
  • API 設計 - RESTful API 設計指南（待建立）
  • 錯誤處理 - 統一錯誤處理策略（待建立）
  • 測試策略 - 測試最佳實踐（待建立）
  • 效能優化 - 常見效能優化技巧（待建立）
  • 安全性 - 安全性最佳實踐（待建立）

參考資源​

  • app-server - 參考實作展示這些最佳實踐