MyBatis-Plus实体类自动生成数据库表实战指南-代码聚汇网

MyBatis-Plus实体类自动生成数据库表实战指南

贵萌兄

1. 为什么需要实体类自动生成数据库表？

在Java企业级开发中，数据持久化是每个项目都无法绕开的核心环节。传统开发流程中，我们需要先在数据库中手动创建表结构，然后再在代码中编写对应的实体类。这种模式存在几个明显的痛点：

维护成本高：当表结构变更时，需要同步修改数据库和代码中的实体类，容易遗漏或出错
效率低下：开发初期需要频繁切换数据库客户端和IDE，打断编码思路
一致性难保证：字段类型、长度等属性在数据库和代码中可能不一致

MyBatis-Plus提供的自动建表功能正是为了解决这些问题而生。它基于JPA注解的实体类定义，自动生成对应的数据库表结构，实现了"代码即文档"的理念。这种方式特别适合：

快速原型开发阶段
小型项目或微服务架构
需要频繁调整数据模型的迭代开发

注意：生产环境使用此功能需谨慎，建议配合Flyway等数据库版本管理工具使用

2. 基础环境配置

2.1 依赖引入

首先确保项目中已正确引入MyBatis-Plus和相关数据库驱动：

xml复制<dependencies>
    <!-- MyBatis-Plus核心依赖 -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.3.1</version>
    </dependency>
    
    <!-- 数据库驱动（以MySQL为例） -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>8.0.28</version>
    </dependency>
    
    <!-- 代码生成器依赖（可选） -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.5.3.1</version>
    </dependency>
</dependencies>

2.2 数据库连接配置

在application.yml中配置数据库连接和MyBatis-Plus相关属性：

yaml复制spring:
  datasource:
    url: jdbc:mysql://localhost:3306/auto_create_db?useSSL=false&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

mybatis-plus:
  global-config:
    db-config:
      # 配置逻辑删除字段名（可选）
      logic-delete-field: deleted
      # 配置逻辑删除值（可选）
      logic-delete-value: 1
      logic-not-delete-value: 0
  configuration:
    # 开启下划线转驼峰
    map-underscore-to-camel-case: true
    # 日志实现
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

3. 实体类注解详解

3.1 基础注解配置

一个完整的实体类应该包含表名、字段名、主键等基础注解：

java复制import com.baomidou.mybatisplus.annotation.*;

@TableName("sys_user")  // 指定表名
public class User {
    @TableId(type = IdType.AUTO)  // 主键自增
    private Long id;
    
    @TableField("username")  // 指定字段名
    private String name;
    
    private Integer age;
    
    @TableField(exist = false)  // 非数据库字段
    private String tempField;
    
    // 省略getter/setter
}

3.2 字段类型与约束

通过注解可以定义字段的各种约束条件：

java复制public class Product {
    @TableField(value = "product_name", length = 100)
    private String name;
    
    @TableField(value = "price", scale = 2)
    private BigDecimal price;
    
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
    
    @Version  // 乐观锁版本号字段
    private Integer version;
    
    @TableLogic  // 逻辑删除字段
    private Integer deleted;
}

3.3 枚举类型处理

MyBatis-Plus提供了完善的枚举类型支持：

java复制public enum Gender {
    MALE(1, "男"),
    FEMALE(2, "女");
    
    @EnumValue  // 标记数据库存储的值
    private final int code;
    private final String desc;
    
    // 构造方法、getter省略
}

public class User {
    private Gender gender;
}

4. 自动建表配置与实现

4.1 配置自动建表策略

在Spring Boot启动类或配置类中添加自动建表配置：

java复制import com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MybatisPlusConfig {
    
    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception {
        MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
        factory.setDataSource(dataSource);
        
        // 自动建表配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setDbConfig(new GlobalConfig.DbConfig()
            .setSchema("auto_create_db")
            .setTablePrefix("t_")  // 表前缀
            .setIdType(IdType.AUTO)  // 主键策略
        );
        
        factory.setGlobalConfig(globalConfig);
        return factory.getObject();
    }
}

4.2 实现自动建表逻辑

创建AutoCreateTableListener实现ApplicationListener接口：

java复制import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.core.toolkit.StringUtils;
import com.baomidou.mybatisplus.extension.toolkit.JdbcUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

