mybatis根据表逆向自动化生成代码的实现

mybatis自动生成实体类、mapper文件、mapper.xml文件

若采用mybatis框架，数据库新建表，手动编写的话，需要编写大量的实体类、mapper文件、mapper.xml文件，都是一些重复且有规律的工作。

我们可以引用插件，然后做配置，自动生成这些文件，提供工作效率。

本博客包含的内容：

①自动生成插件的引入

②定义配置文件

③运行插件，生成代码

1.引入插件

在项目的pom文件中引入generator插件

<plugin>
               <groupId>org.mybatis.generator</groupId>
               <artifactId>mybatis-generator-maven-plugin</artifactId>
               <version>1.3.7</version>
               <configuration>
                   <!-- 配置文件存放路径 -->
                   <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>
                   <overwrite>true</overwrite>
                   <verbose>true</verbose>
               </configuration>
               <dependencies>
                   <!-- mysql -->
                   <dependency>
                       <groupId>mysql</groupId>
                       <artifactId>mysql-connector-java</artifactId>
                       <version>5.1.46</version>
                   </dependency>
                   <!-- mapper -->
                   <dependency>
                       <groupId>tk.mybatis</groupId>
                       <artifactId>mapper</artifactId>
                       <version>3.4.1</version>
                   </dependency>
               </dependencies>
           </plugin>

2.修改generatorConfig.xml文件

注：generatorConfig.xml 一定要放在pom中插件配置的路径下。

下面给出配置文件中的代码，代码中都有注释。主要注意的点有：

①jdbc连接 数据库的路径

②生成实体类存放的路劲

③生成mapper.xml存放的路劲

④生成mapper文件的存放路径

⑤修改表以及该表对应的实体类名称

<?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:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
   <!--    <classPathEntry location="F://jdbc//mysql-connector-java-8.0.18.jar"/>-->

<!-- 一个数据库一个context -->
   <context id="DB2Tables" targetRuntime="Mybatis3">
       <!-- 自动识别数据库关键字，默认false，如果设置为true，根据SqlReservedWords中定义的关键字列表；一般保留默认值，遇到数据库关键字（Java关键字），使用columnOverride覆盖 -->
       <property name="autoDelimitKeywords" value="true"/>
       <!-- 生成的Java文件的编码 -->
       <property name="javaFileEncoding" value="utf-8"/>
       <!-- beginningDelimiter和endingDelimiter：指明数据库的用于标记数据库对象名的符号，比如ORACLE就是双引号，MYSQL默认是`单引号； -->
       <property name="beginningDelimiter" value="`"/>
       <property name="endingDelimiter" value="`"/>
       <!-- 格式化java代码 -->
       <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
       <!-- 格式化XML代码 -->
       <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
       <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
       <plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>

<!-- 配置 tk.mybatis 插件 -->
       <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
           <property name="mappers" value="com.glsx.plat.mybatis.mapper.CommonBaseMapper"/>
       </plugin>

<!--配置生成注释信息，最多配置一个 -->
       <commentGenerator>
           <!-- 阻止生成注释包含时间戳 默认为false -->
           <property name="suppressDate" value="true"/>
           <!-- 注释是否添加数据库表的备注信息 默认为false -->
           <property name="addRemarkComments" value="true"/>
       </commentGenerator>
       <!-- jdbc连接-->
       <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"
                       connectionURL="jdbc:mysql://127.0.0.1:3307/test?serverTimeZone=Shanghai&useUnicode=true&characterEncoding=utf8&useSSL=false"
                       userId="root"
                       password="root">
           <!--防止生成其他库同名表-->
           <property name="nullCatalogMeansCurrent" value="true"/>
       </jdbcConnection>
       <!-- 类型转换 -->
       <javaTypeResolver>
           <!-- 是否使用bigDecimal， false可自动转化以下类型（Long, Integer, Short, etc.） -->
           <property name="forceBigDecimals" value="false"/>
       </javaTypeResolver>

<!-- 生成实体类地址 -->
       <javaModelGenerator targetPackage="cn.com.glsx.admin.modules.entity" targetProject="src/main/java">
           <!-- 是否让schema作为包的后缀 -->
           <property name="enableSubPackages" value="true"/>
           <!-- 从数据库返回的值去掉前后空格 -->
           <property name="trimStrings" value="true"/>
       </javaModelGenerator>

<!-- 生成mapper.xml文件存放地址 -->
       <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
           <property name="enableSubPackages" value="true"/>
       </sqlMapGenerator>

<!-- 生成接口dao  type="ANNOTATEDMAPPER",生成Java Model 和基于注解的Mapper对象 type="MIXEDMAPPER",生成基于注解的Java Model 和相应的Mapper对象 type="XMLMAPPER",生成SQLMap XML文件和独立的Mapper接口 -->
       <javaClientGenerator targetPackage="cn.com.glsx.admin.modules.mapper" targetProject="src/main/java" type="XMLMAPPER">
           <property name="enableSubPackages" value="false"/>
       </javaClientGenerator>

<!-- table可以有多个,每个数据库中的表都可以写一个table，tableName表示要匹配的数据库表,也可以在tableName属性中通过使用％通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 enableSelectByPrimaryKey相应的配置表示是否生成相应的接口 -->
       <table tableName="d_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false"
              enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
<table tableName="d_student" domainObjectName="Student" enableCountByExample="false" enableUpdateByExample="false"
              enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"/>
   </context>
</generatorConfiguration>

3.运行插件，生成代码

双击插件，运行后，在控制台中能看到BUILD SUCCESS，说明运行成功。

若在项目中没有，鼠标右击项目，则重新刷新整个项目或者重新加载项目，就可以在配置的路径下看到生成的文件。

来源：https://www.cnblogs.com/sun-flower1314/p/15107270.html