SpringBoot使用mybatis generator自动生成代码

mybatis要写许多xml文件，sql语句，dao接口，但大部分都是通用的增删改查操作。繁琐的编写让人头痛，单从这一点来说jpa更方便。

为了解决这个问题，mybatis generator插件应运而生，能够通过数据库表自动生成三个文件：

Dao接口
表对应的实体类
mapper.xml文件

具体流程如下：
1、创建数据库表
2、修改pom.xml
3、添加generatorConfig.xml
4、执行编译
5、效果
6、参考

项目目录结构如下

image.png

1、创建数据库表

先创建一个表用来测试

CREATE TABLE `t_info` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `telephone` varchar(255) DEFAULT '' COMMENT '手机号',
  `user_address` varchar(255) DEFAULT '' COMMENT '地址',
  PRIMARY KEY (`id`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8;

注意：

建表时，字段名称建议用"_"分隔多个单词，比如:AWB_NO、REC_ID...，这样生成的entity，属性名称就会变成漂亮的驼峰命名，即：awbNo、recId

oracle中，数值形的字段，如果指定精度，比如Number(12,2)，默认生成entity属性是BigDecimal型，如果不指定精度，比如:Number(9)，指默认生成的是Long型

oracle中的nvarchar/nvarchar2，mybatis-generator会识别成Object型，建议不要用nvarchar2，改用varchar2

2、修改pom.xml

1)添加依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
         
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.0.0</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.1.9</version>
        </dependency>
        
        <dependency>
           <groupId>org.mybatis.generator</groupId>
           <artifactId>mybatis-generator-core</artifactId>
           <version>1.3.5</version>
       </dependency>
       
    </dependencies>

2)添加插件

<plugin>
               <groupId>org.mybatis.generator</groupId>
               <artifactId>mybatis-generator-maven-plugin</artifactId>
               <configuration>
                   <configurationFile>src/main/resources/generator/generatorConfig.xml</configurationFile>
                   <overwrite>true</overwrite>
                   <verbose>true</verbose>
               </configuration>
           </plugin>

3、添加generatorConfig.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>
   <!-- 数据库驱动:换成你本地的驱动包位置-->
   <classPathEntry  location="C:\Users\Administrator\.m2\repository\mysql\mysql-connector-java\5.1.47\mysql-connector-java-5.1.47.jar"/>
   <context id="DB2Tables"  targetRuntime="MyBatis3">
       <commentGenerator>
           <property name="suppressDate" value="true"/>
           <!-- 是否去除自动生成的注释 true：是 ： false:否 -->
           <property name="suppressAllComments" value="true"/>
       </commentGenerator>
       <!--数据库链接URL，用户名、密码 -->
       <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/mybatis_test?characterEncoding=utf8" userId="root" password="root">
       </jdbcConnection>
       <javaTypeResolver>
           <property name="forceBigDecimals" value="false"/>
       </javaTypeResolver>
       <!-- 生成模型的包名和位置-->
       <javaModelGenerator targetPackage="com.shufeng.hellomybatis.entity" targetProject="src/main/java">
           <property name="enableSubPackages" value="true"/>
           <property name="trimStrings" value="true"/>
       </javaModelGenerator>
       <!-- 生成映射文件的包名和位置-->
       <sqlMapGenerator targetPackage="resources.mapper" targetProject="src/main">
           <property name="enableSubPackages" value="true"/>
       </sqlMapGenerator>
       <!-- 生成DAO的包名和位置-->
       <javaClientGenerator type="XMLMAPPER" targetPackage="com.shufeng.hellomybatis.dao" targetProject="src/main/java">
           <property name="enableSubPackages" value="true"/>
       </javaClientGenerator>
       <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名-->
       <table tableName="user_t" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table>
   </context>
</generatorConfiguration>

4、执行编译

右击工程 -> Run As -> Maven build -> 添加命令 mybatis-generator:generate -> Run

image.png

5、效果

生成的文件如下

image.png

6、参考

springboot整合mybatis并使用Generator自动生成代码
 SpringBoot——使用mybatis generator自动生成代码
 mybatis-generator自动生成代码插件使用详解
 利用mybatis-generator自动生成代码