EasyFK Generator 代码生成器使用手册

双击 install.bat

chmod +x install && ./install

efg -V

easyfk-generator 3.2.12

chmod +x uninstall && ./uninstall

# 1. 创建工作目录
mkdir my-project && cd my-project

# 2. 生成配置模板
efg init

# 3. 用编辑器打开 generator.yml，填入项目信息、app-type 和数据库配置

# 4. 执行全量生成
efg

efg [选项]
efg init [-o 文件名]

mkdir my-project && cd my-project
efg init                    # 生成配置模板
# 编辑 generator.yml，填入所有配置
efg                         # 全量生成

efg -m                      # 生成新表的 Entity + Mapper
efg -s                      # 生成对应的业务代码
efg -a                      # 刷新自动装配配置（SMART 架构需要）

efg                         # 全量生成（已有文件不会被覆盖）

efg -m                      # 重新生成 Entity（会覆盖）
efg -d                      # 刷新 DTO 和 Param（会覆盖）

efg -c dev-generator.yml            # 开发环境配置
efg -c prod-generator.yml -m        # 生产环境，仅生成 Model

efg -p                      # 生成目录结构和构建文件，可以先搭建好项目结构再逐步添加业务

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.example
        project-name: my-app
        base-package: com.example.myapp
        project-type: single
        app-type: BMS
      code:
        module-name: myapp
        model-list:
          - model-name: Product
            model-desc: 商品信息
          - model-name: Order
            model-desc: 订单信息

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.example
        project-name: order-service
        base-package: com.example.order
        project-type: microservice
        rpc-type: cloud
        prd-type: single
        build-type: gradle
        app-type: CLIENT
        framework-version: 3.2.12
      code:
        module-name: order
        author: 开发者
        db-type: MYSQL
        db-short-url: localhost:3306/order_db
        db-user: root
        db-pwd: 123456
        from-db-tables: t_order,t_order_item
        table-prefix: t_

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.example
        project-name: user-service
        base-package: com.example.user
        project-type: microservice
        rpc-type: dubbo
        prd-type: separation
        build-type: maven
        app-type: BMS
        framework-version: 3.2.12
      code:
        module-name: user
        db-type: POSTGRE_SQL
        db-short-url: localhost:5432/user_db
        db-user: postgres
        db-pwd: 123456
        from-db-tables: user_info,user_address
        model-list:
          - model-name: UserInfo
            model-desc: 用户信息
            forbidden-filed: status
          - model-name: UserAddress
            model-desc: 收货地址

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.mcst
        project-name: trading
        base-package: com.mcst.trading
        project-type: smart
        prd-type: separation
        build-type: gradle
        gradle-type: groovy
        orm-type: MYBATIS
        log-type: LOGBACK
        app-type: BMS
        framework-version: 3.2.12
        project-version: 1.0.0-SNAPSHOT
        controller-auto-config: true
      code:
        module-name: trading
        author: 开发团队
        orm-type: MYBATIS
        spring-annotation: true
        create-controller: true
        db-type: MYSQL
        db-short-url: 192.168.1.100:3306/trading_db
        db-user: root
        db-pwd: secure_password
        table-prefix: t_
        from-db-tables: t_product,t_order,t_order_item,t_payment
        model-list:
          - model-name: Product
            model-desc: 商品
          - model-name: Order
            model-desc: 订单
          - model-name: OrderItem
            model-desc: 订单明细
            only-repository: true
          - model-name: Payment
            model-desc: 支付记录
            create-controller: false

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.example
        project-name: my-app
        base-package: com.example.myapp
        project-type: single
        app-type: BMS
      code:
        module-name: myapp
        db-type: MYSQL
        db-short-url: localhost:3306/my_database
        db-user: root
        db-pwd: 123456
        table-prefix: base_
        from-db-tables: base_product,base_category,base_brand

easyfk:
  config:
    generator:
      project:
        project-dir: D:\workspace\projects
        group-id: com.mcst
        project-name: user
        base-package: com.mcst.user
        project-type: smart
        prd-type: separation
        build-type: gradle
        app-type: BMS
      code:
        module-name: user
        db-short-url: localhost:3306/user_db
        db-pwd: 123456
        create-resource-annotation: true
        resource-group: userManagement
        resource-id: userManagement
        resource-name: 用户管理
        resource-path: /user
        resource-sort: 80000
        module-resource-sort: 10000
        increment-star: 100
        model-list:
          - model-name: UserInfo
            model-desc: 会员
          - model-name: UserAddress
            model-desc: 收货地址
          - model-name: UserAccount
            model-desc: 账号

easyfk:
  config:
    generator:
      project:    # 项目配置
        ...
      code:       # 代码配置
        ...

