Mybatis插件generator使用

本文介绍一种实用的Mybatis插件generator，可以方便帮助我们生成需要的实体类，dao层和对应mapper层映射文件。该插件有三种用法：命令行、eclipse插件、maven插件。推荐maven插件最方便。

1、配置

1.1dependency配置

<dependency>
   <groupId>org.mybatis.spring.boot</groupId>
   <artifactId>mybatis-spring-boot-starter</artifactId>
   <version>1.3.2</version>
</dependency>

1.2plugin配置

 

<!-- mybatis generator 自动生成代码插件 -->
<plugin>
    <groupId>org.mybatis.generator</groupId>
    <artifactId>mybatis-generator-maven-plugin</artifactId>
    <configuration>
        <configurationFile>${basedir}/src/main/resources/generatorConfig.xml</configurationFile>
        <overwrite>true</overwrite>
        <verbose>true</verbose>
    </configuration>
</plugin>

---

2、generatorConfig.xml

2.1创建

<?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>
    <properties resource="generatorConfig.properties"></properties>
 
    <classPathEntry location="${jdbc.driverLocation}"></classPathEntry>
 
    <context id="default" targetRuntime="MyBatis3">
 
        <commentGenerator>
            <property name="suppressDate" value="true"></property>
            <property name="suppressAllComments" value="true"></property>
        </commentGenerator>
 
        <jdbcConnection
                driverClass="${jdbc.driverClass}"
                connectionURL="${jdbc.connectionURL}"
                userId="${jdbc.userId}"
                password="${jdbc.password}">
        </jdbcConnection>
 
        <javaTypeResolver>
            <property name="forceBigDecimals" value="false"></property>
        </javaTypeResolver>
 
        <javaModelGenerator targetPackage="mybatis.auto.bean" targetProject="src/main/java">
            <property name="enableSubPackages" value="false"></property>
            <property name="constructorBased" value="true"></property>
            <property name="trimStrings" value="true"></property>
            <property name="immutable" value="false"></property>
        </javaModelGenerator>
 
        <sqlMapGenerator targetPackage="mybatis.auto.mapper" targetProject="src/main/resources">
            <property name="enableSubPackages" value="false"></property>
        </sqlMapGenerator>
 
        <javaClientGenerator targetPackage="mybatis.auto.dao" targetProject="src/main/java" type="ANNOTATEDMAPPER">
            <property name="enableSubPackages" value="true"></property>
        </javaClientGenerator>


        <!--我的数据库-->
        <table tableName="bookshelf" domainObjectName="MyBookShelf"

               enableSelectByPrimaryKey="true" enableSelectByExample="false"
               enableUpdateByPrimaryKey="true" enableDeleteByPrimaryKey="true"
               enableDeleteByExample="false" enableCountByExample="false"
               enableUpdateByExample="false" modelType="flat"
               selectByExampleQueryId="false">
            <generatedKey column="id" sqlStatement="MySql"
                          identity="true"></generatedKey>
        </table>

    </context>
</generatorConfiguration>

2.2配置generatorConfig.properties

jdbc.driverLocation=D:/maven/maven_repository/mysql/mysql-connector-java/5.1.46/mysql-connector-java-5.1.46.jar//本地Maven仓库地址

jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.connectionURL=jdbc:mysql://xxxxx/test?useUnicode=true&characterEncoding=utf8&useSSL=false//自己数据库地址
jdbc.userId=root//数据库用户名
jdbc.password=root//数据库密码

2、文件位置

上述generatorConfig.xml，generatorConfig.properties两个配置文件放在项目根目录resources下。

---

至此，关于Mybatis的generator插件设置完毕。

---

3、与开发工具配合使用

开发工具由自己根据喜好选择，本文以IDEA为例做介绍。

第一步：编辑配置项

第二步：点击+选择Maven

第三步：自己起一个name例如：Generator  ，Command line 输入：mybatis-generator:generate -e

第四步：点击右边maven，出现自己的配置的文件

第四步：双击Generator，就会在自己设置的包中生成实体类，dao以及对应的Mapper映射文件。

---

4、总结

本文主要介绍Mybatis的generator插件的配置以及使用。并且以Idea开发工具为例详细说明了使用方法。