如何使用MybatisPlusGenerator生成代碼

MybatisPlusGenerator是一款MybatisPlus框架自帶的代碼生成工具，可以快速幫助開發者生成單表的CRUD代碼，大大提高了開發效率。本文將從選用MybatisPlusGenerator的必要性、使用前的準備工作、使用MybatisPlusGenerator生成代碼的步驟、生成代碼後的自定義修改以及其他使用注意事項等幾個方面來詳細講解如何使用MybatisPlusGenerator生成代碼。

一、選用MybatisPlusGenerator的必要性

在使用Mybatis進行單表增刪改查的開發過程中，我們往往需要手寫大量的Mapper.xml、Mapper.java以及Entity.java等文件。當表的結構比較複雜時，手寫代碼的工作量很大，而且需要花費大量的時間和精力。MybatisPlusGenerator則可以自動幫我們生成這些文件，從而免去了大量繁瑣的工作，提高了開發效率，減少了出錯的可能性。此外，使用MybatisPlusGenerator生成的代碼風格統一、規範化，可以提高代碼的可讀性和可維護性，是一個非常好用的代碼生成工具。

二、使用前的準備工作

在使用MybatisPlusGenerator之前，我們需要先完成以下幾個準備工作：

1、在項目的pom.xml文件中引入MybatisPlusGenerator依賴：

“`

com.baomidou
mybatis-plus-generator
${mybatis-plus.version}

“`

2、在項目的配置文件（如application.properties）中配置數據源等信息：

“`
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false
spring.datasource.username=root
spring.datasource.password=root
“`

三、使用MybatisPlusGenerator生成代碼的步驟

使用MybatisPlusGenerator生成代碼的步驟如下：

1、編寫一個代碼生成器的配置類（GeneratorConfig.java），並在該類中指定需要生成代碼的表名、包名等相關信息。

“`
package com.example.demo.config;

import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;

/**
* 代碼生成器配置類
*/
public class GeneratorConfig {

public static void main(String[] args) {

// 1、創建代碼生成器對象
AutoGenerator mpg = new AutoGenerator();

// 2、全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty(“user.dir”);
gc.setOutputDir(projectPath + “/src/main/java”);
gc.setAuthor(“your_name”);
gc.setOpen(false);
gc.setFileOverride(true);
gc.setServiceName(“%sService”);
gc.setIdType(IdType.ID_WORKER);
gc.setSwagger2(true);
mpg.setGlobalConfig(gc);

// 3、數據源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(“jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=false”);
dsc.setDriverName(“com.mysql.cj.jdbc.Driver”);
dsc.setUsername(“root”);
dsc.setPassword(“root”);
dsc.setDbType(DbType.MYSQL);
mpg.setDataSource(dsc);

// 4、包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(“”);
pc.setParent(“com.example.demo”);
pc.setMapper(“mapper”);
pc.setEntity(“entity”);
pc.setService(“service”);
pc.setController(“controller”);
mpg.setPackageInfo(pc);

// 5、策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setInclude(“table_name”); // 指定需要生成代碼的表名
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setControllerMappingHyphenStyle(true);
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());

// 6、執行代碼生成器
mpg.execute();
}
}
“`

2、運行GeneratorConfig.java類的main()方法即可生成代碼。

四、生成代碼後的自定義修改

生成的代碼可能並不完全符合我們的要求，我們可以對代碼進行一些自定義修改。例如，我們可以修改Entity.java中的屬性名稱以及類型名稱，使其更符合我們的習慣。

五、其他使用注意事項

1、MybatisPlusGenerator默認使用了Freemarker作為模板引擎，如果你的項目中沒有引入Freemarker依賴，可以在pom.xml文件中添加如下依賴：

“`

org.freemarker
freemarker
2.3.31

“`

2、MybatisPlusGenerator生成的Mapper接口的方法名和返回類型是根據Entity類中屬性的類型和名稱自動生成的，有些情況下可能需要手動修改Mapper接口。

3、在生成代碼之前需要保證數據庫中有需要生成代碼的表。

總結

本文對如何使用MybatisPlusGenerator生成代碼進行了詳細的講解，從必要性、使用前的準備工作、使用步驟、自定義修改以及其他使用注意事項等多個方面進行了闡述。MybatisPlusGenerator是一個極為方便、實用的代碼生成工具，對提高開發效率，減少出錯的可能性，統一代碼風格具有重要的作用。