code:
  model-list:
    - model-name: Product
      model-desc: 商品信息
      # ... 更多配置
    - model-name: Order
      model-desc: 订单信息

@ResourceController(group = "operationSetting", id = "operationSetting",
    name = "运营管理", sort = 81000, path = "/operation")
public class ProductController {

    @AuthResource(id = "productManage", name = "商品管理",
        pId = "operationSetting", pName = "运营管理",
        sort = 10100, path = "/operation/product",
        category = ResourceCategory.menu)
    public ResponseResult<List<ProductResp>> queryPage(...) { ... }
}

my-app/
├── pom.xml (或 build.gradle)
├── src/main/java/com/example/myapp/
│   ├── ServerApp.java                          # 启动类
│   ├── controller/
│   │   └── ProductController.java              # Controller（直接调用 Service）
│   ├── api/
│   │   ├── dto/ProductDto.java                 # DTO
│   │   ├── param/ProductParam.java             # 查询参数
│   │   ├── request/
│   │   │   ├── ProductReq.java                 # 请求对象
│   │   │   └── ProductEditReq.java             # 编辑请求对象
│   │   └── response/ProductResp.java           # 响应对象
│   └── service/
│       ├── IProductService.java                # 服务接口
│       ├── impl/ProductServiceImpl.java        # 服务实现
│       ├── persistence/
│       │   ├── model/Product.java              # Entity
│       │   └── mapper/ProductMapper.java       # Mapper 接口
│       └── repository/
│           ├── IProductRepository.java         # 仓储接口
│           └── impl/ProductRepositoryImpl.java # 仓储实现
├── src/main/resources/
│   └── mappings/ProductMapper.xml              # Mapper XML
└── config/
    ├── application.yml
    ├── application-dev.yml
    ├── application-test.yml
    ├── application-prod.yml
    └── logback.xml (或 log4j2.xml)

my-app/
├── pom.xml (或 build.gradle + settings.gradle)
├── src/main/java/com/example/myapp/
│   └── MyappPrdApp.java                          # 启动类（含 RPC 注解）
└── config/
    ├── application.yml
    ├── application-dev.yml
    ├── application-test.yml
    ├── application-prod.yml
    └── logback.xml (或 log4j2.xml)

my-app/
├── pom.xml (或 build.gradle + settings.gradle)    # 父工程
│
├── my-app-api/                                     # API 定义模块
│   ├── pom.xml
│   └── src/main/java/com/example/myapp/api/
│       ├── IProductApi.java                        # API 接口（仅 SMART 架构生成）
│       ├── dto/ProductDto.java
│       ├── param/ProductParam.java
│       ├── request/
│       │   ├── ProductReq.java
│       │   └── ProductEditReq.java
│       └── response/ProductResp.java
│
├── my-app-server/                                  # 服务实现模块
│   ├── pom.xml
│   ├── src/main/java/com/example/myapp/
│   │   ├── ServerApp.java                          # 启动类
│   │   └── server/
│   │       ├── persistence/model/Product.java
│   │       ├── persistence/mapper/ProductMapper.java
│   │       ├── repository/
│   │       │   ├── IProductRepository.java
│   │       │   └── impl/ProductRepositoryImpl.java
│   │       ├── service/
│   │       │   ├── IProductService.java
│   │       │   └── impl/ProductServiceImpl.java
│   │       └── impl/
│   │           └── ProductRemoteImpl.java          # RPC 实现
│   ├── src/main/resources/mappings/ProductMapper.xml
│   └── config/
│       ├── application.yml / -dev.yml / -test.yml / -prod.yml
│       └── logback.xml
│
└── my-app-prd/                                     # PRD 层（Controller）
    ├── pom.xml
    └── src/main/java/com/example/myapp/
        ├── ClientApp.java                          # 启动类
        └── controller/
            └── ProductController.java              # Controller（通过 Remote 调用 Server）

my-app/
├── ...
├── my-app-prd-client/    # C 端 / 用户端 Controller
│   ├── ClientApp.java
│   └── controller/ProductController.java
└── my-app-prd-bms/       # B 端 / 管理后台 Controller
    ├── BmsApp.java
    └── controller/ProductBmsController.java

