如何使用loyom-crud-spring-boot-starter構建CRUD后端API

# 如何使用loyom-crud-spring-boot-starter構建CRUD后端API

## 目錄
- [1. 引言](#1-引言)
- [2. 環境準備](#2-環境準備)
- [3. 快速開始](#3-快速開始)
- [4. 核心功能詳解](#4-核心功能詳解)
  - [4.1 自動生成API](#41-自動生成api)
  - [4.2 高級查詢功能](#42-高級查詢功能)
  - [4.3 數據驗證](#43-數據驗證)
  - [4.4 權限控制](#44-權限控制)
- [5. 自定義擴展](#5-自定義擴展)
- [6. 最佳實踐](#6-最佳實踐)
- [7. 常見問題](#7-常見問題)
- [8. 總結](#8-總結)

---

## 1. 引言

在現代Web開發中，CRUD（Create, Read, Update, Delete）操作占據了后端API開發的70%以上工作量。傳統Spring Boot開發中，每個實體類都需要重復編寫Controller、Service、Repository層代碼，不僅效率低下還容易出錯。

`loyom-crud-spring-boot-starter`是一款基于Spring Boot的自動化CRUD組件，具有以下核心優勢：

1. **零編碼生成API**：通過注解自動生成RESTful API
2. **動態查詢支持**：內置高級過濾、排序、分頁功能
3. **開箱即用**：10分鐘即可搭建完整后端服務
4. **高度可擴展**：支持自定義業務邏輯注入

本文將完整介紹從基礎使用到高級定制的全流程。

---

## 2. 環境準備

### 基礎要求
- JDK 8+
- Maven 3.5+
- Spring Boot 2.3+

### 項目配置
在`pom.xml`中添加依賴：

```xml
<dependency>
  <groupId>com.loyom</groupId>
  <artifactId>loyom-crud-spring-boot-starter</artifactId>
  <version>1.3.0</version>
</dependency>

數據庫配置

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/crud_demo
    username: root
    password: 123456
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

3. 快速開始

3.1 定義實體類

@Entity
@CrudEntity
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @CrudField(required = true)
    private String username;
    
    private Integer age;
    
    // getters/setters...
}

3.2 啟用CRUD功能

@SpringBootApplication
@EnableAutoCrud(basePackages = "com.example.entity")
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

3.3 自動生成的API

4. 核心功能詳解

4.1 自動生成API

注解說明

• @CrudEntity：標記需要生成CRUD的實體
• @CrudField：字段級控制

  
  @CrudField(
  editable = false,  // 不可編輯
  searchable = true // 可搜索
  )
  private String email;
  

自定義端點路徑

loyom.crud.api-prefix=/admin/api

4.2 高級查詢功能

復雜查詢示例

GET /api/users?filter=age>18&sort=-createdAt&page=1&size=10

參數說明： - filter：過濾條件（支持>、<、=、like等） - sort：排序字段（-表示降序） - page/size：分頁控制

4.3 數據驗證

內置驗證規則

@CrudField(
  required = true,
  maxLength = 100,
  pattern = "^\\w+@\\w+\\.com$"
)
private String email;

4.4 權限控制

方法級權限

@CrudEntity(
  writeRoles = {"ADMIN"},
  readRoles = {"USER","ADMIN"}
)
public class Product {
    //...
}

5. 自定義擴展

5.1 覆蓋默認實現

@Component
public class CustomUserService extends DefaultCrudService<User, Long> {
    @Override
    public User beforeCreate(User entity) {
        // 加密密碼等預處理
        return entity; 
    }
}

5.2 添加額外端點

@RestController
@RequestMapping("/api/users")
public class UserExtendController {
    
    @PostMapping("/bulk")
    public void batchImport(@RequestBody List<User> users) {
        // 批量導入邏輯
    }
}

6. 最佳實踐

6.1 性能優化建議

• 對高頻查詢字段添加@Index
• 使用DTO隔離實體類
• 啟用二級緩存

6.2 安全規范

1. 始終啟用@CrudField的輸入驗證
2. 生產環境關閉JPA的ddl-auto
3. 使用HTTPS傳輸敏感數據

7. 常見問題

Q1: 如何排除某些字段？

@CrudField(ignore = true)
private String password; 

Q2: 支持MongoDB嗎？

目前僅支持JPA兼容的關系型數據庫，MongoDB支持計劃在2.0版本實現。

8. 總結

loyom-crud-spring-boot-starter通過自動化CRUD實現顯著提升了開發效率。本文介紹了： - 基礎配置方法 - 高級查詢功能 - 自定義擴展方案 - 生產環境最佳實踐

建議在中小型項目中使用，對于復雜業務系統可結合手動編碼實現靈活控制。

資源推薦： - GitHub項目地址 - 官方文檔 “`

注：本文為示例文檔，實際使用時請根據框架最新版本調整代碼。如需完整實現，建議補充： 1. 具體異常處理案例 2. 性能測試數據 3. 與Swagger的集成方案 4. 分布式環境下的注意事項