一个实用的工具-Mybatis generator_综合

一个实用的工具-Mybatis generator

Mybatis generator：MyBatis的代码生成器，可以根据数据库的表生成model、mapper.xml、mapper接口和Example，通常情况下的单表查询不用再手写mapper。

下面我用一个例子来演示如何使用这个工具：

1.在pom文件中加入Mybatis generator的依赖

    <dependency><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-core</artifactId><version>1.3.3</version></dependency>

2.在数据库中建立好相关的表
在这里插入图片描述
3.在项目resource下创建一个generatorConfig.xml配置文件
对其中的mapper生成的路径，dao层的路径，model的路径的定义

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration><properties resource="generator.properties"/><context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat"><property name="beginningDelimiter" value="`"/><property name="endingDelimiter" value="`"/><property name="javaFileEncoding" value="UTF-8"/><!-- 为模型生成序列化方法--><plugin type="org.mybatis.generator.plugins.SerializablePlugin"/><!-- 为生成的Java模型创建一个toString方法 --><plugin type="org.mybatis.generator.plugins.ToStringPlugin"/><!--可以自定义生成model的代码注释--><commentGenerator type="com.lxy.malltest.mbg.CommentGenerator"><!-- 是否去除自动生成的注释 true：是 ： false:否 --><property name="suppressAllComments" value="true"/><property name="suppressDate" value="true"/><property name="addRemarkComments" value="true"/></commentGenerator><!--配置数据库连接--><jdbcConnection driverClass="${jdbc.driverClass}"connectionURL="${jdbc.connectionURL}"userId="${jdbc.userId}"password="${jdbc.password}"><!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题--><property name="nullCatalogMeansCurrent" value="true" /></jdbcConnection><!--指定生成model的路径--><javaModelGenerator targetPackage="com.lxy.malltest.mbg.model" targetProject="D:\IDEA\projects\malltest\src\main\java"/><!--指定生成mapper.xml的路径--><sqlMapGenerator targetPackage="com.lxy.malltest.mbg.mapper" targetProject="D:\IDEA\projects\malltest\src\main\resources"/><!--指定生成mapper接口的的路径--><javaClientGenerator type="XMLMAPPER" targetPackage="com.lxy.malltest.mbg.mapper"targetProject="D:\IDEA\projects\malltest\src\main\java"/><!--生成全部表tableName设为%--><table tableName="pms_brand"><generatedKey column="id" sqlStatement="MySql" identity="true"/></table></context>
</generatorConfiguration>

4.创建数据库配置文件generator.properties

jdbc.driverClass=com.mysql.cj.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
jdbc.userId=root
jdbc.password=lxy199795

5.创建Generator类，生成相关所需东西

public class Generator {public static void main(String[] args) throws Exception {//MBG 执行过程中的警告信息List<String> warnings = new ArrayList<String>();//当生成的代码重复时，覆盖原代码boolean overwrite = true;//读取我们的 MBG 配置文件InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = cp.parseConfiguration(is);is.close();DefaultShellCallback callback = new DefaultShellCallback(overwrite);//创建 MBGMyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);//执行生成代码myBatisGenerator.generate(null);//输出警告信息for (String warning : warnings) {System.out.println(warning);}}
}

6.创建CommentGenerator类，继承DefaultCommentGenerator类

public class CommentGenerator extends DefaultCommentGenerator {
}

7.然后运行Generator的main函数，你可以发现在之前定义的路径下已经有相应的mapper.xml函数和dao接口，和model类

在这里插入图片描述

综上：好好运用这个插件，可以减少很多的机械操作，可以把更多的时间放在项目架构的设计上。