Spring Boot 使用MyBatis Generator 自动生成代码

大型项目中一般会有很多个数据库表,如果开发人员针对每一个表都手动去建立表,那么将耗费大量的时间,为了节约开发人员的时间,Mybatis官方开发了一款自动生成工具--MyBatis Generator ,它可以自动生成数据库实体,Dao和对应的Mapper 文件。其官方地址为: http://www.mybatis.org/generator/

创建数据库表

CREATE TABLE `test`.`t_user` (
  `id` BIGINT (11) NOT NULL AUTO_INCREMENT COMMENT 'id',
  `user_name` VARCHAR (32) NOT NULL COMMENT '用户名',
  `password` VARCHAR (32) NOT NULL COMMENT '密码',
  `age` INT (3) NOT NULL COMMENT '年龄',
  PRIMARY KEY (`id`)
) COMMENT = '用户信息表' ;

引入POM依赖

 <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.46</version>
            <scope>runtime</scope>
  </dependency>
<dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
  </dependency>
<dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.5</version>
  </dependency>

配置mybatis-generator.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">

<generatorConfiguration>

    <!-- 一个数据库一个context -->
    <context id="sqlserverTables">
        <!-- 生成的pojo,将implements Serializable -->
        <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
        <!-- 注释 -->
        <commentGenerator type="org.mybatis.generator.internal.MybatisCommentGenerator" >
            <property name="addRemarkComments" value="true"/> <!--增加数据库备注-->
            <property name="suppressAllComments" value="true" /> <!--是否取消注释 -->
            <property name="suppressDate" value="false"/> <!--是否生成注释代时间戳 -->
        </commentGenerator>

        <!-- 数据库链接URL、用户名、密码 -->
        <!-- 连接字符串 -->
        <jdbcConnection driverClass="com.mysql.jdbc.Driver"
                        connectionURL="jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai&amp;nullCatalogMeansCurrent=true"
                        userId="root"
                        password="">
        </jdbcConnection>

        <!-- 类型转换 -->
        <javaTypeResolver>
            <!-- 默认false,把JDBC DECIMAL 和 NUMERIC 类型解析为 Integer true,把JDBC DECIMAL
                和 NUMERIC 类型解析为java.math.BigDecimal -->
            <property name="forceBigDecimals" value="false" />
        </javaTypeResolver>

        <!-- 生成model模型,对应的包路径,以及文件存放路径(targetProject),targetProject可以指定具体的路径,如./src/main/java,
            也可以使用“MAVEN”来自动生成,这样生成的代码会在target/generatord-source目录下 -->
        <javaModelGenerator targetPackage="com.github.jackieonway.bean.entity" targetProject="src/main/java">
            <!-- 是否在当前路径下新加一层schema,eg:fase路径com.oop.eksp.user.model, true:com.github.jackieonwaymodel.[schemaName] -->
            <property name="enableSubPackages" value="false" />
            <!-- 从数据库返回的值被清理前后的空格 -->
            <property name="trimStrings" value="true" />
            <!-- 是否生成构造函数 默认是false -->
            <property name="constructorBased" value="false"/>
        </javaModelGenerator>

        <!--对应的mapper.xml文件 -->
        <sqlMapGenerator targetPackage="com.github.jackieonway.dao.mapper" targetProject="src\main\java\">
            <property name="enableSubPackages" value="false" />
            <property name="constructorBased" value="false"/>
        </sqlMapGenerator>

        <!-- 对应的Mapper接口类文件 -->
        <javaClientGenerator type="XMLMAPPER"
                             targetPackage="com.github.jackieonway.dao.mapper" targetProject="src\main\java">
            <property name="enableSubPackages" value="false" />
            <property name="constructorBased" value="false"/>
        </javaClientGenerator>

        <table  tableName="t_user"  domainObjectName="UserDo"
                enableCountByExample="false" enableUpdateByExample="false"
                enableDeleteByExample="false" enableSelectByExample="false"
                selectByExampleQueryId="false" mapperName="UserDao">
            <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
        </table>

    </context>
</generatorConfiguration>

如果需要在实体类中生成注释,需要将<property name="suppressAllComments" value="true" /> 中的true改为false。多个表请将table标签复制多份然后对应数据库表更改对应的内容。

生成代码

(一)、使用Idea配置MyBatis Generator 插件

