mybatis plus 自动生成代码
时间: 2023-07-03 11:23:10 浏览: 139
MyBatis-Plus 是 MyBatis 的增强工具,提供了多种实用的功能,其中包括自动生成 MyBatis 代码的功能。
MyBatis-Plus 自动生成代码的主要步骤如下:
1. 添加 MyBatis-Plus 依赖
在 Maven 项目中,可以通过添加以下依赖来引入 MyBatis-Plus:
```xml
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>3.4.2</version>
</dependency>
```
2. 配置代码生成器
MyBatis-Plus 提供了一个代码生成器,可以根据数据库表结构自动生成对应的实体类、Mapper 接口和 XML 映射文件。可以通过创建一个配置类来配置代码生成器。例如:
```java
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
@Bean
public ConfigurationCustomizer configurationCustomizer() {
return configuration -> configuration.setUseDeprecatedExecutor(false);
}
@Bean
public GlobalConfig globalConfig() {
GlobalConfig globalConfig = new GlobalConfig();
globalConfig.setSqlInjector(new LogicSqlInjector());
globalConfig.setMetaObjectHandler(new MyMetaObjectHandler());
globalConfig.setBanner(false);
return globalConfig;
}
@Bean
public DataSource dataSource() {
// 配置数据源
}
@Bean
public MybatisSqlSessionFactoryBean mybatisSqlSessionFactoryBean() {
MybatisSqlSessionFactoryBean factoryBean = new MybatisSqlSessionFactoryBean();
factoryBean.setDataSource(dataSource());
factoryBean.setPlugins(mybatisPlusInterceptor());
factoryBean.setGlobalConfig(globalConfig());
return factoryBean;
}
@Bean
public MybatisMapperScannerConfigurer mybatisMapperScannerConfigurer() {
MybatisMapperScannerConfigurer scannerConfigurer = new MybatisMapperScannerConfigurer();
scannerConfigurer.setBasePackage("com.example.mapper");
return scannerConfigurer;
}
@Bean
public MybatisPlusProperties mybatisPlusProperties() {
MybatisPlusProperties properties = new MybatisPlusProperties();
properties.setTypeAliasesPackage("com.example.entity");
return properties;
}
@Bean
public MybatisSqlSessionTemplate mybatisSqlSessionTemplate() throws Exception {
return new MybatisSqlSessionTemplate(mybatisSqlSessionFactoryBean().getObject());
}
@Bean
public MybatisPlusAutoConfiguration mybatisPlusAutoConfiguration(ObjectProvider<List<MybatisPlusPropertiesCustomizer>> mybatisPlusPropertiesCustomizersProvider,
ObjectProvider<Interceptor[]> interceptorsProvider,
ObjectProvider<LanguageDriver[]> languageDriversProvider,
ResourceLoader resourceLoader,
ObjectProvider<DatabaseIdProvider> databaseIdProvider,
ObjectProvider<List<ConfigurationCustomizer>> configurationCustomizersProvider) {
return new MybatisPlusAutoConfiguration(mybatisPlusProperties(),
mybatisSqlSessionFactoryBean(),
mybatisSqlSessionTemplate(),
mybatisMapperScannerConfigurer(),
mybatisPlusPropertiesCustomizersProvider.getIfAvailable(),
interceptorsProvider.getIfAvailable(),
languageDriversProvider.getIfAvailable(),
resourceLoader,
databaseIdProvider.getIfAvailable(),
configurationCustomizersProvider.getIfAvailable());
}
}
```
上述代码中配置了 Mybatis-Plus 的多个组件,包括:数据源、MyBatis 插件、全局配置、Mapper 接口扫描器、实体类别名、SqlSessionFactory 等。
3. 配置代码生成器属性
可以通过在配置文件中添加以下属性来配置代码生成器:
```yaml
mybatis-plus:
generator:
entity: # 实体类配置
output-dir: src/main/java # 输出目录
mapper: # Mapper 接口配置
base-package: com.example.mapper # 包名
xml: src/main/resources/mapper # XML 文件目录
service: # Service 接口配置
base-package: com.example.service # 包名
service-impl: # Service 实现类配置
base-package: com.example.service.impl # 包名
controller: # Controller 类配置
base-package: com.example.controller # 包名
global-config: # 全局配置
db-column-underline: true # 数据库列名是否使用下划线命名
id-type: INPUT # 主键 ID 生成策略
logic-delete-field: deleted # 逻辑删除字段名
logic-delete-value: 1 # 逻辑删除值
logic-not-delete-value: 0 # 逻辑未删除值
```
4. 运行代码生成器
在配置好代码生成器后,可以通过运行 MybatisPlusGenerator 类来生成代码。例如:
```java
public class MybatisPlusGenerator {
public static void main(String[] args) {
// 代码生成器
AutoGenerator generator = new AutoGenerator();
// 配置数据源
generator.setDataSource(new DataSourceConfig()
.setUrl("jdbc:mysql://localhost:3306/db_test")
.setDriverName("com.mysql.jdbc.Driver")
.setUsername("root")
.setPassword("password"));
// 全局配置
generator.setGlobalConfig(new GlobalConfig()
.setOutputDir(System.getProperty("user.dir") + "/src/main/java")
.setFileOverride(true)
.setActiveRecord(true)
.setEnableCache(false)
.setBaseResultMap(true)
.setBaseColumnList(true)
.setAuthor("author"));
// 包配置
generator.setPackageInfo(new PackageConfig()
.setParent("com.example")
.setController("controller")
.setEntity("entity")
.setMapper("mapper")
.setService("service")
.setServiceImpl("service.impl"));
// 策略配置
generator.setStrategy(new StrategyConfig()
.setNaming(NamingStrategy.underline_to_camel)
.setColumnNaming(NamingStrategy.underline_to_camel)
.setEntityLombokModel(true)
.setRestControllerStyle(true)
.setLogicDeleteFieldName("deleted")
.setControllerMappingHyphenStyle(true)
.setInclude("table_1", "table_2"));
// 执行生成代码
generator.execute();
}
}
```
在运行 MybatisPlusGenerator 类后,将会根据配置生成对应的实体类、Mapper 接口和 XML 映射文件。
阅读全文