快速开始

阅读前提

• JDK 17+
• Spring Boot 3.x
• Maven 项目

三步上手

1. 引入依赖

在业务模块的 pom.xml 中加入：

<dependency>
    <groupId>cn.cvking</groupId>
    <artifactId>forge-ddl</artifactId>
    <version>1.0.0</version>
</dependency>

无需在主 pom.xml 或启动类添加任何额外配置。forge-ddl 通过 Spring Boot 3.x 的 AutoConfiguration.imports 机制自动装配，详见 前置知识 · Spring Boot 自动装配。

2. 确认启动类位置

forge-ddl 默认扫描启动类所在包及其子包，所以请确保你的实体类与启动类在同一根包下：

com.demo.app
├── DemoApplication.java          ← @SpringBootApplication
└── model
    └── User.java                 ← 在这里加 @Model

如果实体类不在启动类的子包，请参考 配置说明 · 自定义扫描包。

3. 编写第一个 @Model

package com.demo.app.model;

import cn.cvking.forge.ddl.annotation.Field;
import cn.cvking.forge.ddl.annotation.Model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Model(name = User.MODEL_NAME, displayName = "用户", summary = "用户实体")
public class User {

    public static final String MODEL_NAME = "user";
    
    @Field(displayName = "用户名")
    @Field.String(length = 64)
    private String name;

    @Field(displayName = "年龄")
    @Field.Integer
    private Integer age;
}