SpringBoot整合MyBatis-Plus代码生成器的示例代码

数据库表 user
  → Entity（实体类，字段 + 注解）
  → Mapper（数据访问接口 + XML）
  → Service（业务逻辑接口 + 实现）
  → Controller（RESTful 接口）

<!-- MyBatis-Plus 核心 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.5.3.1</version>
</dependency>
<!-- 代码生成器 -->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.5.3.1</version>
    <scope>test</scope>
</dependency>
<!-- 模板引擎 -->
<dependency>
    <groupId>org.apache.velocity</groupId>
    <artifactId>velocity-engine-core</artifactId>
    <version>2.3</version>
    <scope>test</scope>
</dependency>

public class CodeGenerator {

    public static void main(String[] args) {
        // 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig.Builder(
            "jdbc:mysql://localhost:3306/seckill_db?useUnicode=true&characterEncoding=utf-8",
            "root",
            "123456"
        ).build();

        // 全局配置
        GlobalConfig globalConfig = new GlobalConfig.Builder()
            .outputDir(System.getProperty("user.dir") + "/src/main/java")
            .author("张政")
            .openDir(false)
            .build();

        // 包配置
        PackageConfig packageConfig = new PackageConfig.Builder()
            .parent("com.zhang.seckill")
            .entity("model.entity")
            .service("service")
            .serviceImpl("service.impl")
            .mapper("mapper")
            .controller("controller")
            .build();

        // 策略配置
        StrategyConfig strategyConfig = new StrategyConfig.Builder()
            .addInclude("seckill_product", "seckill_order")  // 要生成的表
            .addTablePrefix("seckill_")                      // 表前缀过滤
            .entityBuilder()
            .enableLombok()
            .enableTableFieldAnnotation()
            .serviceBuilder()
            .formatServiceFileName("%sService")
            .formatServiceImplFileName("%sServiceImpl")
            .controllerBuilder()
            .enableRestStyle()
            .enableHyphenStyle()
            .build();

        // 执行生成
        AutoGenerator generator = new AutoGenerator.Builder(dataSourceConfig)
            .global(globalConfig)
            .packageInfo(packageConfig)
            .strategy(strategyConfig)
            .build();

        generator.execute();
    }
}

src/main/java/com/zhang/seckill/
├── model/entity/
│   ├── SeckillProduct.java      ← 实体类（带 @TableName、@TableId 注解）
│   └── SeckillOrder.java
├── mapper/
│   ├── SeckillProductMapper.java ← Mapper 接口（继承 BaseMapper）
│   └── SeckillOrderMapper.java
├── service/
│   ├── SeckillProductService.java ← Service 接口
│   └── SeckillOrderService.java
├── service/impl/
│   ├── SeckillProductServiceImpl.java ← Service 实现（继承 ServiceImpl）
│   └── SeckillOrderServiceImpl.java
└── controller/
    ├── SeckillProductController.java ← Controller（RESTful CRUD）
    └── SeckillOrderController.java

@RestController
@RequestMapping("/seckill-product")
public class SeckillProductController {

    @Autowired
    private SeckillProductService seckillProductService;

    @GetMapping
    public ResultVO<Page<SeckillProduct>> list(
            @RequestParam(defaultValue = "1") int page,
            @RequestParam(defaultValue = "20") int size) {
        return ResultVO.success(
            seckillProductService.page(new Page<>(page, size)));
    }

    @GetMapping("/{id}")
    public ResultVO<SeckillProduct> get(@PathVariable Long id) {
        return ResultVO.success(seckillProductService.getById(id));
    }

    @PostMapping
    public ResultVO<SeckillProduct> add(@RequestBody SeckillProduct product) {
        seckillProductService.save(product);
        return ResultVO.success(product);
    }

    @PutMapping("/{id}")
    public ResultVO<SeckillProduct> update(
            @PathVariable Long id, @RequestBody SeckillProduct product) {
        product.setId(id);
        seckillProductService.updateById(product);
        return ResultVO.success(product);
    }

    @DeleteMapping("/{id}")
    public ResultVO<?> delete(@PathVariable Long id) {
        seckillProductService.removeById(id);
        return ResultVO.success("删除成功");
    }
}

.controllerBuilder()
.templatePath("/templates/controller.java.vm")  // 自定义模板路径

// controller.java.vm（简化版）
package ${package.Controller};

import org.springframework.web.bind.annotation.*;
import ${package.Service}.${table.serviceName};

@RestController
@RequestMapping("/${table.entityPath}")
public class ${table.controllerName} {

    @Autowired
    private ${table.serviceName} ${table.serviceName?uncap_first};

    @GetMapping
    public ResultVO<?> list() {
        return ResultVO.success(
            ${table.serviceName?uncap_first}.list());
    }
}

// 1. 生成后手动调整
// 自动生成的 Controller 只有基础 CRUD
// 复杂的业务查询需要手写

// 2. 只生成一次
// 表结构稳定后再生成，避免反复覆盖导致手写代码丢失

// 3. 生成器配置建议
strategyConfig = new StrategyConfig.Builder()
    .addInclude("user", "product", "order")  // 指定表
    .entityBuilder()
    .enableLombok()               // 用 Lombok 省掉 getter/setter
    .enableTableFieldAnnotation()  // 每个字段加 @TableField
    .logicDeleteColumnName("is_deleted")  // 逻辑删除
    .versionColumnName("version")  // 乐观锁
    .controllerBuilder()
    .enableRestStyle()            // @RestController
    .build();

File → Settings → Plugins → 搜索 MyBatisX → Install

生成器 → 模板代码 + 基础 CRUD
开发者 → 复杂 SQL + 业务逻辑 + 异常处理