import javax.sql.DataSource;
import java.util.List;
import java.util.Map;

@Component
public class AutoCreateTableListener implements ApplicationListener<ContextRefreshedEvent> {
    
    @Autowired
    private DataSource dataSource;
    
    @Autowired
    private JdbcTemplate jdbcTemplate;
    
    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        DbType dbType = JdbcUtils.getDbType(dataSource);
        if (dbType != DbType.MYSQL) {
            throw new RuntimeException("当前仅支持MySQL数据库");
        }
        
        // 检查表是否存在
        List<Map<String, Object>> tables = jdbcTemplate.queryForList(
            "SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = DATABASE()");
        
        // 这里应该添加实际的建表逻辑
        if (!tableExists(tables, "sys_user")) {
            jdbcTemplate.execute("CREATE TABLE sys_user (...)");
        }
    }
    
    private boolean tableExists(List<Map<String, Object>> tables, String tableName) {
        return tables.stream().anyMatch(map -> 
            tableName.equalsIgnoreCase((String) map.get("TABLE_NAME")));
    }
}

5. 实战案例：用户管理系统

5.1 完整实体类定义

java复制import com.baomidou.mybatisplus.annotation.*;
import lombok.Data;
import java.time.LocalDateTime;

@Data
@TableName("sys_user")
public class User {
    @TableId(type = IdType.AUTO)
    private Long id;
    
    @TableField(value = "username", length = 50)
    private String username;
    
    @TableField(value = "password", length = 100)
    private String password;
    
    @TableField(value = "email", length = 100)
    private String email;
    
    @TableField(value = "phone", length = 20)
    private String phone;
    
    @TableField(value = "avatar", length = 255)
    private String avatar;
    
    @TableField(value = "status")
    private Integer status;
    
    @TableField(value = "create_time", fill = FieldFill.INSERT)
    private LocalDateTime createTime;
    
    @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
    
    @Version
    private Integer version;
    
    @TableLogic
    private Integer deleted;
}

5.2 自动生成的SQL语句

基于上述实体类，MyBatis-Plus会生成如下建表语句：

