浅谈springboot中tk.mapper代码生成器的用法说明

问:什么是tk.mapper?

答:这是一个通用的mapper框架,相当于把mybatis的常用数据库操作方法封装了一下,它实现了jpa的规范,简单的查询更新和插入操作都可以直接使用其自带的方法,无需写额外的代码。

而且它还有根据实体的不为空的字段插入和更新的方法,这个是非常好用的哈。

而且它的集成非常简单和方便,下面我来演示下使用它怎么自动生成代码。

pom中引入依赖,这里引入tk.mybatis.mapper的版本依赖是因为在mapper-spring-boot-starter的新版本中没有MapperPlugin这个类,无法提供代码生成的功能,在老版本中有:

<!--通用mapper-->
<dependency>
 <groupId>tk.mybatis</groupId>
 <artifactId>mapper-spring-boot-starter</artifactId>
 <version>2.1.5</version>
</dependency>
<!--代码生成使用-->
<dependency>
 <groupId>tk.mybatis</groupId>
 <artifactId>mapper</artifactId>
 <version>3.4.2</version>
</dependency>

配置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>
 <!--执行generator插件生成文件的命令: call mvn mybatis-generator:generate -e -->
 <!-- 引入配置文件 -->
 <properties resource="generator.properties"/>
 <!--classPathEntry:数据库的JDBC驱动,换成你自己的驱动位置 可选 -->
 <classPathEntry
   location="D:\iflytek\maven\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar"/>

 <!-- 一个数据库一个context -->
 <!--defaultModelType="flat" 大数据字段,不分表 -->
 <context id="MysqlTables" targetRuntime="MyBatis3Simple" defaultModelType="flat">
  <!-- 自动识别数据库关键字,默认false,如果设置为true,根据SqlReservedWords中定义的关键字列表;
  一般保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 -->
  <property name="autoDelimitKeywords" value="http://www.cppcns.com/ruanjian/java/true"/>
  <!-- 生成的Java文件的编码 -->
  <property name="javaFileEncoding" value="http://www.cppcns.com/ruanjian/java/utf-8"/>
  <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,比如ORACLE就是双引号,MYSQL默认是`反引号; -->
  <property name="beginningDelimiter" value="http://www.cppcns.com/ruanjian/java/`"/>
  <property name="endingDelimiter" value="http://www.cppcns.com/ruanjian/java/`"/>

  <!-- 格式化java代码 -->
  <property name="javaFormatter" value="http://www.cppcns.com/ruanjian/java/org.mybatis.generator.api.dom.DefaultJavaFormatter"/>
  <!-- 格式化XML代码 -->
  <property name="xmlFormatter" value="http://www.cppcns.com/ruanjian/java/org.mybatis.generator.api.dom.DefaultXmlFormatter"/>
  <plugin type="org.mybatis.generator.plugins.SerializablePlugin"/>
  <!--覆盖xml文件-->
  <plugin type="com.xqnode.boot.util.OverwriteXmlPlugin"/>
  <!--toString-->
  <!--<plugin type="org.mybatis.generator.plugins.ToStringPlugin"/>-->
  <plugin type="tk.mybatis.mapper.generator.MapperPlugin">
   <property name="mappers" value="http://www.cppcns.com/ruanjian/java/tk.mybatis.mapper.common.Mapper"/>
  </plugin>

  <!-- 注释 type="com.xqnode.boot.util.CommentGenerator" -->
  <commentGenerator>
   <property name="suppressAllComments" value="http://www.cppcns.com/ruanjian/java/true"/><!-- 是否取消注释 -->
   <property name="suppressDate" value="http://www.cppcns.com/ruanjian/java/true"/> <!-- 是否生成注释代时间戳-->
  </commentGenerator>

  <!-- jdbc连接 &amp;表示 & -->
  <jdbcConnection driverClass="${jdbc.driverClass}"
      connectionURL="${jdbc.connectionURL}"
      userId="${jdbc.userId}"
      password="${jdbc.password}"/>
  <!-- 类型转换 -->
  <javaTypeResolver>
   <!-- 是否使用bigDecimal, false可自动转化以下类型(Long, Integer, Short, etc.) -->
   <property name="forceBigDecimals" value="http://www.cppcns.com/ruanjian/java/false"/>
  </javaTypeResolver>

  <!-- 生成实体类地址 -->
  <javaModelGenerator targetPackage="com.xqnode.boot.model" targetProject="src/main/java">
   <property name="enableSubPackages" value="http://www.cppcns.com/ruanjian/java/false"/>
   <property name="trimStrings" value="http://www.cppcns.com/ruanjian/java/true"/>
  </javaModelGenerator>
  <!-- 生成mapxml文件 -->
  <sqlMapGenerator targetPackage="mapper" targetProject="src/main/resources">
   <property name="enableSubPackages" value="http://www.cppcns.com/ruanjian/java/false"/>
  </sqlMapGenerator>
  <!-- 生成mapxml对应client,也就是接口dao -->
  <javaClientGenerator targetPackage="com.xqnode.boot.dao" targetProject="src/main/java"
        type="XMLMAPPER">
   <property name="enableSubPackages" value="http://www.cppcns.com/ruanjian/java/false"/>
  </javaClientGenerator>
  <!-- table可以有多个,每个数据库中的表都可以写一个table,tableName表示要匹配的数据库表,也可以在tableName属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
  <!-- tableName=% 则匹配数据库的所有表,注意将domainObjectName和mapperName置为空-->
  <!-- enableCountByExample等设置生成简单的crud操作方法-->
  <table tableName="${table.name}" domainObjectName="${domain.object.name}" mapperName="${mapper.name}">
   <property name="useActualColumnNames" value="http://www.cppcns.com/ruanjian/java/false"/>
   <!-- 数据库表主键 -->
   <generatedKey column="id" sqlStatement="Mysql" identity="true"/>
  </table>
 </context>
</generatorConfiguration>

浅谈springboot中tk.mapper代码生成器的用法说明

扫一扫手机访问