Mybatis-PlusGenerator快速生成Java DAO層代碼

一、Mybatis-PlusGenerator是什麼

Mybatis-PlusGenerator是Mybatis-Plus框架中的一個代碼生成器工具，可以根據指定的表結構生成對應的Java DAO層代碼。作為Mybatis-Plus框架的一部分，它繼承了Mybatis-Plus框架的優點，包括強大的CRUD功能、方便的分頁查詢、支持複雜條件查詢等。同時，Mybatis-PlusGenerator可以免去手寫DAO層代碼的繁瑣過程，提高開發效率。

二、Mybatis-PlusGenerator的應用場景

Mybatis-PlusGenerator適用於以下場景：

1、需要對數據庫進行 CURD 操作的 Java Web 開發。

2、需要快速生成 DAO 層代碼的 Java 開發。

3、需要規範團隊開發的 Java Web 開發。

三、Mybatis-PlusGenerator的使用方法

以下將以MySQL數據庫為例，介紹Mybatis-PlusGenerator的使用方法。

1、在 pom.xml 中添加依賴：

“`

com.baomidou
mybatis-plus-generator
3.4.2

“`

2、添加 generatorConfig.xml 配置文件

在src/main/resources目錄下新建generatorConfig.xml文件，文件內容如下：

“`

“`

3、運行MybatisPlusGenerator

在 IDEA 中執行如下命令：

“`
public static void main(String[] args) throws FileNotFoundException {
// 執行代碼生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
//生成文件的輸出目錄
gc.setOutputDir(“D://zhaorui//test”);
// 是否覆蓋已有文件
gc.setFileOverride(true);
// 是否打開輸出目錄
gc.setOpen(false);
// 開啟 activeRecord 模式
gc.setActiveRecord(true);
// 是否在xml中添加二級緩存配置
gc.setEnableCache(false);
// 開啟 BaseResultMap
gc.setBaseResultMap(true);
// XML columList
gc.setBaseColumnList(false);
//排除生成的表
gc.setServiceImplName(“%sService”);
gc.setControllerName(“%sController”);
//自定義文件命名，注意 %s 會自動填充表實體屬性！
gc.setMapperName(“%sMapper”);
gc.setXmlName(“%sMapper”);
gc.setServiceName(“%sService”);
gc.setEntityName(“%s”);
gc.setAuthor(“zhaorui”);
mpg.setGlobalConfig(gc);
// 數據源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl(“jdbc:mysql://localhost:3306/demo?useSSL=false&useUnicode=true&characterEncoding=utf-8”);
// dsc.setSchemaName(“public”);
dsc.setDriverName(“com.mysql.jdbc.Driver”);
dsc.setUsername(“root”);
dsc.setPassword(“root123456”);
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setParent(“com.example.demo”);
// pc.setModuleName(“test”);
pc.setController(“controller”);
pc.setService(“service”);
pc.setServiceImpl(“service.impl”);
pc.setMapper(“mapper”);
pc.setEntity(“model”);
mpg.setPackageInfo(pc);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setController(null);
templateConfig.setServiceImpl(null);
templateConfig.setService(null);
templateConfig.setXml(null);
templateConfig.setMapper(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
//配置全局大寫命名
strategy.setCapitalMode(true);
// 所有表名前綴
strategy.setTablePrefix(new String[] {“t_”});
// 表名生成策略
strategy.setNaming(NamingStrategy.underline_to_camel);
// 需要生成的表
strategy.setInclude(new String[] {“user”});
//strategy.setExclude(new String[]{“test”}); // 排除生成的表
// 自定義實體Father類
strategy.setSuperMapperClass(null);
strategy.setSuperServiceClass(null);
strategy.setSuperServiceImplClass(null);
strategy.setSuperControllerClass(null);
strategy.setSuperEntityClass(null);
//自定義基礎的Entity類，公共字段
strategy.setSuperEntityColumns(new String[]{“id”});
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
strategy.setEntityBuilderModel(true);
mpg.setStrategy(strategy);
mpg.execute();
}
“`

四、Mybatis-PlusGenerator的實現原理

Mybatis-PlusGenerator的實現原理可以總結為兩部分，分別是根據數據庫 schema 信息生成 Java 實體，以及根據 Java 實體生成 Mybatis XML 文件。

在根據數據庫 schema 信息生成 Java 實體過程中，主要分為以下幾個步驟：

1、連接數據庫：通過 JDBC 連接驅動連接數據庫，獲取數據庫元數據。

2、解析元數據：通過元數據獲取數據庫的各種信息，如庫名、表名、列名、表結構等。

3、代碼生成：根據元數據生成 Java 實體源代碼，並將其保存至指定路徑。

在根據 Java 實體生成 Mybatis XML 文件過程中，主要分為以下幾個步驟：

1、讀取 Java 實體：從指定路徑讀取 Java 實體源代碼。

2、解析 Java 實體：解析 Java 實體源代碼，獲取其字段名稱、數據類型等信息。

3、代碼生成：根據 Java 實體信息生成 Mybatis 相關的 XML 文件內容，並將其保存至指定路徑。

五、小結

Mybatis-PlusGenerator是一款開源的Java代碼生成器工具，可以根據數據庫表自動生成Java DAO層代碼。它操作簡單、易上手，大大提高了開發效率。