sql复制CREATE TABLE IF NOT EXISTS sys_user (
    id BIGINT(20) NOT NULL AUTO_INCREMENT COMMENT '主键ID',
    username VARCHAR(50) COMMENT '用户名',
    password VARCHAR(100) COMMENT '密码',
    email VARCHAR(100) COMMENT '邮箱',
    phone VARCHAR(20) COMMENT '手机号',
    avatar VARCHAR(255) COMMENT '头像',
    status INT(11) COMMENT '状态',
    create_time DATETIME COMMENT '创建时间',
    update_time DATETIME COMMENT '更新时间',
    version INT(11) COMMENT '版本号',
    deleted INT(11) COMMENT '逻辑删除',
    PRIMARY KEY (id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='用户表';

5.3 服务层实现

java复制import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
    
    public boolean saveUser(User user) {
        return save(user);
    }
    
    public User getUserById(Long id) {
        return getById(id);
    }
    
    public boolean updateUser(User user) {
        return updateById(user);
    }
    
    public boolean deleteUser(Long id) {
        return removeById(id);
    }
}

6. 常见问题与解决方案

6.1 字段类型映射问题

MyBatis-Plus会自动将Java类型映射为数据库类型，但有时需要手动指定：

Java类型	默认数据库类型	推荐注解配置
String	VARCHAR(255)	@TableField(length=100)
BigDecimal	DECIMAL(19,2)	@TableField(scale=4)
LocalDateTime	DATETIME	无需额外配置
Enum	INT	@EnumValue标记枚举值

6.2 主键策略选择

MyBatis-Plus支持多种主键生成策略：

java复制public enum IdType {
    AUTO(0),  // 数据库自增
    NONE(1),  // 无主键
    INPUT(2),  // 手动输入
    ASSIGN_ID(3),  // 分配ID(雪花算法)
    ASSIGN_UUID(4);  // 分配UUID
    
    // 省略实现
}

提示：分布式系统推荐使用ASSIGN_ID(雪花算法)，单机应用可以使用AUTO自增

6.3 表已存在时的处理策略

当表已存在时，有几种处理方式：

跳过创建：默认行为，不会覆盖已有表
删除重建：开发环境可用，生产环境慎用
字段比对更新：复杂但最实用，需要自定义逻辑

实现字段比对更新的示例代码：

java复制public void syncTableStructure(Class<?> entityClass) {
    // 获取实体类注解信息
    TableName tableName = entityClass.getAnnotation(TableName.class);
    String table = tableName.value();
    
    // 获取数据库现有字段
    List<Map<String, Object>> columns = jdbcTemplate.queryForList(
        "SELECT COLUMN_NAME, DATA_TYPE, CHARACTER_MAXIMUM_LENGTH " +
        "FROM INFORMATION_SCHEMA.COLUMNS " +
        "WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = ?", table);
    
    // 比对并生成ALTER语句
    // 实现细节省略...
}

7. 高级功能扩展

7.1 多数据源支持

在多数据源环境下，需要为每个数据源单独配置自动建表：

java复制@Configuration
public class DataSourceConfig {
    
    @Bean
    @ConfigurationProperties("spring.datasource.db1")
    public DataSource db1DataSource() {
        return DataSourceBuilder.create().build();
    }
    
    @Bean
    public SqlSessionFactory db1SqlSessionFactory() throws Exception {
        MybatisSqlSessionFactoryBean factory = new MybatisSqlSessionFactoryBean();
        factory.setDataSource(db1DataSource());
        // 配置自动建表等
        return factory.getObject();
    }
    
    // 其他数据源配置类似
}

7.2 使用MyBatis-Plus Generator

对于更复杂的场景，可以使用代码生成器：

java复制public class CodeGenerator {
    public static void main(String[] args) {
        AutoGenerator generator = new AutoGenerator();
        
        // 全局配置
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setOutputDir(System.getProperty("user.dir") + "/src/main/java");
        globalConfig.setAuthor("YourName");
        generator.setGlobalConfig(globalConfig);
        
        // 数据源配置
        DataSourceConfig dataSourceConfig = new DataSourceConfig();
        dataSourceConfig.setDbType(DbType.MYSQL);
        dataSourceConfig.setUrl("jdbc:mysql://localhost:3306/auto_create_db");
        dataSourceConfig.setUsername("root");
        dataSourceConfig.setPassword("123456");
        generator.setDataSource(dataSourceConfig);
        
        // 包配置
        PackageConfig packageConfig = new PackageConfig();
        packageConfig.setParent("com.example");
        generator.setPackageInfo(packageConfig);
        
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);
        generator.setStrategy(strategy);
        
        generator.execute();
    }
}

7.3 结合Flyway进行版本控制

生产环境建议结合Flyway管理数据库变更：

java复制@Configuration
public class FlywayConfig {
    
    @Bean
    public Flyway flyway(DataSource dataSource) {
        Flyway flyway = Flyway.configure()
            .dataSource(dataSource)
            .locations("classpath:db/migration")
            .baselineOnMigrate(true)
            .load();
        flyway.migrate();
        return flyway;
    }
}

在resources/db/migration目录下创建V1__Initial_schema.sql：

sql复制-- 这里放置初始建表SQL
CREATE TABLE IF NOT EXISTS sys_user (...);

8. 性能优化建议

批量建表优化：对于需要创建大量表的情况，建议：
- 使用事务批量执行DDL语句
- 并行创建无关联的表

索引优化：在实体类中定义索引：

java复制@TableName(value = "sys_user", indexes = {
    @Index(name = "idx_username", columnList = "username"),
    @Index(name = "idx_email", columnList = "email", unique = true)
})

字段默认值：通过注解设置字段默认值：

java复制@TableField(value = "status", insertStrategy = FieldStrategy.DEFAULT)
private Integer status = 0;

禁用自动建表：生产环境建议关闭自动建表功能，改为使用迁移工具
缓存表结构信息：避免每次启动都查询数据库元数据

我在实际项目中使用这套方案时发现，对于中小型项目，自动建表可以显著提升开发效率。但在大型分布式系统中，更推荐使用专业的数据库迁移工具。一个实用的技巧是：在开发环境使用自动建表，而在CI/CD流程中通过Flyway或Liquibase来管理生产环境的数据库变更。