my-app/
├── pom.xml
│
├── my-app-api/                                     # API 定义模块
│   └── com/example/myapp/api/
│       ├── IProductApi.java                        # 统一 API 接口
│       ├── dto/ProductDto.java
│       ├── param/ProductParam.java
│       ├── request/ProductReq.java / ProductEditReq.java
│       └── response/ProductResp.java
│
├── my-app-server/                                  # 服务实现模块
│   └── com/example/myapp/server/
│       ├── persistence/model/Product.java
│       ├── persistence/mapper/ProductMapper.java
│       ├── repository/IProductRepository.java + impl/
│       ├── service/IProductService.java + impl/
│       ├── impl/ProductApiServerImpl.java          # API 服务端实现
│       └── config/MyappServerConfig.java           # 自动装配配置
│
├── my-app-remote/                                  # 远程调用模块（父项目）
│   │
│   ├── my-app-cloud-api/                           # Spring Cloud 客户端
│   │   └── com/example/myapp/remote/
│   │       ├── IProductRemote.java                 # Feign 接口
│   │       ├── impl/ProductApiScImpl.java          # API 的 SC 实现
│   │       ├── properties/MyappApiProperties.java  # 配置属性
│   │       └── config/MyappApiConfig.java          # 自动装配
│   │
│   ├── my-app-cloud-provider/                      # Spring Cloud 服务提供者
│   │   └── com/example/myapp/remote/provider/
│   │       └── impl/ProductRemoteImpl.java         # Remote 实现
│   │
│   ├── my-app-dubbo-api/                           # Dubbo 客户端
│   │   └── com/example/myapp/remote/
│   │       ├── IProductRemote.java                 # Dubbo 接口
│   │       └── impl/ProductApiDubboImpl.java       # API 的 Dubbo 实现
│   │
│   └── my-app-dubbo-provider/                      # Dubbo 服务提供者
│       └── com/example/myapp/remote/provider/
│           └── impl/ProductRemoteImpl.java
│
├── my-app-prd-client/                                 # PRD / Controller 层（C 端）
│   └── controller/ProductController.java
│
└── my-app-prd-bms/                                    # PRD / Controller 层（B 端）
    └── controller/ProductBmsController.java

project-type: microservice
rpc-type: cloud
prd-type: none          # 不生成 PRD（Controller）子项目

project-type: smart
prd-type: separation
code:
  model-list:
    - model-name: Order
      model-desc: 订单
    - model-name: OrderItem
      model-desc: 订单明细
      only-repository: true       # 只生成数据访问层
    - model-name: Payment
      model-desc: 支付记录
      create-controller: false    # 有 Service 但不生成 Controller

project-type: single
build-type: gradle
orm-type: MYBATIS_FLEX
app-type: BMS

@Data
@EqualsAndHashCode(callSuper = true)
@Accessors(chain = true)
@TableName("product")
@AutoMapper(target = ProductDto.class)
public class Product extends BaseMyBatisPlusEntity<Product> {

    @PrimaryKey
    @TableId(type = IdType.ASSIGN_UUID)
    @EntityColumn(comment = "商品信息ID")
    private String productId;

    @EntityColumn(comment = "商品名称")
    private String productName;

    @EntityColumn(comment = "商品价格")
    private BigDecimal price;
}

public interface ProductMapper extends BaseMapper<Product> {
}

@Data
@EqualsAndHashCode(callSuper = true)
@Accessors(chain = true)
@Schema(description = "商品信息数据对象")
@SuperBuilder
@NoArgsConstructor
public class ProductDto extends BaseDto {

    @PrimaryKey
    @Schema(description = "商品信息ID")
    private String productId;

    @Schema(description = "商品名称")
    private String productName;

    @Schema(description = "商品价格")
    private BigDecimal price;
}

@Data
@EqualsAndHashCode(callSuper = true)
@Accessors(chain = true)
@Schema(description = "商品信息数据参数对象")
@SuperBuilder
@NoArgsConstructor
public class ProductParam extends BasicParam {

    @Schema(description = "商品名称")
    private String productName;

    @Schema(description = "商品价格")
    private BigDecimal price;
}

public class ProductReq extends ProductParam {
}

public class ProductResp extends ProductDto {
}

public class ProductEditReq extends ProductDto {
}

public interface IProductRepository extends IBaseRepository<ProductDto, String> {
}

@Repository
public class ProductRepositoryImpl
    extends BaseMyBatisRepositoryImpl<ProductMapper, ProductDto, Product, String>
    implements IProductRepository {
}

public interface IProductService extends IBaseService<ProductResp, String, ProductReq> {
}

public interface IProductApi extends IBaseApi<ProductResp, String, ProductReq> {
}

@FeignClient(value = "${easyfk.config.remote.myapp.service-id:server}",
    path = "${easyfk.config.remote.myapp.base-path:/remote}/myapp/product")
public interface IProductRemote extends IBaseRemote<ProductResp, String, ProductReq> {
}

public interface IProductRemote extends IDubboBaseRemote<ProductResp, String, ProductReq> {
}

@SingleUniqueField(repetitionMsg = "商品名称已存在")
@EntityColumn(comment = "商品名称")
private String productName;

@CombUniqueField(repetitionMsg = "该分类下已存在同名商品", combinationField = "categoryId")
private String productName;

@BetweenConditionField
private LocalDateTime createTime;

@ForbiddenField(value = "forbidden")