<plugin>
                <groupId>org.mybatis.generator</groupId>
                <artifactId>mybatis-generator-maven-plugin</artifactId>
                <version>1.3.5</version>
                <configuration>
                    <!--generator配置文件所在位置-->
                    <configurationFile>${basedir}/src/main/resources/mybatis/generatorConfig.xml</configurationFile>
                    <overwrite>true</overwrite>
                    <verbose>true</verbose>
                </configuration>
                <dependencies>
                    <dependency>
                        <groupId>mysql</groupId>
                        <artifactId>mysql-connector-java</artifactId>
                        <version>${mysql.version}</version>
                    </dependency>
                </dependencies>
            </plugin>

配置完成之后,点击 Maven Projects ,选中项目,点开之后,继续打开mybatis-generator,之后双击 mybatis-generator:generate

Idea Mybatis generator插件.png

稍等片刻让程序运行结束
任何形式的转载都请联系作者Jackieonwa获得授权并注明出处。

D:\Java\jdk1.8.0_171\bin\java.exe -Dmaven.multiModuleProjectDirectory=E:\Code\demo\demo-mybatis-plus -Dmaven.home=D:\develop\apache-maven-3.5.3 -Dclassworlds.conf=D:\develop\apache-maven-3.5.3\bin\m2.conf "-javaagent:D:\JetBrains\IntelliJ IDEA 2018.1.3\lib\idea_rt.jar=55586:D:\JetBrains\IntelliJ IDEA 2018.1.3\bin" -Dfile.encoding=UTF-8 -classpath D:\develop\apache-maven-3.5.3\boot\plexus-classworlds-2.5.2.jar org.codehaus.classworlds.Launcher -Didea.version=2018.1.3 -s D:\develop\apache-maven-3.5.3\conf\settings.xml org.mybatis.generator:mybatis-generator-maven-plugin:1.3.5:generate -f pom.xml
[INFO] Scanning for projects...
[INFO] 
[INFO] -------------------< com.example:demo-mybatis-generator>--------------------
[INFO] Building demo-mybatis-generator0.0.1-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO] 
[INFO] --- mybatis-generator-maven-plugin:1.3.5:generate (default-cli) @ demo-mybatis-generator---
[INFO] Connecting to the Database
Loading class `com.mysql.jdbc.Driver'. This is deprecated. The new driver class is `com.mysql.cj.jdbc.Driver'. The driver is automatically registered via the SPI and manual loading of the driver class is generally unnecessary.
[INFO] Introspecting table t_user
[INFO] Generating Record class for table t_user
[INFO] Generating Mapper Interface for table t_user
[INFO] Generating SQL Map for table t_user
[INFO] Saving file UserDao.xml
[INFO] Saving file UserDo.java
[INFO] Saving file UserDao.java
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.423 s
[INFO] Finished at: 2019-06-24T20:42:08+08:00
[INFO] ------------------------------------------------------------------------

Process finished with exit code 0
任何形式的转载都请联系作者Jackieonway获得授权并注明出处。

生成之后产生如下文件


生成结构.png

(二)、 使用Maven命令生成

如果你的工具不是Idea,你也可以使用Maven命令生成

mvn mybatis-generator:generate

(三)、使用IDE的Maven生成

点击菜单项“run”→选择“Edit Configurations”,然后完成如下图


image.png

通过上述三种方式都能够正确生成代码,推荐使用第一种,既方便又快捷,第二种和第三种需要记住一些命令,第三种方式生成,如果IDE支持的,能够自动提示,也很方便。

小结

MyBatis Generator 插件的诞生,大大的节约了开发人员的时间,减少了大量的重复性工作,提高了开发效率,而且这还是官方提供的生成工具,官方真是为了我们提高开发效率操碎了心。

微信搜索"JackieOnWay"关注我们,第一时间获取最新技术文摘。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 225,529评论 6 524
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,683评论 3 406
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 172,905评论 0 370
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,318评论 1 303
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,325评论 6 401
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,754评论 1 316
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 42,081评论 3 431
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 41,088评论 0 280
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,653评论 1 327
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,651评论 3 347
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,766评论 1 355
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,359评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 43,083评论 3 341
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,491评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,654评论 1 278
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,367评论 3 383
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,836评论 2 367

推荐阅读更多精彩内容